public_git/bitnami-containers
1
0
Fork 0
mirror of https://github.com/bitnami/containers.git synced 2026-10-22 10:23:08 +02:00
Code Issues Projects Releases Wiki Activity

[bitnami/valkey] Release 9.0.3-debian-12-r0 (#91055)

Browse Source 
Signed-off-by: Bitnami Bot <bitnami.bot@broadcom.com>
This commit is contained in:
Bitnami Bot
2026-02-24 06:13:32 +01:00
committed by GitHub
parent dd73349c0c
commit 6b90a9f084
2 changed files with 10 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bitnami/valkey/9.0/debian-12/Dockerfile
+5 -5
View File
@@ -7,13 +7,13 @@ ARG DOWNLOADS_URL="downloads.bitnami.com/files/stacksmith"
ARG TARGETARCH
LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \
org.opencontainers.image.created="2026-02-19T05:08:46Z" \
org.opencontainers.image.created="2026-02-24T05:04:49Z" \
org.opencontainers.image.description="Application packaged by Broadcom, Inc." \
org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/valkey/README.md" \
org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/valkey" \
org.opencontainers.image.title="valkey" \
org.opencontainers.image.vendor="Broadcom, Inc." \
org.opencontainers.image.version="9.0.2"
org.opencontainers.image.version="9.0.3"
ENV HOME="/" \
OS_ARCH="${TARGETARCH:-amd64}" \
@@ -29,7 +29,7 @@ RUN --mount=type=secret,id=downloads_url,env=SECRET_DOWNLOADS_URL \
mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \
COMPONENTS=( \
"wait-for-port-1.0.10-7-linux-${OS_ARCH}-debian-12" \
"valkey-9.0.2-0-linux-${OS_ARCH}-debian-12" \
"valkey-9.0.3-0-linux-${OS_ARCH}-debian-12" \
) ; \
for COMPONENT in "${COMPONENTS[@]}"; do \
if [ ! -f "${COMPONENT}.tar.gz" ]; then \
@@ -50,9 +50,9 @@ RUN uninstall_packages curl
COPY rootfs /
RUN /opt/bitnami/scripts/valkey/postunpack.sh
ENV APP_VERSION="9.0.2" \
ENV APP_VERSION="9.0.3" \
BITNAMI_APP_NAME="valkey" \
IMAGE_REVISION="1" \
IMAGE_REVISION="0" \
PATH="/opt/bitnami/common/bin:/opt/bitnami/valkey/bin:$PATH"
EXPOSE 6379
bitnami/valkey/README.md
+5 -380
View File
@@ -66,6 +66,10 @@ cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Using `docker-compose.yaml`
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated [Bitnami Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/valkey).
## Persisting your database
Valkey provides a different range of [persistence options](https://valkey.io/docs/topics/persistence.html). This contanier uses *AOF persistence by default* but it is easy to overwrite that configuration in a `docker-compose.yaml` file with this entry `command: /opt/bitnami/scripts/valkey/run.sh --appendonly no`. Alternatively, you may use the `VALKEY_AOF_ENABLED` env variable as explained in [Disabling AOF persistence](https://github.com/bitnami/containers/blob/main/bitnami/valkey#disabling-aof-persistence).
@@ -74,24 +78,6 @@ If you remove the container all your data will be lost, and the next time you ru
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
docker run \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/valkey-persistence:/bitnami/valkey/data \
bitnami/valkey:latest
```
You can also do this by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
volumes:
- /path/to/valkey-persistence:/bitnami/valkey/data
...
```
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
## Connecting to other containers
@@ -100,72 +86,6 @@ Using [Docker container networking](https://docs.docker.com/engine/userguide/net
Containers attached to the same network can communicate with each other using the container name as the hostname.
### Using the Command Line
In this example, we will create a Valkey client instance that will connect to the server instance that is running on the same docker network as the client.
#### Step 1: Create a network
```console
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Valkey server instance
Use the `--network app-tier` argument to the `docker run` command to attach the Valkey container to the `app-tier` network.
```console
docker run -d --name valkey-server \
-e ALLOW_EMPTY_PASSWORD=yes \
--network app-tier \
bitnami/valkey:latest
```
#### Step 3: Launch your Valkey client instance
Finally we create a new container instance to launch the Valkey client and connect to the server created in the previous step:
```console
docker run -it --rm \
--network app-tier \
bitnami/valkey:latest valkey-cli -h valkey-server
```
### Using a Docker Compose file
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `app-tier`. In this example we assume that you want to connect to the Valkey server from your own custom application image which is identified in the following snippet by the service name `myapp`.
```yaml
version: '2'
networks:
app-tier:
driver: bridge
services:
valkey:
image: bitnami/valkey:latest
environment:
- ALLOW_EMPTY_PASSWORD=yes
networks:
- app-tier
myapp:
image: YOUR_APPLICATION_IMAGE
networks:
- app-tier
```
> **IMPORTANT**:
>
> 1. Please update the **YOUR_APPLICATION_IMAGE_** placeholder in the above snippet with your application image
> 2. In your application container, use the hostname `valkey` to connect to the Valkey server
Launch the containers using:
```console
docker-compose up -d
```
## Configuration
### Environment variables
@@ -233,33 +153,6 @@ For security reasons, you may want to disable some commands. You can specify the
- `VALKEY_DISABLE_COMMANDS`: Comma-separated list of Valkey commands to disable. Defaults to empty.
```console
docker run --name valkey -e VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG bitnami/valkey:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
environment:
- VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG
...
```
As specified in the docker-compose, `FLUSHDB` and `FLUSHALL` commands are disabled. Comment out or remove the
environment variable if you don't want to disable any commands:
```yaml
services:
valkey:
...
environment:
# - VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL
...
```
### Passing extra command-line flags to valkey-server startup
Passing extra command-line flags to the valkey service command is possible by adding them as arguments to *run.sh* script:
@@ -284,21 +177,6 @@ services:
Passing the `VALKEY_PASSWORD` environment variable when running the image for the first time will set the Valkey server password to the value of `VALKEY_PASSWORD` (or the content of the file specified in `VALKEY_PASSWORD_FILE`).
```console
docker run --name valkey -e VALKEY_PASSWORD=password123 bitnami/valkey:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
environment:
- VALKEY_PASSWORD=password123
...
```
**NOTE**: The at sign (`@`) is not supported for `VALKEY_PASSWORD`.
**Warning** The Valkey database is always configured with remote access enabled. It's suggested that the `VALKEY_PASSWORD` env variable is always specified to set a password. In case you want to access the database without a password set the environment variable `ALLOW_EMPTY_PASSWORD=yes`. **This is recommended only for development**.
@@ -307,40 +185,10 @@ services:
By default the Valkey image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `ALLOW_EMPTY_PASSWORD=yes` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `VALKEY_PASSWORD` for any other scenario.
```console
docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes bitnami/valkey:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
...
```
### Disabling AOF persistence
Valkey offers different [options](https://valkey.io/docs/topics/persistence.html) when it comes to persistence. By default, this image is set up to use the AOF (Append Only File) approach. Should you need to change this behaviour, setting the `VALKEY_AOF_ENABLED=no` env variable will disable this feature.
```console
docker run --name valkey -e VALKEY_AOF_ENABLED=no bitnami/valkey:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
environment:
- VALKEY_AOF_ENABLED=no
...
```
### Enabling Access Control List
Valkey offers [ACL](https://valkey.io/docs/topics/acl.html) which allows certain connections to be limited in terms of the commands that can be executed and the keys that can be accessed. We strongly recommend enabling ACL in production by specifiying the `VALKEY_ACLFILE`.
@@ -366,24 +214,6 @@ services:
By default, this image is set up to launch Valkey in standalone mode on port 6379. Should you need to change this behavior, setting the `VALKEY_PORT_NUMBER` environment variable will modify the port number. This is not to be confused with `VALKEY_PRIMARY_PORT_NUMBER` or `VALKEY_REPLICA_PORT` environment variables that are applicable in replication mode.
```console
docker run --name valkey -e VALKEY_PORT_NUMBER=7000 -p 7000:7000 bitnami/valkey:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/valkey/docker-compose.yml) file present in this repository:
```yaml
services:
valkey:
...
environment:
- VALKEY_PORT_NUMBER=7000
...
ports:
- 7000:7000
....
```
### Setting up replication
A replication cluster can easily be setup with the Bitnami Valkey Docker Image using the following environment variables:
@@ -397,86 +227,6 @@ A replication cluster can easily be setup with the Bitnami Valkey Docker Image u
In a replication cluster you can have one primary and zero or more replicas. When replication is enabled the primary node is in read-write mode, while the replicas are in read-only mode. For best performance its advisable to limit the reads to the replicas.
#### Step 1: Create the replication primary
The first step is to start the Valkey primary.
```console
docker run --name valkey-primary \
-e VALKEY_REPLICATION_MODE=primary \
-e VALKEY_PASSWORD=primarypassword123 \
bitnami/valkey:latest
```
In the above command the container is configured as the `primary` using the `VALKEY_REPLICATION_MODE` parameter. The `VALKEY_PASSWORD` parameter enables authentication on the Valkey primary.
#### Step 2: Create the replica node
Next we start a Valkey replica container.
```console
docker run --name valkey-replica \
--link valkey-primary:primary \
-e VALKEY_REPLICATION_MODE=replica \
-e VALKEY_PRIMARY_HOST=primary \
-e VALKEY_PRIMARY_PORT_NUMBER=6379 \
-e VALKEY_PRIMARY_PASSWORD=primarypassword123 \
-e VALKEY_PASSWORD=password123 \
bitnami/valkey:latest
```
In the above command the container is configured as a `replica` using the `VALKEY_REPLICATION_MODE` parameter. The `VALKEY_PRIMARY_HOST`, `VALKEY_PRIMARY_PORT_NUMBER` and `VALKEY_PRIMARY_PASSWORD` parameters are used connect and authenticate with the Valkey primary. The `VALKEY_PASSWORD` parameter enables authentication on the Valkey replica.
You now have a two node Valkey primary/replica replication cluster up and running which can be scaled by adding/removing replicas.
If the Valkey primary goes down you can reconfigure a replica to become a primary using:
```console
docker exec valkey-replica valkey-cli -a password123 REPLICAOF NO ONE
```
> **Note**: The configuration of the other replicas in the cluster needs to be updated so that they are aware of the new primary. In our example, this would involve restarting the other replicas with `--link valkey-replica:primary`.
With Docker Compose the primary/replica mode can be setup using:
```yaml
version: '2'
services:
valkey-primary:
image: bitnami/valkey:latest
ports:
- 6379
environment:
- VALKEY_REPLICATION_MODE=primary
- VALKEY_PASSWORD=my_primary_password
volumes:
- /path/to/valkey-persistence:/bitnami
valkey-replica:
image: bitnami/valkey:latest
ports:
- 6379
depends_on:
- valkey-primary
environment:
- VALKEY_REPLICATION_MODE=replica
- VALKEY_PRIMARY_HOST=valkey-primary
- VALKEY_PRIMARY_PORT_NUMBER=6379
- VALKEY_PRIMARY_PASSWORD=my_primary_password
- VALKEY_PASSWORD=my_replica_password
```
Scale the number of replicas using:
```console
docker-compose up --detach --scale valkey-primary=1 --scale valkey-replica=3
```
The above command scales up the number of replicas to `3`. You can scale down in the same way.
> **Note**: You should not scale up/down the number of primary nodes. Always have only one primary node running.
### Securing Valkey traffic
Valkey adds the support for SSL/TLS connections. Should you desire to enable this optional feature, you may use the following environment variables to configure the application:
@@ -492,39 +242,6 @@ Valkey adds the support for SSL/TLS connections. Should you desire to enable thi
When enabling TLS, conventional standard traffic is disabled by default. However this new feature is not mutually exclusive, which means it is possible to listen to both TLS and non-TLS connection simultaneously. To enable non-TLS traffic, set `VALKEY_TLS_PORT_NUMBER` to another port different than `0`.
1. Using `docker run`
```console
$ docker run --name valkey \
-v /path/to/certs:/opt/bitnami/valkey/certs \
-v /path/to/valkey-data-persistence:/bitnami/valkey/data \
-e ALLOW_EMPTY_PASSWORD=yes \
-e VALKEY_TLS_ENABLED=yes \
-e VALKEY_TLS_CERT_FILE=/opt/bitnami/valkey/certs/valkey.crt \
-e VALKEY_TLS_KEY_FILE=/opt/bitnami/valkey/certs/valkey.key \
-e VALKEY_TLS_CA_FILE=/opt/bitnami/valkey/certs/valkeyCA.crt \
bitnami/valkey:latest
```
2. Modifying the `docker-compose.yml` file present in this repository:
```yaml
services:
valkey:
...
environment:
...
- VALKEY_TLS_ENABLED=yes
- VALKEY_TLS_CERT_FILE=/opt/bitnami/valkey/certs/valkey.crt
- VALKEY_TLS_KEY_FILE=/opt/bitnami/valkey/certs/valkey.key
- VALKEY_TLS_CA_FILE=/opt/bitnami/valkey/certs/valkeyCA.crt
...
volumes:
- /path/to/certs:/opt/bitnami/valkey/certs
- /path/to/valkey-persistence:/bitnami/valkey/data
...
```
Alternatively, you may also provide with this configuration in your [custom](https://github.com/bitnami/containers/blob/main/bitnami/valkey#configuration-file) configuration file.
### Configuration file
@@ -575,32 +292,7 @@ services:
### Enable Valkey RDB persistence
When the value of `VALKEY_RDB_POLICY_DISABLED` is `no` (default value) the Valkey default persistence strategy will be used. If you want to modify the default strategy, you can configure it through the `VALKEY_RDB_POLICY` parameter. Here is a demonstration of modifying the default persistence strategy
1. Using `docker run`
```console
$ docker run --name valkey \
-v /path/to/valkey-data-persistence:/bitnami/valkey/data \
-e ALLOW_EMPTY_PASSWORD=yes \
-e VALKEY_RDB_POLICY_DISABLED=no
-e VALKEY_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
bitnami/valkey:latest
```
2. Modifying the `docker-compose.yml` file present in this repository:
```yaml
valkey:
...
environment:
...
- VALKEY_TLS_ENABLED=yes
- VALKEY_RDB_POLICY_DISABLED=no
- VALKEY_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
...
...
```
When the value of `VALKEY_RDB_POLICY_DISABLED` is `no` (default value) the Valkey default persistence strategy will be used. If you want to modify the default strategy, you can configure it through the `VALKEY_RDB_POLICY` parameter.
### FIPS configuration in Bitnami Secure Images
@@ -624,73 +316,6 @@ docker-compose logs valkey
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
## Maintenance
### Upgrade this image
Bitnami provides up-to-date versions of Valkey, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
#### Step 1: Get the updated image
```console
docker pull bitnami/valkey:latest
```
or if you're using Docker Compose, update the value of the image property to
`bitnami/valkey:latest`.
#### Step 2: Stop and backup the currently running container
Stop the currently running container using the command
```console
docker stop valkey
```
or using Docker Compose:
```console
docker-compose stop valkey
```
Next, take a snapshot of the persistent volume `/path/to/valkey-persistence` using:
```console
rsync -a /path/to/valkey-persistence /path/to/valkey-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
docker rm -v valkey
```
or using Docker Compose:
```console
docker-compose rm -v valkey
```
#### Step 4: Run the new image
Re-create your container from the new image.
```console
docker run --name valkey bitnami/valkey:latest
```
or using Docker Compose:
```console
docker-compose up valkey
```
## Using `docker-compose.yaml`
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated [Bitnami Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/valkey).
If you detect any issue in the `docker-compose.yaml` file, feel free to report it or contribute with a fix by following our [Contributing Guidelines](https://github.com/bitnami/containers/blob/main/CONTRIBUTING.md).
## Notable Changes
### Starting October 20, 2024