diff --git a/bitnami/redis-cluster/7.2/debian-11/Dockerfile b/bitnami/redis-cluster/7.2/debian-11/Dockerfile index d50e43401c27..e160684edc6b 100644 --- a/bitnami/redis-cluster/7.2/debian-11/Dockerfile +++ b/bitnami/redis-cluster/7.2/debian-11/Dockerfile @@ -7,10 +7,10 @@ ARG TARGETARCH LABEL com.vmware.cp.artifact.flavor="sha256:1e1b4657a77f0d47e9220f0c37b9bf7802581b93214fff7d1bd2364c8bf22e8e" \ org.opencontainers.image.base.name="docker.io/bitnami/minideb:bullseye" \ - org.opencontainers.image.created="2024-01-09T13:35:10Z" \ + org.opencontainers.image.created="2024-01-11T15:50:34Z" \ org.opencontainers.image.description="Application packaged by VMware, Inc" \ org.opencontainers.image.licenses="Apache-2.0" \ - org.opencontainers.image.ref.name="7.2.4-debian-11-r0" \ + org.opencontainers.image.ref.name="7.2.4-debian-11-r1" \ org.opencontainers.image.title="redis-cluster" \ org.opencontainers.image.vendor="VMware, Inc." \ org.opencontainers.image.version="7.2.4" diff --git a/bitnami/redis-cluster/README.md b/bitnami/redis-cluster/README.md index 7ba06b06df9e..b5c2a148fd2c 100644 --- a/bitnami/redis-cluster/README.md +++ b/bitnami/redis-cluster/README.md @@ -168,39 +168,64 @@ services: ### Environment variables -The following env vars are supported for this container: +| Name | Description | Default Value | Can be set | +|------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------|------------| +| `$REDIS_VOLUME_DIR` | Persistence base directory | `/bitnami/redis` | | +| `$REDIS_BASE_DIR` | Redis installation directory | `${BITNAMI_ROOT_DIR}/redis` | | +| `$REDIS_CONF_DIR` | Redis configuration directory | `${REDIS_BASE_DIR}/etc` | | +| `$REDIS_DATA_DIR` | Redis data directory | `${REDIS_VOLUME_DIR}/data` | ✓ | +| `$REDIS_MOUNTED_CONF_DIR` | Redis mounted configuration directory | `${REDIS_BASE_DIR}/mounted-etc` | | +| `$REDIS_OVERRIDES_FILE` | Redis config overrides file | `${REDIS_MOUNTED_CONF_DIR}/overrides.conf` | ✓ | +| `$REDIS_CONF_FILE` | Redis configuration file | `${REDIS_CONF_DIR}/redis.conf` | | +| `$REDIS_LOG_DIR` | Redis logs directory | `${REDIS_BASE_DIR}/logs` | | +| `$REDIS_LOG_FILE` | Redis log file | `${REDIS_LOG_DIR}/redis.log` | | +| `$REDIS_TMP_DIR` | Redis temporary directory | `${REDIS_BASE_DIR}/tmp` | | +| `$REDIS_PID_FILE` | Redis PID file | `${REDIS_TMP_DIR}/redis.pid` | | +| `$REDIS_BIN_DIR` | Redis executables directory | `${REDIS_BASE_DIR}/bin` | | +| `$REDIS_DAEMON_USER` | Redis system user | `redis` | | +| `$REDIS_DAEMON_GROUP` | Redis system group | `redis` | | +| `$REDIS_DISABLE_COMMANDS` | Commands to disable in Redis | | ✓ | +| `$REDIS_DATABASE` | Default Redis database | `redis` | ✓ | +| `$REDIS_AOF_ENABLED` | Enable AOF | `yes` | ✓ | +| `$REDIS_RDB_POLICY` | Enable RDB policy persitence | | ✓ | +| `$REDIS_RDB_POLICY_DISABLED` | Allows to enable RDP policy persistence | `no` | ✓ | +| `$REDIS_MASTER_HOST` | Redis master host (used by slaves) | | ✓ | +| `$REDIS_MASTER_PORT_NUMBER` | Redis master host port (used by slaves) | `6379` | ✓ | +| `$REDIS_DEFAULT_PORT_NUMBER` | Redis port number (Build time) | `6379` | | +| `$REDIS_PORT_NUMBER` | Redis port number | `$REDIS_DEFAULT_PORT_NUMBER` | ✓ | +| `$REDIS_ALLOW_REMOTE_CONNECTIONS` | Allow remote connection to the service | `yes` | ✓ | +| `$REDIS_REPLICATION_MODE` | Redis replication mode (values: master, slave) | | ✓ | +| `$REDIS_REPLICA_IP` | The replication announce ip | | ✓ | +| `$REDIS_REPLICA_PORT` | The replication announce port | | ✓ | +| `$REDIS_EXTRA_FLAGS` | Additional flags pass to 'redis-server' commands | | ✓ | +| `$ALLOW_EMPTY_PASSWORD` | Allow password-less access | `no` | ✓ | +| `$REDIS_PASSWORD` | Password for Redis | | ✓ | +| `$REDIS_MASTER_PASSWORD` | Redis master node password | | ✓ | +| `$REDIS_ACLFILE` | Redis ACL file | | ✓ | +| `$REDIS_IO_THREADS_DO_READS` | Enable multithreading when reading socket | | ✓ | +| `$REDIS_IO_THREADS` | Number of threads | | ✓ | +| `$REDIS_TLS_ENABLED` | Enable TLS | `no` | ✓ | +| `$REDIS_TLS_PORT_NUMBER` | Redis TLS port (requires REDIS_ENABLE_TLS=yes) | `6379` | ✓ | +| `$REDIS_TLS_CERT_FILE` | Redis TLS certificate file | | ✓ | +| `$REDIS_TLS_KEY_FILE` | Redis TLS key file | | ✓ | +| `$REDIS_TLS_KEY_FILE_PASS` | Redis TLS key file passphrase | | ✓ | +| `$REDIS_TLS_CA_FILE` | Redis TLS CA file | | ✓ | +| `$REDIS_TLS_DH_PARAMS_FILE` | Redis TLS DH parameter file | | ✓ | +| `$REDIS_TLS_AUTH_CLIENTS` | Enable Redis TLS client authentication | `yes` | ✓ | +| `$REDIS_CLUSTER_CREATOR` | Launch the cluster bootstrap command | `no` | ✓ | +| `$REDIS_CLUSTER_REPLICAS` | Number of cluster replicas | `1` | ✓ | +| `$REDIS_CLUSTER_DYNAMIC_IPS` | Use dynamic IPS for cluster creation | `yes` | ✓ | +| `$REDIS_CLUSTER_ANNOUNCE_IP` | IP to use for announcing the cluster service | | ✓ | +| `$REDIS_CLUSTER_ANNOUNCE_PORT` | Client port to use for announcing the cluster service | | ✓ | +| `$REDIS_CLUSTER_ANNOUNCE_BUS_PORT` | Cluster message bus port to use for announcing the cluster service | | ✓ | +| `$REDIS_DNS_RETRIES` | Number of retries in order to get an addresable domain name | `120` | ✓ | +| `$REDIS_NODES` | List of Redis cluster nodes | | ✓ | +| `$REDIS_CLUSTER_SLEEP_BEFORE_DNS_LOOKUP` | Time to wait before the DNS lookup | `0` | ✓ | +| `$REDIS_CLUSTER_DNS_LOOKUP_RETRIES` | Number of retires for the DNS lookup | `1` | ✓ | +| `$REDIS_CLUSTER_DNS_LOOKUP_SLEEP` | Time to sleep between DNS lookups | `1` | ✓ | +| `$REDIS_CLUSTER_ANNOUNCE_HOSTNAME` | Hostname that node should announce, used for non dynamic ip environments. | | ✓ | +| `$REDIS_CLUSTER_PREFERRED_ENDPOINT_TYPE` | Preferred endpoint type which cluster should use (ip, hostname) | `ip` | ✓ | -| Name | Description | -|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `REDIS_DISABLE_COMMANDS` | Disables the specified Redis(R) commands | -| `REDIS_PORT_NUMBER` | Set the Redis(R) port. Default=: `6379` | -| `REDIS_PASSWORD` | Set the Redis(R) password. Default: `bitnami` | -| `ALLOW_EMPTY_PASSWORD` | Enables access without password | -| `REDIS_DNS_RETRIES` | Number of retries to get the IPs of the provided `REDIS_NODES`. It will wait 5 seconds between retries | -| `REDISCLI_AUTH` | Provide the same value as the configured `REDIS_PASSWORD` for the redis-cli tool to authenticate | -| `REDIS_CLUSTER_CREATOR` | Set to `yes` if the container will be the one on charge of initialize the cluster. This node will also be part of the cluster. | -| `REDIS_CLUSTER_REPLICAS` | Number of replicas for every master that the cluster will have. | -| `REDIS_NODES` | String delimited by spaces containing the hostnames of all of the nodes that will be part of the cluster | -| `REDIS_CLUSTER_ANNOUNCE_IP` | IP that the node should announce, used for non dynamic ip environments | -| `REDIS_CLUSTER_ANNOUNCE_PORT` | Port that the node should announce, used for non dynamic ip environments. | -| `REDIS_CLUSTER_ANNOUNCE_HOSTNAME` | Hostname that node should announce, used for non dynamic ip environments. | -| `REDIS_CLUSTER_PREFERRED_ENDPOINT_TYPE` | Preferred endpoint type which cluster should use, options- ip, hostname | -| `REDIS_CLUSTER_ANNOUNCE_BUS_PORT` | The cluster bus port to announce. | -| `REDIS_CLUSTER_DYNAMIC_IPS` | Set to `no` if your Redis(R) cluster will be created with statical IPs. Default: `yes` | -| `REDIS_TLS_ENABLED` | Whether to enable TLS for traffic or not. Defaults to `no`. | -| `REDIS_TLS_PORT_NUMBER` | Port used for TLS secure traffic. Defaults to `6379`. | -| `REDIS_TLS_CERT_FILE` | File containing the certificate file for the TLS traffic. No defaults. | -| `REDIS_TLS_KEY_FILE` | File containing the key for certificate. No defaults. | -| `REDIS_TLS_CA_FILE` | File containing the CA of the certificate. No defaults. | -| `REDIS_TLS_DH_PARAMS_FILE` | File containing DH params (in order to support DH based ciphers). No defaults. | -| `REDIS_TLS_AUTH_CLIENTS` | Whether to require clients to authenticate or not. Defaults to `yes`. | -| `REDIS_CLUSTER_SLEEP_BEFORE_DNS_LOOKUP` | Number of seconds to wait before initializing the cluster. Set this to a higher value if you sometimes have issues with initial cluster creation. Defaults to `0`. | -| `REDIS_CLUSTER_DNS_LOOKUP_RETRIES` | Number of retries for the node's DNS lookup during the initial cluster creation. Defaults to `5`. | -| `REDIS_CLUSTER_DNS_LOOKUP_SLEEP` | Number of seconds to wait between each node's DNS lookup during the initial cluster creation. Defaults to `1`. | -| `REDIS_IO_THREADS` | Number of threads to implement multithreading operations. Defaults to `1`. | -| `REDIS_IO_THREADS_DO_READS` | Enables multithreading for read operations. Defaults to `false`. | -| `REDIS_RDB_POLICY` | Set this variable to enable RDB persistent storage RDB data synchronization strategy configuration example `900#1 300#10 60#1000` Defaults to disable RDB persistent storage. | -| `REDIS_RDB_POLICY_DISABLED` | If set to `yes` the container will skip the configuration of RDB policy ('save' setting) and rely on Redis(R) default. If `REDIS_RDB_POLICY` is provided, this will be ignored. Defaults to `no`. | Once all the Redis(R) nodes are running you need to execute command like the following to initiate the cluster: