> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Redis

> Redis cache via the community groundhog2k Helm chart (official docker.io/redis image)

Qovery creates it as a Helm release on the environment's own cluster, as a [Blueprint](https://www.qovery.com/docs/configuration/blueprints.md) service in one of your environments.

| | |
| - | - |
| Catalog name | `helm-redis` |
| Category | Databases & Caches |
| Provider | HELM |
| Engine | helm |
| Major versions (latest release) | `8` (1.0.3) |
| Source | [HELM/redis/8](https://github.com/Qovery/service-catalog/tree/HELM/redis/8/1.0.3/HELM/redis/8) |

> [!TIP]
>
> **New to this?** You don't need to know Kubernetes or Helm. Qovery installs Redis on your cluster with Helm and runs it for you: you fill in a form, or paste the prompt below into your coding agent. The values it publishes, listed under Outputs, reach your other services as environment variables. Qovery tells you when a newer version of the Blueprint is available. Check the requirements in the Reference section before you start, and try it first in a development environment.

## Create it

> [tab] Console
>
> 1. Open the environment, then **New service** › **Blueprint**.
> 2. Find **Redis** in the catalog and pick the major version.
> 3. Fill in the variables. Required ones are marked; the others use their defaults.
> 4. Create the service, and deploy it now or later.

> [tab] CLI and API
>
> List the catalog to get the latest tag, then create the service from it. `qovery api` signs the requests with your CLI session.
>
> ```bash theme={null}
> ORG_ID="REPLACE_WITH_ORGANIZATION_ID"
> ENV_ID="REPLACE_WITH_ENVIRONMENT_ID"
>
> qovery api "organization/$ORG_ID/blueprint/catalog" | jq '.. | objects | select(.name? == "helm-redis")'
>
> cat > blueprint.json <<'EOF'
> {
>   "name": "helm-redis",
>   "tag": "HELM/redis/8/1.0.3",
>   "icon": "app://qovery-console/redis",
>   "variables": [
>     {
>       "name": "password",
>       "value": "REPLACE_WITH_PASSWORD",
>       "is_secret": true
>     }
>   ]
> }
> EOF
> BLUEPRINT_ID=$(qovery api "environment/$ENV_ID/blueprint" --method POST --input - < blueprint.json | jq -r .id)
> rm blueprint.json   # it can hold secret values
> qovery api "blueprint/$BLUEPRINT_ID/deploy" --method POST
> qovery api "blueprint/$BLUEPRINT_ID"   # status of the latest deployment
> ```
>
> Replace each `REPLACE_WITH_` value. Add optional variables to `variables` the same way.

> [tab] Coding agent
>
> Paste this into Claude Code, Cursor, Codex or another coding agent with the [Qovery agent skills](https://www.qovery.com/docs/getting-started/quickstart/agent-skills.md) installed (`curl -fsSL https://skill.qovery.com/install.sh | bash`).
>
> ```text Prompt wrap theme={null}
> Add the Qovery Blueprint Redis (helm-redis) to one of my Qovery environments and deploy it. Ask me for password.
> Ask me before deploying to a production environment.
> Docs: https://www.qovery.com/docs/configuration/blueprints/helm-redis.md
> ```

You don't add any file to your repository. Qovery creates the Blueprint from the Console or the API.

## Variables and outputs

Generated from `qbm.yml` at `HELM/redis/8/1.0.3`, the manifest the Console form is built from.

> [accordion] All 2 variables
>
> | Name | Type | Required | Default | Secret | Description |
> | - | - | - | - | - | - |
> | `memory_limit` | string | | `512Mi` | | Kubernetes quantity, e.g. 512Mi or 1Gi |
> | `password` | string | Yes | | Yes | 10–128 chars. |

Outputs become environment variables that other services in the environment can use. By default Qovery also creates an alias for each output, prefixed with the Blueprint's name; see [Aliases Qovery creates for outputs](https://www.qovery.com/docs/configuration/environment-variables.md#aliases-qovery-creates-for-outputs) for the naming rules and the cases where no alias is created.

> [accordion] All 2 outputs
>
> | Name | Secret | Description |
> | - | - | - |
> | `redis_host` | | Redis service hostname |
> | `redis_port` | | Redis service port |

## Reference

From the Blueprint's [README](https://github.com/Qovery/service-catalog/blob/HELM/redis/8/1.0.3/HELM/redis/8/README.md).

Deploys Redis cache via the community [groundhog2k](https://github.com/groundhog2k/helm-charts) Helm chart, which wraps the official `docker.io/redis` image (Redis 8). Standalone, single instance. Data is not persisted — pod restarts clear all keys.

> **Security note:** the official Redis image has no password env var, so `requirepass` is set via `redis.conf`, which the chart renders into a **ConfigMap in plaintext** (not a Secret). Fine for a non-persistent dev cache; do not store sensitive data.

### Variables

| Name | Type | Required | Sensitive | Default | Description |
| - | - | - | - | - | - |
| `memory_limit` | string | no | | `512Mi` | Memory limit for Redis pods. Must be a valid Kubernetes quantity (e.g. `512Mi`, `1Gi`). |
| `password` | string | yes | yes | — | Redis authentication password (min 10 chars recommended). |

### Outputs

| Name | Description |
| - | - |
| `redis_host` | Redis service hostname |
| `redis_port` | Redis service port |


## Related topics

- [Google Cloud Memorystore for Redis](https://www.qovery.com/docs/configuration/blueprints/gcp-memorystore-redis.md)
- [Amazon ElastiCache for Redis](https://www.qovery.com/docs/configuration/blueprints/aws-elasticache-redis.md)
- [Amazon ElastiCache for Redis (legacy single node)](https://www.qovery.com/docs/configuration/blueprints/aws-elasticache-redis-node.md)
- [Application](https://www.qovery.com/docs/configuration/application.md)
- [Cluster Advanced Settings](https://www.qovery.com/docs/configuration/cluster-advanced-settings.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.