diff --git a/docs/persistence/redis/how-to/create-application.md b/docs/persistence/redis/how-to/create-application.md index 79e44bb53..745e6d1ea 100644 --- a/docs/persistence/redis/how-to/create-application.md +++ b/docs/persistence/redis/how-to/create-application.md @@ -32,6 +32,22 @@ a read-only user for the `lookup` instance. See the [manifest reference][app-spec-redis] for other options for `access`. +The default Redis created by NAIS looks like this: + +```yaml +apiVersion: aiven.io/v1alpha1 +kind: Redis +metadata: + labels: + app: redis-tester + team: myteam + name: redis-myteam-sessions + namespace: myteam +spec: + plan: startup-4 + project: nav-dev +``` + If all you need is a Redis instance for one application using just the default settings, this is all you need. If you want to share a Redis instance across applications, or want to change configuration away diff --git a/docs/persistence/redis/how-to/create-explicit.md b/docs/persistence/redis/how-to/create-explicit.md index 589114e14..e3db8c821 100644 --- a/docs/persistence/redis/how-to/create-explicit.md +++ b/docs/persistence/redis/how-to/create-explicit.md @@ -4,6 +4,9 @@ tags: [redis, how-to] # Create a Redis instance explicitly +## Prerequisites +- [Member of a NAIS team](../../../explanations/team.md) + We recommend creating your Redis instances in their own workflow for more control over configuration, especially if you intend for multiple applications using the same Redis instance, or if you need to change configuration. Creating a Redis instance is done by adding a Redis resource to your namespace with detailed configuration. diff --git a/docs/persistence/redis/reference/README.md b/docs/persistence/redis/reference/README.md index 2a41d776a..0cc437413 100644 --- a/docs/persistence/redis/reference/README.md +++ b/docs/persistence/redis/reference/README.md @@ -16,6 +16,8 @@ spec: access: readwrite | read | write | admin ``` +## Environment variables + Every `` will give three environment variables for the applications to use: | Key | Value | @@ -25,3 +27,9 @@ Every `` will give three environment variables for the applic | `REDIS_PORT_` | The port for the Redis instance.
Example: `26483` | | `REDIS_USERNAME_` | The username to use when connecting. | | `REDIS_PASSWORD_` | The password to use when connecting. | + +## Advanced configuration + +For advanced configuration, we recommend [creating your Redis instances explicitly](../how-to/create-explicit.md), especially if you intend for multiple applications using the same Redis instance. + +We use Aivens operator, so the Redis resource is [documented in detail](https://aiven.github.io/aiven-operator/api-reference/redis.html) in the Aiven documentation.