Skip to content

Commit a7f016e

Browse files
docs: Update install_enterprise_k8s.md with redis username and password (#7593)
Co-authored-by: caitlinwheeless <caitlin@humansignal.com>
1 parent b0e916f commit a7f016e

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

docs/source/guide/install_enterprise_k8s.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Adjust the included defaults to reflect your environment and copy these into a n
259259

260260
</div>
261261

262-
## Optional: set up TLS for PostgreSQL
262+
## Optional: Set up TLS for PostgreSQL
263263
To configure Label Studio Enterprise to use TLS for end-client connections with PostgreSQL, do the following:
264264

265265
1. Enable TLS for your PostgreSQL instance and save Root TLS certificate, client certificate and its key for the next steps.
@@ -286,7 +286,7 @@ global:
286286

287287
4. Install or upgrade Label Studio Enterprise using Helm.
288288

289-
## Optional: set up TLS for Redis
289+
## Optional: Set up TLS for Redis
290290
To configure Label Studio Enterprise to use TLS for end-client connections with Redis, do the following:
291291

292292
1. Enable TLS for your Redis instance and save Root TLS certificate, client certificate and its key for the next steps.
@@ -313,6 +313,51 @@ global:
313313

314314
4. Install or upgrade Label Studio Enterprise using Helm.
315315

316+
317+
## Optional: Set up username and password for Redis
318+
319+
Use one of these options to set a password and a username for Redis:
320+
321+
**1. Password via Kubernetes Secret**. Use this when:
322+
* You want to avoid embedding credentials in `values.yaml`
323+
* You already manage Secrets in your cluster
324+
* You need a simple auth without multiple Redis users and you don't have username
325+
326+
```yaml
327+
global:
328+
redisConfig:
329+
host: "redis://redis.example.com:6379/1"
330+
password:
331+
secretName: "my-redis-secret" # Kubernetes Secret name
332+
secretKey: "redis-password" # Key inside Secret
333+
```
334+
335+
**2. Username + password in URL**. Use this when:
336+
* Redis v.7 or later, and with ACL-enabled users
337+
* You need a dedicated Redis user for permission scoping
338+
* You need a quick, throwaway setup or local testing
339+
340+
```yaml
341+
global:
342+
redisConfig:
343+
host: "redis://myuser:mypassword@redis.example.com:6379/1"
344+
```
345+
346+
**3. Username in environment variables + password in secret**. Use this when:
347+
* Redis v.7 or later, and with ACL-enabled users
348+
* You want to keep the password secret but still specify a username
349+
350+
```yaml
351+
global:
352+
redisConfig:
353+
host: "redis://redis.example.com:6379/1"
354+
password:
355+
secretName: "my-redis-secret" # Kubernetes Secret name
356+
secretKey: "redis-password" # Key inside Secret
357+
extraEnvironmentVars:
358+
REDIS_USERNAME: "myuser" # Injected into pod env
359+
```
360+
316361
## Use Helm to install Label Studio Enterprise on your Kubernetes cluster
317362

318363
Use Helm to install Label Studio Enterprise on your Kubernetes cluster. Provide your custom resource definitions YAML file. Specify any environment variables that you need to set for your Label Studio Enterprise installation using the `--set` argument with the `helm install` command.

0 commit comments

Comments
 (0)