bitnamisecure/valkey Docker 镜像 - 轩辕镜像

Bitnami Secure Image for Valkey

What is Valkey?

Valkey is a high-performance data structure server that primarily serves key/value workloads. It supports a wide range of native structures and an extensible plugin system for adding new data structures and access patterns.

Overview of Valkey Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

console
docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes REGISTRY_NAME/bitnami/valkey:latest

Warning: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Configuration section for a more secure deployment.

Why use Bitnami Secure Images?

Those are hardened, minimal CVE images built and maintained by Bitnami. Bitnami Secure Images are based on the cloud-optimized, security-hardened enterprise OS Photon Linux. Why choose BSI images?

• Hardened secure images of popular open source software with Near-Zero Vulnerabilities
• Vulnerability Triage & Prioritization with VEX Statements, KEV and EPSS Scores
• Compliance focus with FIPS, STIG, and air-gap options, including secure bill of materials (SBOM)
• Software supply chain provenance attestation through in-toto
• First class support for the internet’s favorite Helm charts

Each image comes with valuable security metadata. You can view the metadata in our public catalog here. Note: Some data is only available with commercial subscriptions to BSI.

!Alt text !Alt text

If you are looking for our previous generation of images based on Debian Linux, please see the Bitnami Legacy registry.

How to deploy Valkey in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Valkey Chart GitHub repository.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami Valkey Docker Image is to pull the prebuilt image from the Docker Hub Registry.

console
docker pull REGISTRY_NAME/bitnami/valkey:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

console
docker pull REGISTRY_NAME/bitnami/valkey:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

console
git clone [***]
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t REGISTRY_NAME/bitnami/APP:latest .

Persisting your database

Valkey provides a different range of persistence options. 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.

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

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 \
    REGISTRY_NAME/bitnami/valkey:latest

You can also do this by modifying the 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

Using Docker container networking, a Valkey server running inside a container can easily be accessed by your application containers.

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 \
    REGISTRY_NAME/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 \
    REGISTRY_NAME/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: REGISTRY_NAME/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

Customizable environment variables

Read-only environment variables

Disabling Valkey commands

For security reasons, you may want to disable some commands. You can specify them by using the following environment variable on the first run:

• 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 REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the 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:

console
docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes REGISTRY_NAME/bitnami/valkey:latest /opt/bitnami/scripts/valkey/run.sh --maxmemory 100mb

Alternatively, modify the docker-compose.yml file present in this repository:

yaml
services:
  valkey:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    command: /opt/bitnami/scripts/valkey/run.sh --maxmemory 100mb
  ...

Setting the server password on first run

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 REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the 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.

Allowing empty passwords

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 REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

yaml
services:
  valkey:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
  ...

Disabling AOF persistence

Valkey offers different options 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 REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

yaml
services:
  valkey:
  ...
    environment:
      - VALKEY_AOF_ENABLED=no
  ...

Enabling Access Control List

Valkey offers ACL 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.

console
docker run -name valkey -e VALKEY_ACLFILE=/opt/bitnami/valkey/mounted-etc/users.acl -v /path/to/users.acl:/opt/bitnami/valkey/mounted-etc/users.acl REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

yaml
services:
  valkey:
  ...
    environment:
      - VALKEY_ACLFILE=/opt/bitnami/valkey/mounted-etc/users.acl
    volumes:
      - /path/to/users.acl:/opt/bitnami/valkey/mounted-etc/users.acl
  ...

Setting up a standalone instance

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 REGISTRY_NAME/bitnami/valkey:latest

Alternatively, modify the 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:

• VALKEY_REPLICATION_MODE: The replication mode. Possible values primary/replica. No defaults.
• VALKEY_REPLICA_IP: The replication announce ip. Defaults to $(get_machine_ip) which return the ip of the container.
• VALKEY_REPLICA_PORT: The replication announce port. Defaults to VALKEY_PRIMARY_PORT_NUMBER.
• VALKEY_PRIMARY_HOST: Hostname/IP of replication primary (replica node parameter). No defaults.
• VALKEY_PRIMARY_PORT_NUMBER: Server port of the replication primaty (replica node parameter). Defaults to 6379.
• VALKEY_PRIMARY_PASSWORD: Password to authenticate with the primary (replica node parameter). No defaults. As an alternative, you can mount a file with the password and set the VALKEY_PRIMARY_PASSWORD_FILE variable.

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 \
  REGISTRY_NAME/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 \
  REGISTRY_NAME/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: REGISTRY_NAME/bitnami/valkey:latest
    ports:
      - 6379
    environment:
      - VALKEY_REPLICATION_MODE=primary
      - VALKEY_PASSWORD=my_primary_password
    volumes:
      - /path/to/valkey-persistence:/bitnami

  valkey-replica:
    image: REGISTRY_NAME/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. A

_Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at [***]