Merge pull request #6 from triton-inference-server/config-tweaks

- Support credentials from env vars, increase default wait_timeout to 1sec / 1000ms
triton-inference-server · Jun 21, 2023 · f4c0303 · f4c0303
2 parents 751311c + 3ac04a8
commit f4c0303
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -93,17 +93,21 @@ tritonserver --cache-config redis,host=redis-host --cache-config redis,port=6379
 
 | Configuration Option | Required | Description                                                                                                                                 | Default |
 |----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|---------|
-| host | Yes | The hostname or IP address of the server where Redis is running.                                                                            | N/A |
-| port | Yes | The port number to connect to on the server.                                                                                                | N/A |
+| host | Yes | The hostname or IP address of the server where Redis is running.                                                                            | N/A     |
+| port | Yes | The port number to connect to on the server.                                                                                                | N/A     |
 | user | No | The username to use for authentication of the ACLs to the Redis Server                                                                      | default |
-| password | No | The password to Redis.                                                                                                                      | N/A |
-| db | No | The db number to user. NOTE - use of the db number is considered an anti-pattern in Redis, so it is advised that you do not use this option | 0 |
-| connect_timeout | No | The maximum time, in milliseconds to wait for a connection to be established to Redis. 0 means wait forever                                 | 0 |
-| socket_timeout | No | The maximum time, in milliseconds the client will wait for a response from Redis. 0 means wait forever                                      | 0 |
-| pool_size | No | The number pooled connections to Redis the client will maintain.                                                                            | 1 |
-| wait_timeout | No | The maximum time, in milliseconds to wait for a connection from the pool.                                                                   | 100 |
+| password | No | The password to Redis.                                                                                                                      | N/A     |
+| db | No | The db number to user. NOTE - use of the db number is considered an anti-pattern in Redis, so it is advised that you do not use this option | 0       |
+| connect_timeout | No | The maximum time, in milliseconds to wait for a connection to be established to Redis. 0 means wait forever                                 | 0       |
+| socket_timeout | No | The maximum time, in milliseconds the client will wait for a response from Redis. 0 means wait forever                                      | 0       |
+| pool_size | No | The number pooled connections to Redis the client will maintain.                                                                            | 1       |
+| wait_timeout | No | The maximum time, in milliseconds to wait for a connection from the pool.                                                                   | 1000    |
 
 
+### Optional Environment Variables for Credentials
+
+Optionally you may configure your `user`/`password` via environment variables. The corresponding `user` environment variable is `TRITONCACHE_REDIS_USERNAME` whereas the corresponding `password` environment variable is `TRITONCACHE_REDIS_PASSWORD`.
+
 ## Monitoring and Observability
 
 There are many ways to go about monitoring what's going on in Redis. One popular mode is to export metrics data from Redis to Prometheus, and use Grafana to observe them.

diff --git a/src/redis_cache.cc b/src/redis_cache.cc
@@ -89,6 +89,15 @@ setOption(
   }
 }
 
+void
+setOptionFromEnv(const char* envVarName, std::string& option)
+{
+  const char* envVarValue = std::getenv(envVarName);
+  if (envVarValue != nullptr) {
+    option = envVarValue;
+  }
+}
+
 TRITONSERVER_Error*
 handleError(
     const std::string& message, const std::string& key,
@@ -118,6 +127,11 @@ RedisCache::Create(
   sw::redis::ConnectionOptions options;
   sw::redis::ConnectionPoolOptions poolOptions;
 
+  // try pulling user/password from environment fist
+  // override if present in the config
+  setOptionFromEnv(USERNAME_ENV_VAR_NAME, options.user);
+  setOptionFromEnv(PASSWORD_ENV_VAR_NAME, options.password);
+
   setOption("host", options.host, document);
   setOption("port", options.port, document);
   setOption("user", options.user, document);
@@ -128,7 +142,7 @@ RedisCache::Create(
   setOption("pool_size", poolOptions.size, document);
   setOption("wait_timeout", poolOptions.wait_timeout, document);
   if (!document.HasMember("wait_timeout")) {
-    poolOptions.wait_timeout = std::chrono::milliseconds(100);
+    poolOptions.wait_timeout = std::chrono::milliseconds(1000);
   }
 
   try {

diff --git a/src/redis_cache.h b/src/redis_cache.h
@@ -48,6 +48,10 @@ struct CacheEntry {
 // the buffer back to Triton
 constexpr uint32_t FIELDS_PER_BUFFER = 4;
 
+constexpr const char* PASSWORD_ENV_VAR_NAME = "TRITONCACHE_REDIS_PASSWORD";
+constexpr const char* USERNAME_ENV_VAR_NAME = "TRITONCACHE_REDIS_USERNAME";
+
+
 #define RETURN_IF_ERROR(X)        \
   do {                            \
     TRITONSERVER_Error* err__(X); \