diff --git a/CLAUDE.md b/CLAUDE.md index 83e1b835..52f7bbb8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,7 +2,7 @@ ## Overview -`itential.deployer` is an Ansible collection (namespace: `itential`, version: `3.7.2`) that deploys the full Itential automation platform stack: Itential Platform (IAP), Itential Automation Gateway (IAG), MongoDB, and Redis. It supports online and offline (air-gapped) installations, TLS configuration, and multiple deployment topologies. +`itential.deployer` is an Ansible collection (namespace: `itential`, version: `3.7.2`) that deploys the full Itential automation platform stack: Itential Platform (IAP), Itential Automation Gateway (IAG), MongoDB, and Redis (or Valkey as a Remi-free alternative, on EL9 or Amazon Linux 2023). It supports online and offline (air-gapped) installations, TLS configuration, and multiple deployment topologies. ## Collection Metadata @@ -35,6 +35,7 @@ Also requires the `jmespath` Python module on the control node. | `gateway.yml` | `itential.deployer.gateway` | Install IAG on `gateway` hosts | | `mongodb.yml` | `itential.deployer.mongodb` | Install MongoDB on `mongodb_primary`, `mongodb_replica`, `mongodb_arbiter` hosts | | `redis.yml` | `itential.deployer.redis` | Install Redis on `redis_master`/`redis_replica`; Sentinel on `redis_sentinel` hosts | +| `valkey.yml` | `itential.deployer.valkey` | Install Valkey on `valkey_master`/`valkey_replica`; Sentinel on `valkey_sentinel` hosts (EL9 or Amazon Linux 2023 only) | | `os.yml` | `itential.deployer.os` | Install base OS packages on all component hosts | | `nginx.yml` | `itential.deployer.nginx` | Install and configure nginx (wraps `nginxinc.nginx` and `nginxinc.nginx_config`) | | `nginx_install.yml` | `itential.deployer.nginx_install` | Install nginx only | @@ -43,10 +44,12 @@ Also requires the `jmespath` Python module on the control node. | `patch_gateway.yml` | `itential.deployer.patch_gateway` | Upgrade IAG in-place | | `certify.yml` | `itential.deployer.certify` | Run all certification playbooks (Redis + MongoDB + Platform) | | `certify_redis.yml` | `itential.deployer.certify_redis` | Generate Redis/Sentinel installation certification reports | +| `certify_valkey.yml` | `itential.deployer.certify_valkey` | Generate Valkey/Sentinel installation certification reports | | `certify_mongodb.yml` | `itential.deployer.certify_mongodb` | Generate MongoDB installation certification reports | | `certify_platform.yml` | `itential.deployer.certify_platform` | Generate Platform installation certification reports | | `verify.yml` | `itential.deployer.verify` | Pre-install environment verification (OS, HW specs, proxy, required repository connectivity) for all components | | `verify_redis.yml` | `itential.deployer.verify_redis` | Pre-install verification for Redis hosts | +| `verify_valkey.yml` | `itential.deployer.verify_valkey` | Pre-install verification for Valkey hosts | | `verify_mongodb.yml` | `itential.deployer.verify_mongodb` | Pre-install verification for MongoDB hosts | | `verify_platform.yml` | `itential.deployer.verify_platform` | Pre-install verification for Platform hosts | | `verify_gateway.yml` | `itential.deployer.verify_gateway` | Pre-install verification for Gateway hosts | @@ -57,6 +60,7 @@ Also requires the `jmespath` Python module on the control node. | `download_packages_gateway_site.yml` | `itential.deployer.download_packages_gateway_site` | Wraps `download_packages_gateway` with a tag | | `download_packages_mongodb.yml` | `itential.deployer.download_packages_mongodb` | Download MongoDB packages for offline install | | `download_packages_redis.yml` | `itential.deployer.download_packages_redis` | Download Redis packages for offline install | +| `download_packages_valkey.yml` | `itential.deployer.download_packages_valkey` | Download Valkey packages for offline install | | `download_packages_os.yml` | `itential.deployer.download_packages_os` | Download OS packages for offline install | ## Inventory Topology Options @@ -69,6 +73,7 @@ Also requires the `jmespath` Python module on the control node. | `asa` | `example_inventories/asa/` | Active/Standby: 5-node MongoDB (4 data + 1 arbiter across 3 DCs), 4-node Redis across 3 DCs. Disaster recovery topology. | | `platform` | `example_inventories/platform/` | Platform-only example showing external (managed) Redis/MongoDB via URL. | | `redis` | `example_inventories/redis/` | Redis-only examples: install from Remi repo, from system repo, or from source. | +| `valkey` | `example_inventories/valkey/` | Valkey-only example: install via the native OS package repositories on EL9 or Amazon Linux 2023 (the only supported method). | ## Roles Summary @@ -81,6 +86,7 @@ Also requires the `jmespath` Python module on the control node. | `offline` | Shared utility role for downloading and installing RPMs/wheels/adapters in air-gapped mode. | | `mongodb` | Installs and configures MongoDB: users, replica set, auth, TLS, kernel tuning, SELinux, logrotate, NUMA. | | `redis` | Installs and configures Redis (from source or repo) and Redis Sentinel: auth, TLS, replication, SELinux. | +| `valkey` | Installs and configures Valkey (via the native OS package repositories only — EL9 AppStream or Amazon Linux 2023's core repo) and Valkey Sentinel: auth, TLS, replication. No source install, no Remi, no EL8 support, no relocatable install paths, no role-level SELinux step (handled entirely by the base OS policy). | | `platform` | Installs and configures Itential Platform: NodeJS, Python, RPM packages, adapters, properties file, TLS certs, Vault, SELinux. | | `gateway` | Installs and configures Itential Automation Gateway (IAG): Python venv, Ansible, Nornir, TLS certs, systemd service, SELinux. | @@ -102,12 +108,13 @@ Also requires the `jmespath` Python module on the control node. ## TLS Overview -TLS is supported at the component level and is **enabled by default** for MongoDB and Platform, and **disabled by default** for Redis. +TLS is supported at the component level and is **enabled by default** for MongoDB, Platform, and Valkey, and **disabled by default** for Redis. | Component | Enable Flag | Copy-Certs Flag | PKI Base Dir | |-----------|------------|-----------------|--------------| | MongoDB | `mongodb_tls_enabled: true` | `mongodb_tls_copy_certs: true` | `/etc/pki/mongodb` | | Redis | `redis_tls_enabled: false` | n/a (always copies when TLS enabled) | `/etc/pki/redis` | +| Valkey | `valkey_tls_enabled: true` | n/a (always copies when TLS enabled) | `/etc/pki/valkey` | | Platform (HTTPS) | `platform_webserver_https_enabled: true` | `platform_webserver_https_copy_certs: true` | `/etc/pki/itential-platform/https` | | Platform (MongoDB client) | `platform_mongo_tls_enabled: true` | `platform_mongodb_copy_certs: true` | `/etc/pki/itential-platform/mongodb` | | Gateway (HTTPS) | `gateway_https_enabled: true` | `gateway_pki_copy_certs: true` | `/etc/pki/automation-gateway` | @@ -149,6 +156,7 @@ See `docs/offline_install_guide.md` for the full workflow. | `docs/itential_gateway_guide.md` | Gateway role variables, feature flags, Ansible/Nornir config | | `docs/mongodb_guide.md` | MongoDB role variables, replica set, TLS, user accounts | | `docs/redis_guide.md` | Redis role variables, Sentinel, TLS, install methods | +| `docs/valkey_guide.md` | Valkey role variables, Sentinel, TLS, EL9/Amazon Linux 2023 native package install | | `docs/tls_guide.md` | End-to-end TLS configuration guide across all components | | `docs/offline_install_guide.md` | Step-by-step offline (air-gapped) install workflow | | `docs/patch_itential_platform_guide.md` | How to run `patch_platform.yml` to upgrade Platform | diff --git a/README.md b/README.md index c33dbf4b..fbe309ed 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,9 @@ 6. [Component Guides](#component-guides) 1. [MongoDB](#mongodb) 2. [Redis](#redis) - 3. [Itential Platform](#itential-platform) - 4. [Itential Gateway](#itential-gateway) + 3. [Valkey](#valkey) + 4. [Itential Platform](#itential-platform) + 5. [Itential Gateway](#itential-gateway) 7. [Patching Itential Platform and IAG](#patching-itential-platform-and-iag) 8. [Using Internal YUM Repositories](#using-internal-yum-repositories) 9. [Running the Deployer in Offline Mode](#running-the-deployer-in-offline-mode) @@ -45,7 +46,7 @@ At its most basic, the following must be installed. - Itential Platform - Itential Automation Gateway (IAG) -- Redis +- Redis (or Valkey as a Remi-free alternative, on EL9 or Amazon Linux 2023) - MongoDB Optionally, one can include Hashicorp Vault for secrets management, and Prometheus & Grafana for @@ -106,7 +107,7 @@ The ideal HA2 environment will have 9 VMs: - 2 VMs hosting Itential Platform. - 3 VMs hosting MongoDB configured as a replica set. -- 3 VMs hosting Redis configured as a highly available replica set using Redis Sentinel. +- 3 VMs hosting Redis (or Valkey, on EL9/Amazon Linux 2023 hosts) configured as a highly available replica set using Sentinel. - 1 VM hosting IAG. Itential recommends applying sound security principles to ALL environments. This would include @@ -138,6 +139,12 @@ members in the primary data center, 2 data-bearing members in the secondary data MongoDB, Redis HA requires Redis Sentinel. These must be distributed in 3 data centers to preserve a majority of voting members (3) in the event of a data center loss. +Valkey is a protocol-compatible, drop-in alternative to Redis and follows the identical HA mechanics +described above: same replica/Sentinel topology, same quorum math, same data center distribution. +It is currently only supported on EL9 and Amazon Linux 2023 hosts, installed via the native OS +package repositories (no Remi, no source install) — see the [Valkey Guide](docs/valkey_guide.md) +for details. + Itential recommends applying sound security principles to ALL environments. In the ASA, this would include configuring all components to use authentication and use SSL when communicating with components on other VMs and across clusters. @@ -239,6 +246,7 @@ the Deployer will either install the required repository or download the package | Redis | | TCP | EPEL YUM RPMs
When installing Redis from the Remi repository | | Redis | | TCP | Redis source packages
When installing Redis from source | | Redis | | TCP | Redis source packages
When installing Redis from source | +| Valkey | | TCP | Rocky/AlmaLinux 9 AppStream mirror for the Valkey RPM. RHEL proper resolves AppStream through its own subscription-manager CDN instead of a fixed public URL; Amazon Linux 2023 ships Valkey in its own preconfigured core repository. Neither of those is checked by the `verify` playbook. | If internal YUM repositories are used, refer to the [Using Internal YUM Repositories](#using-internal-yum-repositories) section. @@ -257,7 +265,7 @@ ansible-playbook itential.deployer.verify -i ``` This checks each component's target hosts (`gateway`, `platform*`, `mongodb*`, `redis_master`/ -`redis_replica`) against the rows in the table above. See +`redis_replica`, `valkey_master`/`valkey_replica`) against the rows in the table above. See [Confirm Requirements](#confirm-requirements) for details. ### Ports and Networking @@ -275,6 +283,8 @@ network traffic flows need to be allowed. | Itential Platform | MongoDB | 27017 | TCP | Itential Platform connections to MongoDB | | Itential Platform | Redis | 6379 | TCP | Itential Platform connections to Redis | | Itential Platform | Redis | 26379 | TCP | Itential Platform connections to Redis Sentinel | +| Itential Platform | Valkey | 6379 | TCP | Itential Platform connections to Valkey | +| Itential Platform | Valkey | 26379 | TCP | Itential Platform connections to Valkey Sentinel | | Itential Platform | IAG | 8083 | TCP | Itential Platform connections to IAG over HTTP | | Itential Platform | IAG | 8443 | TCP | Itential Platform connections to IAG over HTTPS | | Itential Platform | Vault | 8200 | TCP | Itential Platform connections to Hashicorp Vault | @@ -284,6 +294,8 @@ network traffic flows need to be allowed. | MongoDB | MongoDB | 27017 | TCP | MongoDB replication | | Redis | Redis | 6379 | TCP | Redis replication | | Redis | Redis | 26379 | TCP | Redis Sentinel for HA | +| Valkey | Valkey | 6379 | TCP | Valkey replication | +| Valkey | Valkey | 26379 | TCP | Valkey Sentinel for HA | Notes @@ -303,6 +315,7 @@ can be used and what their purpose is. | IAG webserver | Enables HTTPS communications with the IAG webserver. | | MongoDB | Enables secure communications with the MongoDB server. Also used for intra-node mongo replication. | | Redis | Enables secure communications with the Redis server. Also used for intra-node redis replication. | +| Valkey | Enables secure communications with the Valkey server. Also used for intra-node valkey replication. | | LDAP | Enables secure communications with LDAP server. | ### Passwords @@ -330,6 +343,17 @@ these variables just define the variable in the deployer host file. | sentineluser | sentineluser | redis_user_sentineluser_password | Has access to the minimum set of commands to perform sentinel monitoring: multi, slaveof, ping, exec, subscribe, config.rewrite, role, publish, info, client.setname, client.kill, script.kill. | | monitor | monitor | redis_user_monitor_password | Read-only access to gather metric and cluster data from Redis and Sentinel. Enabled via `redis_monitor_user_enabled`. | +#### Valkey Accounts + +| User Account | Default Password | Variable Name | Description | +| :----------- | :--------------- | :------------ | :---------- | +| admin | admin | valkey_user_admin_password | Has full root access to the Valkey database, all channels, all keys, all commands. | +| itential | itential | valkey_user_itential_password | Has full access to the Valkey database, all channels, all keys, EXCEPT the following commands: asking, cluster, readonly, readwrite, bgrewriteaof, bgsave, failover, flushall, flushdb, psync, replconf, replicaof, save, shutdown, sync. | +| repluser | repluser | valkey_user_repluser_password | Has access to the minimum set of commands to perform replication: psync, replconf, ping. | +| admin | sentineladmin | valkey_user_sentineladmin_password | Full root access to Valkey Sentinel. | +| sentineluser | sentineluser | valkey_user_sentineluser_password | Has access to the minimum set of commands to perform sentinel monitoring: multi, slaveof, ping, exec, subscribe, config.rewrite, role, publish, info, client.setname, client.kill, script.kill. | +| monitor | monitor | valkey_user_monitor_password | Read-only access to gather metric and cluster data from Valkey and Sentinel. Enabled via `valkey_monitor_user_enabled`. | + ### Obtaining the Itential Binaries #### SaaS @@ -411,6 +435,9 @@ ansible-playbook -i itential.deployer.verify # Verify Redis ansible-playbook -i itential.deployer.verify_redis +# Verify Valkey +ansible-playbook -i itential.deployer.verify_valkey + # Verify MongoDB ansible-playbook -i itential.deployer.verify_mongodb @@ -650,6 +677,9 @@ ansible-playbook -i itential.deployer.certify # Certify Redis ansible-playbook -i itential.deployer.certify_redis +# Certify Valkey +ansible-playbook -i itential.deployer.certify_valkey + # Certify MongoDB ansible-playbook -i itential.deployer.certify_mongodb @@ -723,7 +753,7 @@ $ sudo systemctl status automation-gateway └─94844 /opt/automation-gateway/venv/bin/python3 /opt/automation-gateway/venv/bin/automation-gateway --properties-file=/etc/automation-gateway/propert> ``` -#### MongoDB and Redis +#### MongoDB, Redis, and Valkey From the command line of each dependency server, use the `sudo systemctl status ` command to confirm that the relevant service is running. When executing the command, replace `` @@ -731,6 +761,7 @@ with one of the following: - **MongoDB**: `mongod` - **Redis**: `redis` +- **Valkey**: `valkey` The output should look similar to the following examples. @@ -769,6 +800,24 @@ $ sudo systemctl status redis └─15723 "/usr/bin/redis-server 127.0.0.1:6379" ``` +
+ +#### Example Output: Valkey Status + +```bash +$ sudo systemctl status valkey +● valkey.service - Valkey persistent key-value database + Loaded: loaded (/usr/lib/systemd/system/valkey.service; enabled; preset: disabled) + Active: active (running) since Thu 2026-09-11 09:15:00 UTC; 20h ago + Main PID: 15723 (valkey-server) + Status: "Ready to accept connections" + Tasks: 5 (limit: 22862) + Memory: 9.7M + CPU: 13.409s + CGroup: /system.slice/valkey.service + └─15723 "/usr/bin/valkey-server 127.0.0.1:6379" +``` + ## Component Guides In addition to the `itential.deployer.site` playbook, there are playbooks for each component. @@ -785,6 +834,10 @@ corresponding variables are detailed in the following guides. [Redis Guide](docs/redis_guide.md) +### Valkey + +[Valkey Guide](docs/valkey_guide.md) + ### Itential Platform [Itential Platform Guide](docs/itential_platform_guide.md) @@ -860,3 +913,27 @@ replication process. - Redis Sentinel will be included to monitor the Redis cluster and will be colocated with Redis. - Redis Sentinel will have an admin user able to perform a Sentinel task. - Redis nodes maintain a low latency connection between nodes to avoid replication failures. + +### Highly Available Valkey + +Valkey is a protocol-compatible fork of Redis and its clustering model is identical: a +primary/secondary replication topology monitored by Sentinel, with the same failure-detection and +promotion mechanics described above for Redis. Itential's preferred Valkey cluster assumes the same +requirements as the preferred Redis cluster: + +- Authentication between the replica members is done with users defined in the Valkey config file. +- Valkey will have an admin user able to perform any operation. +- Valkey will have an "itential" user that is granted the least amount of privileges required by the +application. +- Valkey will have a replication user that is granted the least amount of privileges required by the +replication process. +- Initial passwords are intended to be changed. +- Valkey Sentinel will be included to monitor the Valkey cluster and will be colocated with Valkey. +- Valkey Sentinel will have an admin user able to perform a Sentinel task. +- Valkey nodes maintain a low latency connection between nodes to avoid replication failures. + +Unlike Redis, Valkey is currently only supported on EL9 and Amazon Linux 2023 hosts, installed +exclusively via the native OS package repositories — there is no Remi option and no +source-install fallback for EL8. Valkey's install paths also cannot be customized: the package +is not relocatable, so customers requiring non-standard install locations must use `roles/redis` +(source install) instead. diff --git a/docs/valkey_guide.md b/docs/valkey_guide.md new file mode 100644 index 00000000..b902bbf4 --- /dev/null +++ b/docs/valkey_guide.md @@ -0,0 +1,300 @@ +# Valkey Role + +The playbook and role in this section install and configure Valkey for the Itential Platform, +as a Remi-free, non-source-compiled alternative to the `redis` role. There is one +Valkey-related role which installs Valkey and performs a base configuration. Optionally +configures authentication, TLS, and replication. + +## What is Valkey? + +Valkey is a BSD-licensed, community-governed fork of Redis, created after Redis changed its +license away from a fully open-source model. Valkey is protocol- and config-compatible with +Redis: it speaks the same RESP protocol, uses the same `redis.conf`-style configuration +grammar, and implements the same Sentinel protocol and ACL directives. This is why the +`valkey` role and its configuration files look nearly identical to the `redis` role's -- under +the hood, Valkey behaves the same way Redis does for everything this deployer configures +(authentication, TLS, replication, Sentinel failover). The Itential Platform connects to +either backend the same way, since Platform's client only speaks RESP and does not care which +server product is on the other end. + +## Supported Platforms + +**RHEL/Rocky/AlmaLinux 9, and Amazon Linux 2023.** Unlike the `redis` role, there is no +supported install path for EL8: + +- EL8's AppStream does not ship a Valkey module stream at all. +- EPEL8 does carry a Valkey package, but this deployer standardizes on the native OS package + repositories rather than mixing package sources, so EPEL8 is not used. +- Compiling Valkey from source would work on EL8, but this deployer deliberately does not + support source installs for Valkey at all (unlike `redis_install_from_source`, there is no + equivalent `valkey_install_from_source` flag or source-install code path in this role). + +A host placed in `valkey_master`, `valkey_replica`, or `valkey_sentinel` on EL8 (or any other +unsupported OS/version) fails `validate-vars.yml` immediately with an explicit error telling +the operator to use the `redis` role instead. + +Install locations are also not customizable on either supported platform: the Valkey RPM is +not relocatable (no `Prefix:` tag), so `valkey_bin_dir`, `valkey_conf_dir`, `valkey_data_dir`, +and `valkey_log_dir` cannot be overridden — `validate-vars.yml` enforces this. Customers who +need a non-standard install location must use `roles/redis` (source install) instead. + +## Valkey Install + +The `valkey` role performs a base install of Valkey from the native OS package repositories +(`dnf install valkey` — the AppStream module on EL9, Amazon Linux 2023's own core repo) +including any OS packages required. It creates the appropriate Linux +users, log files, and systemd services. It uses a template to generate a configuration file +based on the variables defined in the valkey group vars. It will start the Valkey service when +complete. + +Unlike `redis`, this role does not create `/etc/valkey`, `/var/lib/valkey`, or +`/var/log/valkey` itself, and does not install or manage any SELinux profiles -- the AppStream +package's own `%files` already creates those directories with the correct ownership, and the +base OS's `selinux-policy` package already maps standard Valkey paths onto the same +`redis_exec_t`/`redis_conf_t`/`redis_log_t`/`redis_var_lib_t` SELinux types Redis uses, so no +extra role-level SELinux work is required as long as the default paths are used (which they +always are -- overriding `valkey_bin_dir`, `valkey_conf_dir`, `valkey_data_dir`, or +`valkey_log_dir` is rejected by `validate-vars.yml`). + +## Authentication + +Optionally, the `valkey` role performs tasks to require authentication (username and password) +when communicating with the Valkey server. It adjusts the Valkey config file and adds each of +the required users and applies appropriate ACLs (see table). The "default" Valkey user is +disabled. It modifies the Valkey config file to use the appropriate user while doing +replication. It adjusts the Sentinel config file to enable the correct Sentinel user to +monitor the Valkey cluster, if required. It disables the default user in both Valkey and +Valkey Sentinel. + +| User Name | Default Password | Description | +| :-------- | :--------------- | :---------- | +| admin | admin | Has full access to the Valkey database. | +| itential | itential | Has access to all keys, all channels, and all commands except: -asking -cluster -readonly -readwrite -bgrewriteaof -bgsave -failover -flushall -flushdb -psync -replconf -replicaof -save -shutdown -sync | +| repluser | repluser | Has access to the minimum set of commands to perform replication. | +| sentineluser | sentineluser | Has access to the minimum set of commands to perform sentinel monitoring. | +| monitor | monitor | Has access to the minimum set of commands to gather metric and cluster data from Valkey and Sentinel. | + +:::(Warning) (⚠ Warning: ) It is assumed that these default passwords will be changed to meet +more rigorous standards. These are intended to be defaults strictly used just for ease of the +installation. It is highly recommended that sensitive data be encrypted using Ansible Vault. + +## TLS + +TLS is **enabled by default** for Valkey and Valkey Sentinel. Both are controlled by a single +flag (`valkey_tls_enabled`). When TLS is enabled, the deployer enforces TLSv1.3 only and +disables plain-text connections by setting `port 0` and listening exclusively on `tls-port`. + +Client certificate authentication is disabled by default (`valkey_tls_auth_clients: no`). The +connection is still fully encrypted; the server just does not require clients to present a +certificate. + +### Required Certificates + +The deployer does not generate certificates. The following files must be present on the +Ansible control node in the directory defined by `valkey_pki_src_dir`: + +| File | Variable | Description | +| :--- | :------- | :---------- | +| `.crt` | `valkey_tls_cert_file` | Server certificate (one per node by default) | +| `.key` | `valkey_tls_key_file` | Server private key (one per node by default) | +| `ca-bundle.crt` | `valkey_tls_ca_file` | CA bundle used to verify peer certificates | +| `.crt` | `valkey_sentinel_tls_cert_file` | Sentinel certificate (one per Sentinel node by default, named after inventory hostname) | +| `.key` | `valkey_sentinel_tls_key_file` | Sentinel private key (one per Sentinel node by default) | + +### Example Inventory - TLS Enabled (Single Node) + +```yaml +all: + children: + valkey_master: + hosts: + : + ansible_host: + vars: + platform_release: 6 + valkey_pki_src_dir: /path/to/certs/on/control/node +``` + +### Example Inventory - TLS Enabled (Sentinel HA) + +```yaml +all: + vars: + platform_release: 6 + valkey_pki_src_dir: /path/to/certs/on/control/node + children: + valkey_master: + hosts: + : + ansible_host: + valkey_replica: + hosts: + : + ansible_host: + : + ansible_host: + valkey_sentinel: + hosts: + : + ansible_host: + : + ansible_host: + : + ansible_host: +``` + +## Replication + +Optionally, the `valkey` role performs the steps required to create a Valkey replica set. It +uses a template to generate a Valkey Sentinel config file. It modifies the Valkey config file +to turn off protected-mode. It assumes that the first host defined in the inventory file is +the initial primary. It will update the config file for the non-primary Valkey servers to +replicate from the primary using hostname. It will start the Valkey Sentinel service when +complete. Replication and Sentinel failover mechanics are unchanged from Redis -- see the +`redis_guide.md` Replication section for the full explanation of replica priority and quorum +calculation, which apply identically here (`valkey_replica_priority`, `valkey_sentinel_quorum`). + +## Automatic Valkey Maxmemory Calculation + +When `valkey_maxmemory_bytes` is set to `auto`, the installation process automatically +calculates the Valkey `maxmemory` value based on the system's total available RAM, using the +same formula as the `redis` role: + +`maxmemory = max(valkey_maxmemory_min_mb, system_ram × valkey_maxmemory_ratio)` + +## Variables + +### Global Variables + +The variables in this section can be configured in the inventory in the `all` group or the +`valkey` group. + +| Variable | Type | Description | Default Value | +| :------- | :--- | :---------- | :------------ | +| `platform_release` | Fixed-point | Designates the Itential Platform major version. | N/A | + +Defining `platform_release` in the inventory is optional. However, this variable is used to +determine the default `valkey_packages` value. If `platform_release` is not defined, then +`valkey_packages` must be defined. + +### Valkey Variables + +The following table lists the default variables located in `roles/valkey/defaults/main/valkey.yml`. + +| Variable | Type | Description | Default Value | +| :------- | :--- | :---------- | :------------ | +| `valkey_bin_dir` | String | The Valkey binary directory. Not overridable -- see `validate-vars.yml`. | `/usr/bin` | +| `valkey_conf_dir` | String | The Valkey configuration directory. Not overridable. | `/etc/valkey` | +| `valkey_conf_file` | String | The location of the Valkey configuration file. | `/etc/valkey/valkey.conf` | +| `valkey_log_dir` | String | The Valkey log directory. Not overridable. | `/var/log/valkey` | +| `valkey_data_dir` | String | The location of the Valkey data directory. Not overridable. | `/var/lib/valkey` | +| `valkey_port` | Integer | The Valkey listen port. | `6379` | +| `valkey_owner` / `valkey_group` | String | The Valkey Linux user/group. | `valkey` | +| `valkey_tls_enabled` | Boolean | Flag to enable TLS connections. Also enables Sentinel TLS when Sentinel is in use. | `true` | +| `valkey_maxmemory_bytes` | String/Integer | Maximum memory Valkey can use. See Automatic Maxmemory Calculation above. | `auto` | +| `valkey_certify_report_dir_remote` / `_local` | String | Directories for certification reports. | `/var/tmp/itential-reports/valkey`, `/tmp/itential-reports/valkey` | + +### Auth, Replication, Sentinel, and PKI Variables + +These follow the exact same shape as the `redis` role's equivalents, `valkey_`-prefixed +instead of `redis_`-prefixed (e.g. `valkey_user_admin_password`, `valkey_replicaof`, +`valkey_sentinel_quorum`, `valkey_pki_base_dir`). See `redis_guide.md`'s corresponding tables +for full descriptions -- the semantics are identical. + +### Offline Variables + +There are several variables used when downloading and installing Valkey in offline mode. +These variables will not be documented here since they will rarely need to be overridden in +the inventory. + +## Installation Method + +Unlike `redis`, this role does not support installing from source or from Remi -- there is no +`valkey_install_from_source` flag. Valkey is always installed via `dnf` using the package(s) +in `valkey_packages`, which defaults to the native `valkey` package when `platform_release` is +defined. The current default values can be found in +`roles/valkey/vars/platform-release-.yml`, which defines entries for EL major +version `9` and Amazon Linux 2023 (`"2023"`). + +## Building Your Inventory + +To install and configure Valkey, add a `valkey_master` group and host(s) to your inventory. +The following inventory shows a basic Valkey configuration with a single Valkey node on EL9 +with authentication. + +### Example Inventory - Single Valkey Node + +```yaml +all: + children: + valkey_master: + hosts: + : + ansible_host: + vars: + platform_release: 6 +``` + +To configure a Valkey replica set, add the replica hosts to the `valkey_replica` group and +configure the `valkey_replicaof` variable. + +### Example Inventory - Configure Valkey Replication + +```yaml +all: + vars: + platform_release: 6 + children: + valkey_master: + hosts: + : + ansible_host: + + valkey_replica: + hosts: + : + ansible_host: + : + ansible_host: + vars: + valkey_replicaof: # defaults to "{{ groups['valkey_master'][0] }} {{ valkey_port}}" +``` + +To configure Sentinels, add the sentinel hosts to the `valkey_sentinel` group. + +```yaml +all: + vars: + platform_release: 6 + children: + valkey_master: + hosts: + : + ansible_host: + + valkey_replica: + hosts: + : + ansible_host: + : + ansible_host: + vars: + valkey_replicaof: # defaults to "{{ groups['valkey_master'][0] }} {{ valkey_port}}" + + valkey_sentinel: + hosts: + : + ansible_host: + : + ansible_host: + : + ansible_host: +``` + +## Running the Playbook + +To execute the Valkey role, run the `valkey` playbook: + +```bash +ansible-playbook itential.deployer.valkey -i +``` diff --git a/example_inventories/valkey/valkey_appstream.yaml b/example_inventories/valkey/valkey_appstream.yaml new file mode 100644 index 00000000..d0e3e840 --- /dev/null +++ b/example_inventories/valkey/valkey_appstream.yaml @@ -0,0 +1,21 @@ +--- +# In this example, Valkey is installed and configured using the native EL9 AppStream package. +# Unlike Redis, this role has only one install method -- there is no source-install or Remi +# option -- so there is no equivalent "from source" / "from remi repo" example inventory here. +# +# Valkey is only supported on RHEL/Rocky/AlmaLinux 9. A host on any other OS or major version +# will fail validate-vars.yml immediately. Use the redis role on EL8. +all: + vars: + # The Platform release must be defined. + # - valid values: 6, 6.0 + platform_release: 6 + + children: + valkey_master: + hosts: + valkey01.example.com: + vars: + # TLS is disabled in this example. Set valkey_tls_enabled: true and + # valkey_pki_src_dir to enable TLS. See the tls_guide.md for details. + valkey_tls_enabled: false diff --git a/playbooks/certify.yml b/playbooks/certify.yml index 2cb4b00b..28889622 100644 --- a/playbooks/certify.yml +++ b/playbooks/certify.yml @@ -5,6 +5,9 @@ - name: Certify Redis Installation import_playbook: itential.deployer.certify_redis +- name: Certify Valkey Installation + import_playbook: itential.deployer.certify_valkey + - name: Certify MongoDB Installation import_playbook: itential.deployer.certify_mongodb diff --git a/playbooks/certify_valkey.yml b/playbooks/certify_valkey.yml new file mode 100644 index 00000000..0fb18211 --- /dev/null +++ b/playbooks/certify_valkey.yml @@ -0,0 +1,25 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +# run this only for valkey_master and valkey_replica device group +- name: Run Valkey Certification Tasks + hosts: valkey_master:valkey_replica + gather_facts: true + become: true + tasks: + - name: Certify Valkey Installation # noqa run-once + ansible.builtin.import_role: + name: itential.deployer.valkey + tasks_from: certify-valkey + +# run this only for valkey_sentinel device group +- name: Run Sentinel Certification Tasks + hosts: valkey_sentinel + gather_facts: true + become: true + tasks: + - name: Certify Sentinel Installation # noqa run-once + ansible.builtin.import_role: + name: itential.deployer.valkey + tasks_from: certify-sentinel diff --git a/playbooks/download_packages_platform_site.yml b/playbooks/download_packages_platform_site.yml index 7c589c94..1698c1e5 100644 --- a/playbooks/download_packages_platform_site.yml +++ b/playbooks/download_packages_platform_site.yml @@ -4,6 +4,9 @@ - name: Download Redis packages import_playbook: itential.deployer.download_packages_redis +- name: Download Valkey packages + import_playbook: itential.deployer.download_packages_valkey + - name: Download MongoDB packages import_playbook: itential.deployer.download_packages_mongodb diff --git a/playbooks/download_packages_valkey.yml b/playbooks/download_packages_valkey.yml new file mode 100644 index 00000000..aa962159 --- /dev/null +++ b/playbooks/download_packages_valkey.yml @@ -0,0 +1,17 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Download Valkey packages + hosts: valkey + become: true + vars: + offline_install_enabled: false + roles: + - role: itential.deployer.common + - role: itential.deployer.offline + tasks: + - name: Download Valkey packages # noqa run-once + ansible.builtin.import_role: + name: itential.deployer.valkey + tasks_from: download-packages + run_once: true diff --git a/playbooks/os.yml b/playbooks/os.yml index c7eca44c..459b9538 100644 --- a/playbooks/os.yml +++ b/playbooks/os.yml @@ -3,7 +3,7 @@ --- ### OS - name: Install OS packages - hosts: platform, platform_secondary, redis, redis_secondary, mongodb, mongodb_arbiter, gateway + hosts: platform, platform_secondary, redis, redis_secondary, valkey, valkey_secondary, mongodb, mongodb_arbiter, gateway become: true roles: # Pull in the common vars diff --git a/playbooks/platform_site.yml b/playbooks/platform_site.yml index 97507eb8..297d1678 100644 --- a/playbooks/platform_site.yml +++ b/playbooks/platform_site.yml @@ -4,6 +4,9 @@ - name: Install and configure Redis import_playbook: itential.deployer.redis +- name: Install and configure Valkey + import_playbook: itential.deployer.valkey + - name: Install and configure MongoDB import_playbook: itential.deployer.mongodb diff --git a/playbooks/valkey.yml b/playbooks/valkey.yml new file mode 100644 index 00000000..69230c77 --- /dev/null +++ b/playbooks/valkey.yml @@ -0,0 +1,23 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +### Valkey +- name: Configure Valkey data nodes + hosts: valkey_master, valkey_replica + become: true + roles: + # Pull in the common vars + - role: itential.deployer.common + + # Perform a base installation of Valkey and optionally configure authorization and replication + - role: itential.deployer.valkey + +- name: Configure Valkey sentinel nodes + hosts: valkey_sentinel + become: true + roles: + # Pull in the common vars + - role: itential.deployer.common + + # Perform a base installation of Valkey and optionally configure authorization and replication + - role: itential.deployer.valkey diff --git a/playbooks/verify.yml b/playbooks/verify.yml index f22d5f8f..65edd678 100644 --- a/playbooks/verify.yml +++ b/playbooks/verify.yml @@ -5,6 +5,9 @@ - name: Verify Redis Installation import_playbook: itential.deployer.verify_redis +- name: Verify Valkey Installation + import_playbook: itential.deployer.verify_valkey + - name: Verify MongoDB Installation import_playbook: itential.deployer.verify_mongodb diff --git a/playbooks/verify_valkey.yml b/playbooks/verify_valkey.yml new file mode 100644 index 00000000..68e04394 --- /dev/null +++ b/playbooks/verify_valkey.yml @@ -0,0 +1,27 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +# run this only for valkey_master and valkey_replica device group +- name: Run Valkey Verification Tasks + hosts: valkey_master:valkey_replica + gather_facts: true + become: true + tasks: + - name: Verify Valkey Installation + ansible.builtin.import_role: + name: itential.deployer.valkey + tasks_from: verify-valkey + tags: verify_valkey + +# run this only for valkey_sentinel device group +- name: Run Sentinel Verification Tasks + hosts: valkey_sentinel + gather_facts: true + become: true + tasks: + - name: Verify Sentinel Installation + ansible.builtin.import_role: + name: itential.deployer.valkey + tasks_from: verify-sentinel + tags: verify_sentinel diff --git a/roles/valkey/CLAUDE.md b/roles/valkey/CLAUDE.md new file mode 100644 index 00000000..6fed8c96 --- /dev/null +++ b/roles/valkey/CLAUDE.md @@ -0,0 +1,145 @@ +# Role: valkey + +## Purpose + +Installs and configures Valkey and Valkey Sentinel for use with Itential Platform, as a +Remi-free, non-source-compiled alternative to `roles/redis`. Handles authentication (ACL +users), TLS, replication, Sentinel setup, and firewalld. Unlike `roles/redis`, this role has +**no source-install path and no Remi dependency** — Valkey is installed exclusively via the +native OS package repositories (the AppStream module on EL9, Amazon Linux 2023's own core +repo). + +## Supported Platforms + +**RHEL/Rocky/AlmaLinux 9, and Amazon Linux 2023.** There is no supported install path for EL8 +(no AppStream module stream exists for Valkey on EL8, and this role deliberately does not +compile from source to reach it — see "Design Decisions" below). A host in `valkey_master` / +`valkey_replica` / `valkey_sentinel` on any other OS or major version fails +`validate-vars.yml` immediately with an explicit error. Use `roles/redis` on EL8. + +Install paths are also not customizable on either platform — the Valkey RPM is not +relocatable, unlike a from-source install. Customers requiring non-standard install locations +must use `roles/redis` instead. + +## Entry Point Tasks — main.yml + +1. Validate variables (`validate-vars.yml`) and set node type facts: + `valkey_is_master_node`, `valkey_is_replica_node`, `valkey_is_sentinel_node`, + `valkey_is_data_node`, `valkey_has_replicas`, `valkey_has_sentinels`. +2. Install Valkey (triggers `Enable and Start Valkey` and `Enable and Start Valkey Sentinel` + handlers): + a. `install-common.yml` — create OS user/group + b. `install-from-repo.yml` — `dnf install valkey` (or offline RPM install) +3. Configure TLS (`configure-valkey-tls.yml` / `configure-sentinel-tls.yml`) — when + `valkey_tls_enabled: true` +4. Configure Valkey (`configure-valkey.yml`) — when `valkey_is_data_node` +5. Configure Sentinel (`configure-sentinel.yml`) — when `valkey_is_sentinel_node` +6. Flush handlers, start and assert Valkey is active (data nodes) +7. Flush handlers, start and assert Valkey Sentinel is active (sentinel nodes) + +There is no SELinux configuration step in this role at all (see "Design Decisions"). + +## Key Variables + +### valkey.yml defaults + +| Variable | Default | Purpose | +|----------|---------|---------| +| `valkey_bin_dir` | `/usr/bin` | Binary location (package install only, not overridable — see validate-vars.yml) | +| `valkey_conf_dir` | `/etc/valkey` | Config directory | +| `valkey_log_dir` | `/var/log/valkey` | Log directory | +| `valkey_data_dir` | `/var/lib/valkey` | Data directory | +| `valkey_port` | `6379` | Listen port | +| `valkey_auth_enabled` | `true` | Enable ACL user authentication | +| `valkey_tls_enabled` | `true` | Enable TLS | +| `valkey_replicaof` | `{{ groups['valkey_master'][0] }} {{ valkey_port }}` | Replication target (replica nodes) | +| `valkey_replica_priority` | `auto` | Sentinel failover priority | +| `valkey_user_admin_password` / `valkey_user_itential_password` / etc. | see file | ACL user passwords | +| `valkey_maxmemory_bytes` | `auto` | `auto` = ratio of RAM; or explicit bytes | + +### sentinel.yml, pki.yml, offline.yml defaults + +Same shape as the equivalent `roles/redis` files, `valkey_` prefixed. + +### install.yml defaults / vars/platform-release-6.yml + +There is no `valkey_install_from_source` variable — installation is always via package. The +only EL major version keys present in `valkey_packages_default` are `"9"` and `"2023"` (both +value `["valkey"]`, the package name on both platforms). Looking this dict up for any other +major version does not happen because `validate-vars.yml` already asserts one of those two +first. + +### vars/main.yml + +`valkey_required_repositories` has a **single entry**: the Rocky/AlmaLinux AppStream mirror +(`mirrors.rockylinux.org`). Unlike `roles/redis` there is no third-party repository (Remi, +EPEL, upstream source) to check. This one entry is a best-effort connectivity check — it does +not distinguish RHEL (which resolves AppStream through its own subscription-manager CDN, not a +fixed public URL) or Amazon Linux 2023 (which ships Valkey in its own preconfigured core repo) +from Rocky/Alma; on those platforms the check still runs but isn't actually verifying the repo +that host will use. + +## Design Decisions + +These are deliberate departures from a 1:1 mirror of `roles/redis`, decided during scoping: + +- **No source install, ever.** `roles/redis` defaults to compiling from source + (`redis_install_from_source: true`). This role never does — `install-from-source.yml`, + `install-remi-repo.yml`, `valkey_build_packages`, and the Remi/EPEL repo URL vars do not + exist in this role at all. +- **No Remi.** Package installs always come from the native OS package repositories, never Remi. +- **EL8 is explicitly unsupported**, not silently skipped. No EPEL8 fallback (even though + EPEL8 does carry a Valkey package) and no source-compile fallback. A host on EL8 fails hard + in `validate-vars.yml`. +- **Amazon Linux 2023 is supported alongside EL9** — confirmed AL2023 ships `valkey` natively + via its own core repo (no module-stream concept like RHEL's AppStream). Both major version + keys (`"9"`, `"2023"`) map to the same `["valkey"]` package list in + `vars/platform-release-6.yml`. +- **Not relocatable.** The Valkey RPM has no `Prefix:` tag, so unlike `roles/redis`'s + from-source path there is no way to install to a non-default location on either supported + platform. `validate-vars.yml`'s directory-override assert (see above) is a hard requirement, + not just this role's own preference. +- **Version is whatever the OS's own package repository currently resolves to** (8.0.7 on EL9 + AppStream as of this writing) — not a specific upstream tag pinned via source tarball, unlike + `redis_source_url`. +- **No role-level SELinux configuration.** Confirmed via the upstream + `fedora-selinux/selinux-policy` `redis.fc` file: it already equivalences standard Valkey + paths (`/usr/bin/valkey-server`, `/etc/valkey`, `/var/lib/valkey`, `/var/log/valkey`, + `/run/valkey`) onto the same `redis_exec_t`/`redis_conf_t`/`redis_log_t`/`redis_var_lib_t`/ + `redis_var_run_t` types Redis uses. Since this role only ever installs to standard paths via + the AppStream package, SELinux labeling is handled entirely by the base OS policy with zero + extra role tasks — no equivalent of `roles/redis/tasks/configure-selinux.yml` or + `itential_redis_sentinel.te` exists here. If a future change introduces a non-default + `valkey_bin_dir` or a source-install path, this decision needs revisiting. +- **No `install-common.yml` directory-creation tasks.** The AppStream package's own `%files` + already creates `/etc/valkey`, `/var/lib/valkey`, `/var/log/valkey` with correct ownership + and SELinux context — this role does not recreate them (this mirrors how `roles/redis` + already skips its own directory-creation tasks when installing from a package instead of + source; here that's the *only* path, so the tasks were removed rather than left as + permanently-`false` conditionals). + +## Templates + +Same set as `roles/redis`, renamed (`valkey.conf.j2`, `sentinel.conf.j2`, `valkey.service.j2`, +`valkey-sentinel.service.j2`, `valkey.logrotate.j2`, `valkey-sentinel.logrotate.j2`, +`valkey-validation-report.md.j2`). Config directive syntax is unchanged from Redis's — Valkey +is protocol- and config-compatible — only comments and variable names were updated. + +## Inventory Groups + +| Group | Role | +|-------|------| +| `valkey_master` | Primary data node (EL9 or Amazon Linux 2023 only) | +| `valkey_replica` | Secondary data nodes (EL9 or Amazon Linux 2023 only) | +| `valkey_sentinel` | Sentinel nodes (EL9 or Amazon Linux 2023 only) | + +## Not Yet Done + +- Root playbooks (`valkey.yml`, `verify_valkey.yml`, `certify_valkey.yml`, + `download_packages_valkey.yml`) and their unconditional imports into `platform_site.yml` / + `verify.yml` / `certify.yml` / `download_packages_platform_site.yml`. +- New example inventories under `example_inventories/valkey/`. +- `docs/valkey_guide.md`. +- End-to-end verification in the PE lab (package install, TLS, Sentinel failover, SELinux + enforcing mode, Platform connectivity) — nothing in this role has been run against a real + host yet. diff --git a/roles/valkey/README.md b/roles/valkey/README.md new file mode 100644 index 00000000..e69de29b diff --git a/roles/valkey/defaults/main/offline.yml b/roles/valkey/defaults/main/offline.yml new file mode 100644 index 00000000..891ce45d --- /dev/null +++ b/roles/valkey/defaults/main/offline.yml @@ -0,0 +1,15 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# Base directories +valkey_offline_packages_root: "{{ offline_itential_packages_path }}/{{ platform_release }}/valkey" +valkey_offline_target_node_root: "{{ offline_target_node_root }}/{{ valkey_offline_packages_root }}" +valkey_offline_control_node_root: "{{ offline_control_node_root }}/{{ valkey_offline_packages_root }}" + +# Target node download directories +valkey_offline_target_node_rpms_dir: "{{ valkey_offline_target_node_root }}/rpms" +valkey_offline_target_node_archives_dir: "{{ valkey_offline_target_node_root }}/archives" + +# Control node download directories +valkey_offline_control_node_rpms_dir: "{{ valkey_offline_control_node_root }}/rpms" +valkey_offline_control_node_archives_dir: "{{ valkey_offline_control_node_root }}/archives" diff --git a/roles/valkey/defaults/main/pki.yml b/roles/valkey/defaults/main/pki.yml new file mode 100644 index 00000000..b7f8db34 --- /dev/null +++ b/roles/valkey/defaults/main/pki.yml @@ -0,0 +1,89 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# ============================================================================ +# Valkey PKI Configuration - All components customizable +# ============================================================================ + +# Base PKI directory - override to use different root location +valkey_pki_base_dir: /etc/pki/valkey + +# Subdirectory names - customize the layout +valkey_pki_private_subdir: private + +# Derived subdirectory paths - built from base + subdir name +valkey_pki_private_dir: "{{ valkey_pki_base_dir }}/{{ valkey_pki_private_subdir }}" + +# ============================================================================ +# Certificate and Key Filenames - Customize naming +# ============================================================================ + +# Valkey server certificate filename +valkey_tls_cert_file: "{{ inventory_hostname }}.crt" + +# Valkey server private key filename +valkey_tls_key_file: "{{ inventory_hostname }}.key" + +# Valkey CA certificate filename +valkey_tls_ca_file: ca-bundle.crt + +# Valkey Sentinel certificate filename +valkey_sentinel_tls_cert_file: "{{ inventory_hostname }}.crt" + +# Valkey Sentinel private key filename +valkey_sentinel_tls_key_file: "{{ inventory_hostname }}.key" + +# ============================================================================ +# Source Directory - Define in inventory +# ============================================================================ + +# Source directory for certificate files (on Ansible controller) +valkey_pki_src_dir: "" + +# ============================================================================ +# Source File Paths - Built from source directory + filename +# ============================================================================ + +# Valkey server certificate source path +valkey_tls_cert_src: "{{ valkey_pki_src_dir }}/{{ valkey_tls_cert_file }}" + +# Valkey server private key source path +valkey_tls_key_src: "{{ valkey_pki_src_dir }}/{{ valkey_tls_key_file }}" + +# Valkey CA certificate source path +valkey_tls_ca_src: "{{ valkey_pki_src_dir }}/{{ valkey_tls_ca_file }}" + +# Sentinel certificate source path +valkey_sentinel_tls_cert_src: "{{ valkey_pki_src_dir }}/{{ valkey_sentinel_tls_cert_file }}" + +# Sentinel private key source path +valkey_sentinel_tls_key_src: "{{ valkey_pki_src_dir }}/{{ valkey_sentinel_tls_key_file }}" + +# ============================================================================ +# Destination File Paths - Built from destination directory + filename +# ============================================================================ + +# Valkey server certificate destination path +valkey_tls_cert_dest: "{{ valkey_pki_base_dir }}/{{ valkey_tls_cert_file }}" + +# Valkey server private key destination path +valkey_tls_key_dest: "{{ valkey_pki_private_dir }}/{{ valkey_tls_key_file }}" + +# Valkey CA certificate destination path +valkey_tls_ca_dest: "{{ valkey_pki_base_dir }}/{{ valkey_tls_ca_file }}" + +# Sentinel certificate destination path +valkey_sentinel_tls_cert_dest: "{{ valkey_pki_base_dir }}/{{ valkey_sentinel_tls_cert_file }}" + +# Sentinel private key destination path +valkey_sentinel_tls_key_dest: "{{ valkey_pki_private_dir }}/{{ valkey_sentinel_tls_key_file }}" + +# ============================================================================ +# File Ownership - Customize per environment +# ============================================================================ + +# Owner for PKI directories and files +valkey_pki_owner: valkey + +# Group for PKI directories and files +valkey_pki_group: valkey diff --git a/roles/valkey/defaults/main/sentinel.yml b/roles/valkey/defaults/main/sentinel.yml new file mode 100644 index 00000000..c635f60a --- /dev/null +++ b/roles/valkey/defaults/main/sentinel.yml @@ -0,0 +1,27 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# The location of the Valkey Sentinel config file +valkey_sentinel_conf_file: "{{ valkey_conf_dir }}/sentinel.conf" + +# The location of the Valkey Sentinel log file +valkey_sentinel_log: "{{ valkey_log_dir }}/sentinel.log" + +# The Valkey Sentinel master name +valkey_sentinel_master_name: itentialmaster + +# The default valkey sentinel listen port +valkey_sentinel_port: "{{ valkey_sentinel_port_default }}" + +# Bind to localhost + private network interface. +# ansible_default_ipv4.address is not guaranteed to be present (e.g. hosts +# with no default route), so fall back to an empty string when undefined. +valkey_sentinel_bind: "127.0.0.1 {{ ansible_default_ipv4.address | default('') }}" + +# Auto-calculate quorum based on sentinel count (recommended) +# Set to explicit number to override (must be <= number of sentinels) +valkey_sentinel_quorum: auto + +# Default location for the certification report files +valkey_sentinel_certify_report_dir_remote: /var/tmp/itential-reports/sentinel +valkey_sentinel_certify_report_dir_local: /tmp/itential-reports/sentinel diff --git a/roles/valkey/defaults/main/valkey.yml b/roles/valkey/defaults/main/valkey.yml new file mode 100644 index 00000000..c39d4543 --- /dev/null +++ b/roles/valkey/defaults/main/valkey.yml @@ -0,0 +1,78 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# The location of the Valkey binary +valkey_bin_dir: "{{ valkey_bin_dir_default }}" + +# The location of the Valkey config file +valkey_conf_dir: "{{ valkey_conf_dir_default }}" +valkey_conf_file: "{{ valkey_conf_dir }}/valkey.conf" + +# The location of the Valkey log file +valkey_log_dir: "{{ valkey_log_dir_default }}" +valkey_log: "{{ valkey_log_dir }}/valkey.log" + +# The name of the Valkey data file +valkey_db_filename: dump.rdb + +# The location of the Valkey data directory +valkey_data_dir: "{{ valkey_data_dir_default }}" + +# Valkey user and group +valkey_owner: valkey +valkey_group: valkey + +# Default valkey port +valkey_port: "{{ valkey_port_default }}" + +# Bind to localhost + private network interface. +# ansible_default_ipv4.address is not guaranteed to be present (e.g. hosts +# with no default route), so fall back to an empty string when undefined. +valkey_bind: "127.0.0.1 {{ ansible_default_ipv4.address | default('') }}" + +# Feature flags that can be overridden in the hosts file +# Essentially, a default installation will have auth, but not tls +valkey_auth_enabled: true +valkey_tls_enabled: true + +# Replication settings +valkey_replicaof: "{{ groups['valkey_master'][0] }} {{ valkey_port }}" + +# Valkey replica priority for Sentinel failover +# Lower values = higher priority (more likely to be promoted) +# Set to 'auto' to calculate based on position, or specify explicit value (0-100) +# 0 = never promote this replica +valkey_replica_priority: auto + +# Default valkey user passwords +# These are meant to be changed by the customer. By default they are meant to +# be predictable and simple. +valkey_user_admin_password: admin +valkey_user_itential_password: itential +valkey_user_repluser_password: repluser +valkey_user_sentineladmin_password: admin +valkey_user_sentineluser_password: sentineluser +valkey_user_monitor_password: monitor + +# By default the monitor user will not be created. If set to true, the monitor user will be +# created with the appropriate ACL to allow monitoring systems to gather metric data. +valkey_monitor_user_enabled: false + +# Valkey TLS configuration options +valkey_tls_port: "{{ valkey_tls_port_default }}" +valkey_tls_auth_clients: "no" +valkey_tls_protocols: "TLSv1.3" + +# Valkey memory sizing defaults (dedicated Valkey node) + +# If set to "auto", maxmemory is calculated from system RAM. +# If set to a number (bytes), that value is used verbatim. +valkey_maxmemory_bytes: auto + +# Used only when valkey_maxmemory_bytes == "auto" +valkey_maxmemory_ratio: 0.80 +valkey_maxmemory_min_mb: 512 + +# Default location for the certification report files +valkey_certify_report_dir_remote: /var/tmp/itential-reports/valkey +valkey_certify_report_dir_local: /tmp/itential-reports/valkey diff --git a/roles/valkey/handlers/main.yml b/roles/valkey/handlers/main.yml new file mode 100644 index 00000000..52c354b3 --- /dev/null +++ b/roles/valkey/handlers/main.yml @@ -0,0 +1,25 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Enable and Start Valkey + listen: restart valkey + throttle: 1 + ansible.builtin.systemd: + name: valkey + enabled: true + state: restarted + daemon_reload: true + when: valkey_is_data_node + +- name: Enable and Start Valkey Sentinel + throttle: 1 + ansible.builtin.systemd: + name: valkey-sentinel + enabled: true + state: restarted + daemon_reload: true + when: valkey_is_sentinel_node + +- name: Update Itential release file + ansible.builtin.include_tasks: + file: update-release-file.yml diff --git a/roles/valkey/tasks/certify-sentinel.yml b/roles/valkey/tasks/certify-sentinel.yml new file mode 100644 index 00000000..e0af8bde --- /dev/null +++ b/roles/valkey/tasks/certify-sentinel.yml @@ -0,0 +1,378 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +- name: Ensure report directory exists + ansible.builtin.file: + path: "{{ valkey_sentinel_certify_report_dir_remote }}" + state: directory + owner: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + mode: "0755" + +- name: Set report filename + ansible.builtin.set_fact: + valkey_sentinel_certify_report_file: "{{ valkey_sentinel_certify_report_dir_remote }}/sentinel-report-{{ inventory_hostname }}.md" + +- name: Gather host information + itential.deployer.gather_host_information: + register: host_details + +- name: Check if Sentinel service exists + ansible.builtin.systemd: + name: valkey-sentinel + register: sentinel_service_check + failed_when: false + changed_when: false + +- name: Check Sentinel process + ansible.builtin.shell: set -o pipefail && ps aux | grep valkey-sentinel | grep -v grep + register: sentinel_process + failed_when: false + changed_when: false + +- name: Test Sentinel connectivity + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + PING + register: sentinel_ping + failed_when: false + changed_when: false + +- name: Set Sentinel detection fact + ansible.builtin.set_fact: + sentinel_is_running: "{{ sentinel_ping.rc == 0 and sentinel_process.rc == 0 }}" + +- name: Display Sentinel detection status + ansible.builtin.debug: + msg: "Sentinel detected: {{ sentinel_is_running }}" + +- name: Get Sentinel service status + ansible.builtin.systemd: + name: valkey-sentinel + register: sentinel_service_status + when: + - sentinel_is_running | bool + - sentinel_service_check.status is defined + failed_when: false + +- name: Get Sentinel INFO + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + INFO + register: sentinel_info + when: sentinel_is_running | bool + changed_when: false + +- name: Get Sentinel masters + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + SENTINEL MASTERS + register: sentinel_masters + when: sentinel_is_running | bool + changed_when: false + +- name: Capture itentialmaster + ansible.builtin.set_fact: + itential_master: "{{ (sentinel_masters.stdout | from_json)[0] }}" + when: sentinel_is_running | bool + +- name: Get details for each monitored master + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + SENTINEL MASTER {{ itential_master.name }} + register: monitored_master + when: sentinel_is_running | bool + changed_when: false + +- name: Capture monitored master details + ansible.builtin.set_fact: + monitored_master_details: "{{ (monitored_master.stdout | from_json) }}" + when: sentinel_is_running | bool + +- name: Get known sentinels for each master + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + SENTINEL SENTINELS {{ itential_master.name }} + register: known_sentinels + when: sentinel_is_running | bool + failed_when: false + changed_when: false + +- name: Capture known sentinel details + ansible.builtin.set_fact: + known_sentinel_details: "{{ (known_sentinels.stdout | from_json) }}" + when: sentinel_is_running | bool + +- name: Get known replicas for each master + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + SENTINEL REPLICAS {{ itential_master.name }} + register: known_replicas + when: sentinel_is_running | bool + failed_when: false + changed_when: false + +- name: Capture known replica details + ansible.builtin.set_fact: + known_replica_details: "{{ (known_replicas.stdout | from_json) }}" + when: sentinel_is_running | bool + +- name: Check master status + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + SENTINEL CKQUORUM {{ itential_master.name }} + register: quorum_check + when: sentinel_is_running | bool + failed_when: false + changed_when: false + +- name: Capture known replica details + ansible.builtin.set_fact: + quorum_check_details: "{{ (quorum_check.stdout | from_json) }}" + when: sentinel_is_running | bool + +- name: Get Sentinel configuration + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + CONFIG GET '*' + register: sentinel_config + when: sentinel_is_running | bool + failed_when: false + changed_when: false + +- name: Check Sentinel configuration file + ansible.builtin.stat: + path: /etc/valkey/sentinel.conf + register: sentinel_conf_file + when: sentinel_is_running | bool + +- name: Get Sentinel configuration file permissions + ansible.builtin.shell: set -o pipefail && ls -lh /etc/valkey/sentinel.conf + register: sentinel_conf_permissions + when: + - sentinel_is_running | bool + - sentinel_conf_file.stat.exists | default(false) + changed_when: false + +- name: Check if Sentinel is using systemd + ansible.builtin.stat: + path: /usr/lib/systemd/system/valkey-sentinel.service + register: sentinel_systemd_file + when: sentinel_is_running | bool + +- name: Get Sentinel listening ports + ansible.builtin.shell: | + set -o pipefail && netstat -tlnp | grep sentinel | ss -tlnp | grep sentinel + register: valkey_sentinel_ports + when: sentinel_is_running | bool + failed_when: false + changed_when: false + +- name: Check Sentinel log file + ansible.builtin.shell: | + set -o pipefail && + if [ -f /var/log/valkey/sentinel.log ]; then + tail -50 /var/log/valkey/sentinel.log + else + echo "Log file not found in standard location" + fi + register: sentinel_logs + when: sentinel_is_running | bool + changed_when: false + +# For unknown reasons there are control characters (^M) at the end of the +# SENTINEL INFO values. This task will remove those characters. +- name: Remove control characters from output + ansible.builtin.set_fact: + sentinel_info_clean: "{{ sentinel_info.stdout | regex_replace('\\r', '') }}" + when: + - sentinel_is_running | bool + - sentinel_info.rc is defined + - sentinel_info.rc == 0 + +- name: Parse Sentinel INFO for key metrics + ansible.builtin.set_fact: + sentinel_metrics: + version: "{{ sentinel_info_clean | regex_search('valkey_version:(.+)', '\\1') }}" + mode: "{{ sentinel_info_clean | regex_search('valkey_mode:(.+)', '\\1') }}" + masters: "{{ sentinel_info_clean | regex_search('sentinel_masters:(.+)', '\\1') }}" + when: + - sentinel_is_running | bool + - sentinel_info.rc is defined + - sentinel_info.rc == 0 + +# ========================================================================= +# Confirm all expected Sentinel users +# ========================================================================= +- name: Get list of configured Sentinel users + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --json \ + --user admin \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineladmin_password }}" \ + --no-auth-warning \ + ACL LIST + when: + - sentinel_is_running | bool + - sentinel_info.rc is defined + - sentinel_info.rc == 0 + register: sentinel_acl_list + no_log: true + failed_when: false + changed_when: false + +- name: Parse Sentinel ACL list into structured format + ansible.builtin.set_fact: + sentinel_users: >- + {%- set result = [] -%} + {%- for acl_entry in (sentinel_acl_list.stdout | from_json) -%} + {%- set parts = acl_entry.split() -%} + {%- if parts | length >= 3 and parts[0] == 'user' -%} + {%- set user_obj = {'user': parts[1], 'enabled': (parts[2] == 'on')} -%} + {%- set _ = result.append(user_obj) -%} + {%- endif -%} + {%- endfor -%} + {{ result }} + when: + - sentinel_is_running | bool + - sentinel_acl_list.rc is defined + - sentinel_acl_list.rc == 0 + +- name: Verify the Sentinel user can login (not admin) + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --user sentineluser \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_sentineluser_password }}" \ + --no-auth-warning \ + PING + register: sentinel_user_ping + no_log: true + failed_when: false + changed_when: false + when: + - sentinel_is_running | bool + - sentinel_acl_list.rc is defined + - sentinel_acl_list.rc == 0 + +- name: Confirm "monitor" user login (Sentinel) + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %} \ + --user monitor \ + -p {{ valkey_sentinel_port }} \ + -h "{{ inventory_hostname }}" \ + -a "{{ valkey_user_monitor_password }}" \ + --no-auth-warning \ + PING + register: sentinel_monitor_user_ping + failed_when: false + changed_when: false + when: + - valkey_monitor_user_enabled | bool + - valkey_user_monitor_password is truthy + - sentinel_is_running | bool + +# ========================================================================= +# Generate the report and copy to control node +# ========================================================================= +- name: Generate validation report + ansible.builtin.template: + backup: true + dest: "{{ valkey_sentinel_certify_report_file }}" + group: "{{ valkey_group }}" + mode: "0665" + owner: "{{ valkey_owner }}" + src: valkey-validation-report.md.j2 + when: + - sentinel_is_running | bool + +- name: Copy validation report to the control node + ansible.builtin.fetch: + dest: "{{ valkey_sentinel_certify_report_dir_local }}/" + fail_on_missing: false + flat: true + src: "{{ valkey_sentinel_certify_report_file }}" + when: + - sentinel_is_running | bool + +- name: Display report summary + ansible.builtin.debug: + msg: + - "Valkey validation complete for {{ inventory_hostname }}" + - "Overall Status: {{ 'PASSED ✓' if (sentinel_ping.rc == 0 and sentinel_process.rc == 0) else 'FAILED ✗' }}" + - "Report saved to: {{ valkey_sentinel_certify_report_file }} on both the remote and control nodes." + when: + - sentinel_is_running | bool diff --git a/roles/valkey/tasks/certify-valkey.yml b/roles/valkey/tasks/certify-valkey.yml new file mode 100644 index 00000000..73333969 --- /dev/null +++ b/roles/valkey/tasks/certify-valkey.yml @@ -0,0 +1,437 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +- name: Ensure report directory exists + ansible.builtin.file: + path: "{{ valkey_certify_report_dir_remote }}" + state: directory + owner: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + mode: "0755" + +- name: Set report filename + ansible.builtin.set_fact: + valkey_certify_report_file: "{{ valkey_certify_report_dir_remote }}/valkey-report-{{ inventory_hostname }}.md" + +- name: Gather host information + itential.deployer.gather_host_information: + register: host_details + +- name: Check if Valkey service exists + ansible.builtin.systemd: + name: valkey + register: valkey_service_check + failed_when: false + changed_when: false + +- name: Get Valkey service status + ansible.builtin.systemd: + name: valkey + register: valkey_service_status + when: valkey_service_check.status is defined + +- name: Check Valkey process + ansible.builtin.shell: set -o pipefail && ps aux | grep valkey-server | grep -v grep + register: valkey_process + failed_when: false + changed_when: false + +- name: Set Valkey CLI TLS arguments + ansible.builtin.set_fact: + valkey_cli_tls_args: "{% if valkey_tls_enabled | bool %}--tls --cacert {{ valkey_tls_ca_dest }}{% endif %}" + +- name: Set topology facts + ansible.builtin.set_fact: + valkey_has_replicas: "{{ groups['valkey_replica'] is defined and groups['valkey_replica'] | length > 0 }}" + valkey_has_sentinels: "{{ groups['valkey_sentinel'] is defined and groups['valkey_sentinel'] | length > 0 }}" + +- name: Test Valkey connectivity + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user admin \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_admin_password }}" \ + --no-auth-warning \ + PING + register: valkey_ping + failed_when: false + changed_when: false + +- name: Get Valkey version + ansible.builtin.shell: | + set -o pipefail && \ + {{ valkey_bin_dir }}/valkey-server --version + register: valkey_version + changed_when: false + +- name: Get Valkey INFO + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user admin \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_admin_password }}" \ + --no-auth-warning \ + INFO + register: valkey_info + when: valkey_ping.rc == 0 + failed_when: false + changed_when: false + +- name: Get Valkey configuration + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --json \ + --user admin \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_admin_password }}" \ + --no-auth-warning \ + CONFIG GET '*' + register: valkey_config + when: valkey_ping.rc == 0 + failed_when: false + changed_when: false + +- name: Check Valkey configuration file + ansible.builtin.stat: + path: /etc/valkey/valkey.conf + register: valkey_conf_file + +- name: Get Valkey configuration file permissions + ansible.builtin.shell: set -o pipefail && ls -lh /etc/valkey/valkey.conf + register: valkey_conf_permissions + when: valkey_conf_file.stat.exists + changed_when: false + +- name: Check if Valkey is using systemd + ansible.builtin.stat: + path: /usr/lib/systemd/system/valkey.service + register: valkey_systemd_file + +- name: Get listening ports + ansible.builtin.shell: set -o pipefail && netstat -tlnp | grep valkey | ss -tlnp | grep valkey + register: valkey_ports + failed_when: false + changed_when: false + +- name: Check Valkey log file + ansible.builtin.shell: | + set -o pipefail && + if [ -f /var/log/valkey/valkey.log ]; then + tail -50 /var/log/valkey/valkey.log + else + echo "Log file not found in standard location" + fi + register: valkey_logs + changed_when: false + +- name: Parse Valkey INFO for key metrics + ansible.builtin.set_fact: + valkey_metrics: + version: "{{ valkey_info.stdout | regex_search('valkey_version:([^\\r\\n]+)', '\\1') }}" + os: "{{ valkey_info.stdout | regex_search('os:([^\\r\\n]+)', '\\1') }}" + executable: "{{ valkey_info.stdout | regex_search('executable:([^\\r\\n]+)', '\\1') }}" + config_file: "{{ valkey_info.stdout | regex_search('config_file:([^\\r\\n]+)', '\\1') }}" + port: "{{ valkey_info.stdout | regex_search('tcp_port:([^\\r\\n]+)', '\\1') }}" + role: "{{ valkey_info.stdout | regex_search('role:([^\\r\\n]+)', '\\1') }}" + mode: "{{ valkey_info.stdout | regex_search('valkey_mode:([^\\r\\n]+)', '\\1') }}" + slaves: "{{ valkey_info.stdout | regex_search('connected_slaves:([^\\r\\n]+)', '\\1') }}" + master_host: "{{ valkey_info.stdout | regex_search('master_host:([^\\r\\n]+)', '\\1') }}" + master_port: "{{ valkey_info.stdout | regex_search('master_port:([^\\r\\n]+)', '\\1') }}" + master_link: "{{ valkey_info.stdout | regex_search('master_link_status:([^\\r\\n]+)', '\\1') }}" + clients: "{{ valkey_info.stdout | regex_search('connected_clients:([^\\r\\n]+)', '\\1') }}" + bind_address: "{{ valkey_config.results[2].stdout_lines[1] | default(['0.0.0.0'], true) }}" + users: "{{ valkey_config.results[0].stdout_lines | default(['N/A'], true) }}" + when: + - valkey_info.rc is defined + - valkey_info.rc == 0 + +- name: Get list of configured Valkey users + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --json \ + --user admin \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_admin_password }}" \ + --no-auth-warning \ + ACL LIST + when: + - valkey_info.rc is defined + - valkey_info.rc == 0 + register: valkey_acl_list + no_log: false + failed_when: false + changed_when: false + +- name: Parse Valkey ACL list into structured format + ansible.builtin.set_fact: + valkey_users: >- + {%- set result = [] -%} + {%- for acl_entry in (valkey_acl_list.stdout | from_json) -%} + {%- set parts = acl_entry.split() -%} + {%- if parts | length >= 3 and parts[0] == 'user' -%} + {%- set user_obj = {'user': parts[1], 'enabled': (parts[2] == 'on')} -%} + {%- set _ = result.append(user_obj) -%} + {%- endif -%} + {%- endfor -%} + {{ result }} + when: valkey_info.rc is defined and valkey_info.rc == 0 + +- name: Confirm "itential" user login + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user itential \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_itential_password }}" \ + --no-auth-warning \ + PING + register: valkey_itential_user_ping + failed_when: false + changed_when: false + +- name: Confirm "repluser" user login + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user repluser \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_repluser_password }}" \ + --no-auth-warning \ + PING + register: valkey_repl_user_ping + failed_when: false + changed_when: false + when: valkey_has_replicas | bool + +- name: Confirm "sentineluser" user login + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user sentineluser \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_sentineluser_password }}" \ + --no-auth-warning \ + PING + register: valkey_sentineluser_user_ping + failed_when: false + changed_when: false + when: valkey_has_sentinels | bool + +- name: Confirm "monitor" user login (Valkey) + ansible.builtin.shell: | + set -o pipefail && + {{ valkey_bin_dir }}/valkey-cli \ + {{ valkey_cli_tls_args }} \ + --user monitor \ + -p {{ valkey_port }} \ + -a "{{ valkey_user_monitor_password }}" \ + --no-auth-warning \ + PING + register: valkey_monitor_user_ping + failed_when: false + changed_when: false + when: + - valkey_monitor_user_enabled | bool + - valkey_user_monitor_password is truthy + +# ========================================================================= +# TLS/SSL CHECKS +# ========================================================================= + +- name: Check TLS server certificate file exists + ansible.builtin.stat: + path: "{{ valkey_tls_cert_dest }}" + register: valkey_tls_cert_stat + when: valkey_tls_enabled | bool + +- name: Check TLS private key file exists + ansible.builtin.stat: + path: "{{ valkey_tls_key_dest }}" + register: valkey_tls_key_stat + when: valkey_tls_enabled | bool + +- name: Check TLS CA certificate file exists + ansible.builtin.stat: + path: "{{ valkey_tls_ca_dest }}" + register: valkey_tls_ca_stat + when: valkey_tls_enabled | bool + +- name: Get TLS server certificate dates + ansible.builtin.shell: | + openssl x509 -in {{ valkey_tls_cert_dest }} -noout -dates + register: valkey_tls_cert_dates + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + +- name: Check TLS server certificate 30-day expiry + ansible.builtin.shell: | + openssl x509 -in {{ valkey_tls_cert_dest }} -noout -checkend 2592000 + register: valkey_tls_cert_expiry_check + ignore_errors: true + changed_when: false + failed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + +- name: Get TLS server certificate subject and issuer + ansible.builtin.shell: | + openssl x509 -in {{ valkey_tls_cert_dest }} -noout -subject -issuer + register: valkey_tls_cert_subject_issuer + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + +- name: Get TLS server certificate SANs + ansible.builtin.shell: > + openssl x509 -noout -ext subjectAltName + -in {{ valkey_tls_cert_dest }} 2>/dev/null || echo "No SANs found" + register: valkey_tls_cert_sans + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + +- name: Check if inventory_hostname is in certificate SANs + ansible.builtin.set_fact: + valkey_tls_san_hostname_match: >- + {{ (inventory_hostname | default('')) in + ((valkey_tls_cert_sans | default({})).stdout | default('')) }} + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_sans is defined + - valkey_tls_cert_sans.stdout is defined + - valkey_tls_cert_sans.stdout != '' + +- name: Check if ansible_host is in certificate SANs + ansible.builtin.set_fact: + valkey_tls_san_ip_match: >- + {{ (ansible_host | default('')) in + ((valkey_tls_cert_sans | default({})).stdout | default('')) }} + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_sans is defined + - valkey_tls_cert_sans.stdout is defined + - valkey_tls_cert_sans.stdout != '' + - ansible_host is defined + - ansible_host != inventory_hostname + +- name: Get TLS CA certificate dates + ansible.builtin.shell: | + openssl x509 -in {{ valkey_tls_ca_dest }} -noout -dates + register: valkey_tls_ca_dates + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_ca_stat.stat.exists | default(false) + +- name: Check TLS CA certificate 30-day expiry + ansible.builtin.shell: | + openssl x509 -in {{ valkey_tls_ca_dest }} -noout -checkend 2592000 + register: valkey_tls_ca_expiry_check + ignore_errors: true + changed_when: false + failed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_ca_stat.stat.exists | default(false) + +- name: Get TLS certificate public key fingerprint + ansible.builtin.shell: openssl x509 -pubkey -noout -in {{ valkey_tls_cert_dest }} | openssl md5 + register: valkey_tls_cert_pubkey_md5 + ignore_errors: true + changed_when: false + no_log: true + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + +- name: Get TLS private key public key fingerprint + ansible.builtin.shell: openssl pkey -pubout -in {{ valkey_tls_key_dest }} | openssl md5 + register: valkey_tls_key_pubkey_md5 + ignore_errors: true + changed_when: false + no_log: true + when: + - valkey_tls_enabled | bool + - valkey_tls_key_stat.stat.exists | default(false) + +- name: Determine TLS cert-key pair match + ansible.builtin.set_fact: + valkey_tls_cert_key_match: >- + {{ valkey_tls_cert_pubkey_md5.stdout == valkey_tls_key_pubkey_md5.stdout }} + when: + - valkey_tls_cert_pubkey_md5 is defined + - valkey_tls_cert_pubkey_md5.rc | default(1) == 0 + - valkey_tls_key_pubkey_md5 is defined + - valkey_tls_key_pubkey_md5.rc | default(1) == 0 + +- name: Validate TLS certificate chain + ansible.builtin.shell: > + openssl verify -CAfile {{ valkey_tls_ca_dest }} {{ valkey_tls_cert_dest }} + register: valkey_tls_chain_valid + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_cert_stat.stat.exists | default(false) + - valkey_tls_ca_stat.stat.exists | default(false) + +- name: Perform live Valkey TLS handshake test + ansible.builtin.shell: > + echo | openssl s_client + -connect {{ inventory_hostname }}:{{ valkey_port }} + -CAfile {{ valkey_tls_ca_dest }} + -servername {{ inventory_hostname }} 2>&1 | + grep -E "Verify return code|subject=|issuer=" + register: valkey_tls_handshake + ignore_errors: true + changed_when: false + when: + - valkey_tls_enabled | bool + - valkey_tls_ca_stat.stat.exists | default(false) + +# ========================================================================= +# Generate the report and copy to control node +# ========================================================================= +- name: Generate validation report + ansible.builtin.template: + backup: true + dest: "{{ valkey_certify_report_file }}" + group: "{{ valkey_group }}" + mode: "0665" + owner: "{{ valkey_owner }}" + src: valkey-validation-report.md.j2 + +- name: Copy validation report to the control node + ansible.builtin.fetch: + dest: "{{ valkey_certify_report_dir_local }}/" + fail_on_missing: false + flat: true + src: "{{ valkey_certify_report_file }}" + +- name: Display report summary + ansible.builtin.debug: + msg: + - "Valkey validation complete for {{ inventory_hostname }}" + - "Overall Status: {{ 'PASSED ✓' if (valkey_ping.rc == 0 and valkey_process.rc == 0) else 'FAILED ✗' }}" + - "Report saved to: {{ valkey_certify_report_file }} on both the remote and control nodes." diff --git a/roles/valkey/tasks/configure-sentinel-tls.yml b/roles/valkey/tasks/configure-sentinel-tls.yml new file mode 100644 index 00000000..628b139d --- /dev/null +++ b/roles/valkey/tasks/configure-sentinel-tls.yml @@ -0,0 +1,68 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Create Valkey PKI base directory + ansible.builtin.file: + path: "{{ valkey_pki_base_dir }}" + state: directory + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0750" + tags: + - valkey + - valkey_certificates + - certificates + +- name: Create Valkey private directory + ansible.builtin.file: + path: "{{ valkey_pki_private_dir }}" + state: directory + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0700" + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy Sentinel TLS certificate + ansible.builtin.copy: + src: "{{ valkey_sentinel_tls_cert_src }}" + dest: "{{ valkey_sentinel_tls_cert_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0644" + when: valkey_sentinel_tls_cert_src | length > 0 + notify: Enable and Start Valkey Sentinel + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy Sentinel TLS private key + ansible.builtin.copy: + src: "{{ valkey_sentinel_tls_key_src }}" + dest: "{{ valkey_sentinel_tls_key_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0600" + when: valkey_sentinel_tls_key_src | length > 0 + notify: Enable and Start Valkey Sentinel + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy CA bundle for Sentinel + ansible.builtin.copy: + src: "{{ valkey_tls_ca_src }}" + dest: "{{ valkey_tls_ca_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0644" + when: valkey_tls_ca_src | length > 0 + notify: Enable and Start Valkey Sentinel + tags: + - valkey + - valkey_certificates + - certificates diff --git a/roles/valkey/tasks/configure-sentinel.yml b/roles/valkey/tasks/configure-sentinel.yml new file mode 100644 index 00000000..31625270 --- /dev/null +++ b/roles/valkey/tasks/configure-sentinel.yml @@ -0,0 +1,94 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Gather service facts + ansible.builtin.service_facts: + +- name: Open Sentinel port on FirewallD Public Zone + ansible.posix.firewalld: + port: "{{ valkey_sentinel_port }}/tcp" + permanent: true + state: enabled + zone: public + immediate: true + vars: + ansible_python_interpreter: "{{ '/usr/libexec/platform-python' if (ansible_os_family == 'RedHat' and ansible_distribution_major_version == '8') else 'auto' }}" + when: + - ansible_facts.services["firewalld.service"] is defined + - ansible_facts.services["firewalld.service"].state == "running" + - ansible_facts.services["firewalld.service"].status == "enabled" + +- name: Create Valkey Sentinel data directory + ansible.builtin.file: + state: directory + path: "{{ valkey_data_dir }}/sentinel" + owner: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + mode: "0755" + +- name: Create Valkey Sentinel systemd file + ansible.builtin.template: + src: valkey-sentinel.service.j2 + dest: /usr/lib/systemd/system/valkey-sentinel.service + owner: root + group: root + mode: "0644" + +# Sentinel quorum configuration +# - If valkey_sentinel_quorum is not 'auto', use the explicit value +# - Otherwise, calculate majority quorum: ceil(sentinel_count / 2) +# This ensures quorum is "more than half" of sentinels +# Examples: 1→1, 2→1, 3→2, 4→2, 5→3, 6→3, 7→4 +# - Defaults to 1 if valkey_sentinel group is undefined or empty +- name: Set sentinel quorum + ansible.builtin.set_fact: + valkey_sentinel_quorum_final: >- + {{ + valkey_sentinel_quorum if valkey_sentinel_quorum != 'auto' + else ((groups['valkey_sentinel'] | default([]) | length / 2) | round(0, 'ceil') | int) | default(1) + }} + +- name: Validate sentinel quorum + ansible.builtin.assert: + that: + - valkey_sentinel_quorum_final | int >= 1 + - valkey_sentinel_quorum_final | int <= (groups['valkey_sentinel'] | default([]) | length) + - groups['valkey_sentinel'] | default([]) | length >= 3 or valkey_sentinel_quorum != 'auto' + fail_msg: "Invalid quorum {{ valkey_sentinel_quorum_final }} for {{ groups['valkey_sentinel'] | default([]) | length }} sentinels (min 3 recommended)" + success_msg: "Sentinel quorum: {{ valkey_sentinel_quorum_final }}/{{ groups['valkey_sentinel'] | default([]) | length }}" + run_once: true + +- name: Display sentinel quorum configuration + ansible.builtin.debug: + msg: "Using sentinel quorum: {{ valkey_sentinel_quorum_final }} out of {{ groups['valkey_sentinel'] | default([]) | length }} sentinels" + run_once: true + +- name: Check if sentinel is running + ansible.builtin.systemd: + name: valkey-sentinel + register: valkey_sentinel_service + failed_when: false + +- name: Stop sentinel for config update + ansible.builtin.systemd: + name: valkey-sentinel + state: stopped + when: valkey_sentinel_service.status.ActiveState == 'active' + +- name: Deploy sentinel.conf + ansible.builtin.template: + src: sentinel.conf.j2 + dest: "{{ valkey_sentinel_conf_file }}" + owner: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + mode: "0640" + backup: true + notify: Enable and Start Valkey Sentinel + +- name: Deploy logrotate config for Valkey Sentinel + ansible.builtin.template: + src: valkey-sentinel.logrotate.j2 + dest: /etc/logrotate.d/valkey-sentinel + owner: root + group: root + mode: '0644' diff --git a/roles/valkey/tasks/configure-valkey-tls.yml b/roles/valkey/tasks/configure-valkey-tls.yml new file mode 100644 index 00000000..2d41e24e --- /dev/null +++ b/roles/valkey/tasks/configure-valkey-tls.yml @@ -0,0 +1,68 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Create Valkey PKI base directory + ansible.builtin.file: + path: "{{ valkey_pki_base_dir }}" + state: directory + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0750" + tags: + - valkey + - valkey_certificates + - certificates + +- name: Create Valkey private directory + ansible.builtin.file: + path: "{{ valkey_pki_private_dir }}" + state: directory + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0700" + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy Valkey TLS certificate + ansible.builtin.copy: + src: "{{ valkey_tls_cert_src }}" + dest: "{{ valkey_tls_cert_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0644" + when: valkey_tls_cert_src | length > 0 + notify: restart valkey + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy Valkey TLS private key + ansible.builtin.copy: + src: "{{ valkey_tls_key_src }}" + dest: "{{ valkey_tls_key_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0600" + when: valkey_tls_key_src | length > 0 + notify: restart valkey + tags: + - valkey + - valkey_certificates + - certificates + +- name: Copy Valkey CA bundle + ansible.builtin.copy: + src: "{{ valkey_tls_ca_src }}" + dest: "{{ valkey_tls_ca_dest }}" + owner: "{{ valkey_pki_owner }}" + group: "{{ valkey_pki_group }}" + mode: "0644" + when: valkey_tls_ca_src | length > 0 + notify: restart valkey + tags: + - valkey + - valkey_certificates + - certificates diff --git a/roles/valkey/tasks/configure-valkey.yml b/roles/valkey/tasks/configure-valkey.yml new file mode 100644 index 00000000..cf94b848 --- /dev/null +++ b/roles/valkey/tasks/configure-valkey.yml @@ -0,0 +1,83 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Gather service facts + ansible.builtin.service_facts: + +- name: Open Valkey port on FirewallD Public Zone + ansible.posix.firewalld: + port: "{{ valkey_port }}/tcp" + permanent: true + state: enabled + zone: public + immediate: true + vars: + ansible_python_interpreter: "{{ '/usr/libexec/platform-python' if (ansible_os_family == 'RedHat' and ansible_distribution_major_version == '8') else 'auto' }}" + when: + - ansible_facts.services["firewalld.service"] is defined + - ansible_facts.services["firewalld.service"].state == "running" + - ansible_facts.services["firewalld.service"].status == "enabled" + +- name: Create Valkey systemd file + ansible.builtin.template: + src: valkey.service.j2 + dest: /usr/lib/systemd/system/valkey.service + owner: root + group: root + mode: "0644" + +# Refer to the valkey defaults and Valkey Guide for an explanation of the replica priority +- name: Calculate replica priority + ansible.builtin.set_fact: + valkey_replica_priority_final: >- + {%- if valkey_replica_priority != 'auto' -%} + {{ valkey_replica_priority }} + {%- elif valkey_is_master_node -%} + 10 + {%- elif valkey_is_replica_node -%} + {{ 50 + (groups['valkey_replica'].index(inventory_hostname) * 50) }} + {%- else -%} + 100 + {%- endif -%} + +- name: Validate replica priority + ansible.builtin.assert: + that: + - valkey_replica_priority_final | int >= 0 + - valkey_replica_priority_final | int <= 255 + fail_msg: "valkey_replica_priority must be between 0-255, got {{ valkey_replica_priority_final }}" + +- name: Calculate Valkey maxmemory automatically + ansible.builtin.set_fact: + valkey_maxmemory_bytes: >- + {{ + ( + [ + valkey_maxmemory_min_mb | int, + ( + (ansible_facts.memtotal_mb | int) + * (valkey_maxmemory_ratio | float) + ) | int + ] | max + ) * 1024 * 1024 + }} + when: valkey_maxmemory_bytes == "auto" + tags: configure_valkey + +- name: Use template to generate valkey.conf + ansible.builtin.template: + src: valkey.conf.j2 + dest: "{{ valkey_conf_file }}" + owner: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + mode: "0644" + backup: true + tags: configure_valkey + +- name: Deploy logrotate config for Valkey + ansible.builtin.template: + src: valkey.logrotate.j2 + dest: /etc/logrotate.d/valkey + owner: root + group: root + mode: "0644" diff --git a/roles/valkey/tasks/disable-thp.yml b/roles/valkey/tasks/disable-thp.yml new file mode 100644 index 00000000..a44e4232 --- /dev/null +++ b/roles/valkey/tasks/disable-thp.yml @@ -0,0 +1,96 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# Transparent Huge Pages (THP) is a Linux memory management system that reduces the overhead +# of Translation Lookaside Buffer (TLB) lookups on machines with large amounts of memory by +# using larger memory pages. +# +# However, database workloads often perform poorly with THP enabled, because they tend to +# have sparse rather than contiguous memory access patterns. When running Valkey on Linux, +# THP should be disabled for best performance. Valkey will also log a warning at startup +# if THP is enabled. +# +# To ensure that THP is disabled before valkey starts, you should create a service file for +# your platform's initialization system that disables THP at boot. +# +# Additionally, for RHEL / CentOS systems that make use of ktune and tuned performance +# profiles, you must create a custom tuned profile as well. + +# Check if its already disabled +- name: Ensure THP is enabled never + ansible.builtin.lineinfile: + name: /sys/kernel/mm/transparent_hugepage/enabled + line: "always madvise [never]" + state: present + check_mode: true + register: thp_enable_conf + +- name: Ensure THP is defrag never + ansible.builtin.lineinfile: + name: /sys/kernel/mm/transparent_hugepage/defrag + line: "always defer defer+madvise madvise [never]" + state: present + check_mode: true + register: thp_defrag_conf + +# Disable Transparent Huge Pages (THP) if it has not been already +- name: Disable Transparent Huge Pages (THP) + when: + - thp_enable_conf.changed + - thp_defrag_conf.changed + block: + - name: Create systemd unit file + ansible.builtin.template: + src: thp.service.j2 + dest: "/etc/systemd/system/disable-transparent-huge-pages.service" + owner: root + group: root + mode: "0644" + vars: + description: Disable Transparent Hugepages (THP) + command: /bin/sh -c 'echo never | tee /sys/kernel/mm/transparent_hugepage/enabled > /dev/null && echo never | tee /sys/kernel/mm/transparent_hugepage/defrag > /dev/null' + + - name: Start THP service + ansible.builtin.systemd: + name: disable-transparent-huge-pages.service + state: started + enabled: true + daemon_reload: true + + - name: Check if tuned is installed + ansible.builtin.command: + cmd: which tuned-adm + register: tuned_installed + changed_when: false + failed_when: false + when: ansible_distribution_file_variety == "RedHat" + + - name: Install and configure tuned + when: + - ansible_distribution_file_variety == "RedHat" + - tuned_installed.rc == 0 + block: + - name: Create custom tuned profile directory + ansible.builtin.file: + state: directory + path: "/etc/tuned/virtual-guest-no-thp" + owner: root + group: root + mode: "0755" + + - name: Ensure tuned does not re-enable THP + ansible.builtin.template: + src: tuned.conf.j2 + dest: "/etc/tuned/virtual-guest-no-thp/tuned.conf" + owner: root + group: root + mode: "0644" + vars: + tuned_action: never + + - name: Enable tuned profile + ansible.builtin.command: + cmd: tuned-adm profile virtual-guest-no-thp + register: result + changed_when: result.rc == 0 + failed_when: result.rc > 0 diff --git a/roles/valkey/tasks/download-packages.yml b/roles/valkey/tasks/download-packages.yml new file mode 100644 index 00000000..d164b2cf --- /dev/null +++ b/roles/valkey/tasks/download-packages.yml @@ -0,0 +1,28 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Include tasks to validate variables + ansible.builtin.include_tasks: + file: validate-vars.yml + tags: always + +- name: Include tasks to validate offline variables + ansible.builtin.include_tasks: + file: validate-vars-offline.yml + +- name: Download Valkey RPMs + ansible.builtin.import_role: + name: offline + tasks_from: download-rpms + vars: + offline_download_method: yum_module + offline_download_packages: "{{ valkey_packages }} " + offline_download_dir: "{{ valkey_offline_target_node_rpms_dir }}/valkey" + +- name: Copy Valkey RPMs to control node + ansible.builtin.import_role: + name: offline + tasks_from: fetch-packages + vars: + offline_src_dir: "{{ valkey_offline_target_node_rpms_dir }}/valkey" + offline_dest_dir: "{{ valkey_offline_control_node_rpms_dir }}/valkey" diff --git a/roles/valkey/tasks/install-common.yml b/roles/valkey/tasks/install-common.yml new file mode 100644 index 00000000..13ac0404 --- /dev/null +++ b/roles/valkey/tasks/install-common.yml @@ -0,0 +1,31 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# Kernel Adjust +# Memory overcommit must be enabled! Without it, a background save or replication may fail under +# low memory condition. +# Being disabled, it can can also cause failures without low memory condition, +# see https://github.com/jemalloc/jemalloc/issues/1328 +- name: Adjust Memory Overcommit + ansible.posix.sysctl: + name: vm.overcommit_memory + value: 1 + +- name: Disable Transparent Huge Pages (THP) + ansible.builtin.import_tasks: + file: disable-thp.yml + +- name: Create Valkey group + ansible.builtin.group: + name: "{{ valkey_group }}" + +- name: Create Valkey user + ansible.builtin.user: + name: "{{ valkey_owner }}" + group: "{{ valkey_group }}" + state: present + +# The AppStream package creates /etc/valkey, /var/lib/valkey, /var/log/valkey and +# /usr/bin/valkey-server itself (with correct ownership and SELinux file contexts already +# applied by the base OS's selinux-policy), so unlike roles/redis (which also supports a +# from-source install with non-default paths), there is no directory-creation step here. diff --git a/roles/valkey/tasks/install-from-repo.yml b/roles/valkey/tasks/install-from-repo.yml new file mode 100644 index 00000000..607a1e5b --- /dev/null +++ b/roles/valkey/tasks/install-from-repo.yml @@ -0,0 +1,17 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Install Valkey from packages + ansible.builtin.dnf: + name: '{{ valkey_packages }}' + state: present + update_cache: true + when: not offline_install_enabled | bool + +- name: Install Valkey from packages (offline) + ansible.builtin.import_role: + name: offline + tasks_from: install-rpms + when: offline_install_enabled | bool + vars: + offline_rpms_path: "{{ valkey_offline_control_node_rpms_dir }}/valkey" diff --git a/roles/valkey/tasks/main.yml b/roles/valkey/tasks/main.yml new file mode 100644 index 00000000..bd7f98a9 --- /dev/null +++ b/roles/valkey/tasks/main.yml @@ -0,0 +1,104 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Validate variables and set node type facts + tags: always + block: + - name: Include tasks to validate variables + ansible.builtin.include_tasks: + file: validate-vars.yml + + - name: Set Valkey node type facts + ansible.builtin.set_fact: + valkey_is_master_node: "{{ 'valkey_master' in group_names }}" + valkey_is_replica_node: "{{ 'valkey_replica' in group_names }}" + valkey_is_sentinel_node: "{{ 'valkey_sentinel' in group_names }}" + valkey_is_data_node: "{{ 'valkey_master' in group_names or 'valkey_replica' in group_names }}" + valkey_has_replicas: "{{ groups['valkey_replica'] is defined and groups['valkey_replica'] | length > 0 }}" + valkey_has_sentinels: "{{ groups['valkey_sentinel'] is defined and groups['valkey_sentinel'] | length > 0 }}" + +- name: Install and configure Valkey + notify: + - Enable and Start Valkey + - Enable and Start Valkey Sentinel + block: + - name: Install Valkey + tags: install_valkey + notify: Update Itential release file + block: + - name: Include common installation tasks + ansible.builtin.include_tasks: + file: install-common.yml + + - name: Include tasks to install Valkey using repo + ansible.builtin.include_tasks: + file: install-from-repo.yml + + - name: Configure Valkey TLS + ansible.builtin.include_tasks: configure-valkey-tls.yml + when: + - valkey_tls_enabled | bool + - valkey_is_data_node + tags: + - valkey + - valkey_certificates + - certificates + + - name: Configure Sentinel TLS + ansible.builtin.include_tasks: configure-sentinel-tls.yml + when: + - valkey_tls_enabled | bool + - valkey_is_sentinel_node + tags: + - valkey + - valkey_certificates + - certificates + + - name: Configure Valkey/Sentinel + tags: configure_valkey + block: + - name: Include tasks to configure Valkey + ansible.builtin.include_tasks: + file: configure-valkey.yml + when: valkey_is_data_node + + - name: Include tasks to configure Sentinel + ansible.builtin.include_tasks: + file: configure-sentinel.yml + when: valkey_is_sentinel_node + +- name: Ensure Valkey is running + tags: always + when: valkey_is_data_node + block: + - name: Flush all handlers + ansible.builtin.meta: flush_handlers + + - name: Start Valkey + ansible.builtin.systemd: + name: valkey + state: started + + - name: Assert that Valkey is running + ansible.builtin.systemd: + name: valkey + register: valkey_status + failed_when: valkey_status.status.ActiveState != "active" + +- name: Ensure Valkey Sentinel is running + tags: always + when: valkey_is_sentinel_node + block: + - name: Flush all handlers + ansible.builtin.meta: flush_handlers + + - name: Start Valkey Sentinel + ansible.builtin.systemd: + name: valkey-sentinel + state: started + + - name: Assert that Valkey Sentinel is running + ansible.builtin.systemd: + name: valkey-sentinel + register: valkey_sentinel_status + failed_when: valkey_sentinel_status.status.ActiveState != "active" diff --git a/roles/valkey/tasks/update-release-file.yml b/roles/valkey/tasks/update-release-file.yml new file mode 100644 index 00000000..a2c90f7d --- /dev/null +++ b/roles/valkey/tasks/update-release-file.yml @@ -0,0 +1,20 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Determine valkey version + ansible.builtin.shell: + cmd: 'set -o pipefail && valkey-server --version | cut -d" " -f3 | cut -d"=" -f2' + register: result + check_mode: false + changed_when: false + failed_when: result.rc != 0 + environment: + PATH: "{{ ansible_env.PATH }}:{{ valkey_bin_dir }}" + +- name: Write valkey release information + ansible.builtin.lineinfile: + path: "{{ common_itential_release_file }}" + regexp: "^VALKEY=" + line: "VALKEY={{ result.stdout }}" + create: true + mode: "0644" diff --git a/roles/valkey/tasks/validate-vars-offline.yml b/roles/valkey/tasks/validate-vars-offline.yml new file mode 100644 index 00000000..1a50ccc7 --- /dev/null +++ b/roles/valkey/tasks/validate-vars-offline.yml @@ -0,0 +1,7 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Validate offline_install_enabled variable + ansible.builtin.assert: + that: offline_install_enabled is not defined or not offline_install_enabled | bool + msg: offline_install_enabled must be set to false for download diff --git a/roles/valkey/tasks/validate-vars.yml b/roles/valkey/tasks/validate-vars.yml new file mode 100644 index 00000000..fb0c256b --- /dev/null +++ b/roles/valkey/tasks/validate-vars.yml @@ -0,0 +1,96 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +- name: Validate and set installation variables + tags: always + block: + - name: Validate an installation variable is set + ansible.builtin.assert: + that: > + (platform_release is defined) or + (valkey_packages is defined) + fail_msg: "platform_release OR valkey_packages must be defined" + + - name: Validate valkey_packages is set when not using platform_release + ansible.builtin.assert: + that: valkey_packages is defined + fail_msg: >- + valkey_packages must be defined + when platform_release is not defined + when: platform_release is not defined + + - name: Validate directories are not overridden + ansible.builtin.assert: + that: + - valkey_bin_dir == valkey_bin_dir_default + - valkey_conf_dir == valkey_conf_dir_default + - valkey_data_dir == valkey_data_dir_default + - valkey_log_dir == valkey_log_dir_default + fail_msg: >- + Default directories cannot be overridden. Valkey is only installed via the + native OS package repositories, which expect standard paths and are not relocatable. + + - name: Set installation variables when using Itential Platform release defaults + when: platform_release is defined + block: + - name: Load Itential Platform release default variables + ansible.builtin.include_vars: + file: "{{ item }}" + with_first_found: + - "platform-release-{{ platform_release }}.yml" + - "platform-release-{{ platform_release | string | split('.') | first }}.yml" + - "platform-release-undefined.yml" + + - name: Check for valid Valkey release + ansible.builtin.assert: + that: valkey_invalid_platform_release is not defined + fail_msg: >- + Deployer does not support installing Valkey + for Itential Platform release {{ platform_release }} + + - name: Check for valid OS for Valkey installation + ansible.builtin.assert: + that: + - ansible_os_family == 'RedHat' + - ansible_distribution_major_version in ['9', '2023'] + fail_msg: >- + Deployer does not support installing Valkey on + {{ ansible_distribution }} {{ ansible_distribution_major_version | default('') }}. + Valkey is only supported on RHEL/Rocky/AlmaLinux 9 and Amazon Linux 2023, installed + via the native OS package repositories. Use the redis role instead on EL8 or other + platforms. + + - name: Set valkey_packages to the default value when not defined in inventory + ansible.builtin.set_fact: + valkey_packages: "{{ valkey_packages_default[ansible_distribution_major_version] }}" + when: valkey_packages is not defined + + - name: Print Valkey installation details + ansible.builtin.debug: + msg: "Valkey packages: {{ valkey_packages }}" + when: not offline_install_enabled | bool + + - name: Validate offline install directory for the target OS + when: offline_install_enabled | bool + block: + - name: Stat offline packages directory on the control node + ansible.builtin.stat: + path: "{{ valkey_offline_control_node_root }}" + register: valkey_offline_dir_stat + delegate_to: localhost + become: false + + - name: Assert offline packages directory exists on the control node + ansible.builtin.assert: + that: + - valkey_offline_dir_stat.stat.exists + - valkey_offline_dir_stat.stat.isdir + fail_msg: >- + Offline packages directory {{ valkey_offline_control_node_root }} does not exist. + Ensure offline packages have been downloaded for + {{ ansible_distribution }} {{ ansible_distribution_major_version }}. + + - name: Print Valkey installation details (offline) + ansible.builtin.debug: + msg: "Valkey offline install using files from {{ valkey_offline_control_node_root }}" + when: offline_install_enabled | bool diff --git a/roles/valkey/tasks/verify-sentinel.yml b/roles/valkey/tasks/verify-sentinel.yml new file mode 100644 index 00000000..9c5c41ef --- /dev/null +++ b/roles/valkey/tasks/verify-sentinel.yml @@ -0,0 +1,35 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +- name: Load Itential Platform release default variables + ansible.builtin.include_vars: + file: "{{ item }}" + with_first_found: + - "platform-release-{{ platform_release }}.yml" + - "platform-release-{{ platform_release | string | split('.') | first }}.yml" + - "platform-release-undefined.yml" + +- name: Verify Valkey Sentinel host requirements + ansible.builtin.include_role: + name: common + tasks_from: verify-host + vars: + component_name: "Valkey Sentinel" + hw_specs_var_name: "valkey_hw_specs" + +# valkey sentinel specific verification tasks go here... + +- name: Verify connectivity to required public repositories + ansible.builtin.include_role: + name: common + tasks_from: verify-connectivity + vars: + required_repositories: "{{ valkey_required_repositories }}" + +- name: Report Valkey Sentinel results + ansible.builtin.include_role: + name: common + tasks_from: verify-results + vars: + component_name: "Valkey Sentinel" diff --git a/roles/valkey/tasks/verify-valkey.yml b/roles/valkey/tasks/verify-valkey.yml new file mode 100644 index 00000000..301527dc --- /dev/null +++ b/roles/valkey/tasks/verify-valkey.yml @@ -0,0 +1,35 @@ +# Copyright (c) 2026, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- + +- name: Load Itential Platform release default variables + ansible.builtin.include_vars: + file: "{{ item }}" + with_first_found: + - "platform-release-{{ platform_release }}.yml" + - "platform-release-{{ platform_release | string | split('.') | first }}.yml" + - "platform-release-undefined.yml" + +- name: Verify Valkey host requirements + ansible.builtin.include_role: + name: common + tasks_from: verify-host + vars: + component_name: "Valkey" + hw_specs_var_name: "valkey_hw_specs" + +# valkey specific verification tasks go here... + +- name: Verify connectivity to required public repositories + ansible.builtin.include_role: + name: common + tasks_from: verify-connectivity + vars: + required_repositories: "{{ valkey_required_repositories }}" + +- name: Report Valkey results + ansible.builtin.include_role: + name: common + tasks_from: verify-results + vars: + component_name: "Valkey" diff --git a/roles/valkey/templates/sentinel.conf.j2 b/roles/valkey/templates/sentinel.conf.j2 new file mode 100644 index 00000000..48e8be59 --- /dev/null +++ b/roles/valkey/templates/sentinel.conf.j2 @@ -0,0 +1,369 @@ +# Example sentinel.conf + +# *** IMPORTANT *** +# +# By default Sentinel will not be reachable from interfaces different than +# localhost, either use the 'bind' directive to bind to a list of network +# interfaces, or disable protected mode with "protected-mode no" by +# adding it to this configuration file. +# +# Before doing that MAKE SURE the instance is protected from the outside +# world via firewalling or other means. +# +# For example you may use one of the following: +# +bind {{ valkey_sentinel_bind }} +# +# protected-mode no + +# port +# The port that this sentinel instance will run on +{% if valkey_tls_enabled | bool %} +port 0 +tls-port {{ valkey_sentinel_port }} +tls-cert-file {{ valkey_sentinel_tls_cert_dest }} +tls-key-file {{ valkey_sentinel_tls_key_dest }} +tls-ca-cert-file {{ valkey_tls_ca_dest }} +tls-replication yes +tls-auth-clients no +tls-protocols "{{ valkey_tls_protocols }}" +{% else %} +port {{ valkey_sentinel_port }} +{% endif %} + +# By default Valkey Sentinel does not run as a daemon. Use 'yes' if you need it. +# Note that Valkey will write a pid file in /var/run/valkey-sentinel.pid when +# daemonized. +daemonize no + +# When running daemonized, Valkey Sentinel writes a pid file in +# /var/run/valkey-sentinel.pid by default. You can specify a custom pid file +# location here. +# pidfile /var/run/valkey-sentinel.pid + +# Specify the log file name. Also the empty string can be used to force +# Sentinel to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile {{ valkey_log_dir }}/sentinel.log + +# +# The above two configuration directives are useful in environments where, +# because of NAT, Sentinel is reachable from outside via a non-local address. +# +# When announce-ip is provided, the Sentinel will claim the specified IP address +# in HELLO messages used to gossip its presence, instead of auto-detecting the +# local address as it usually does. +# +# Similarly when announce-port is provided and is valid and non-zero, Sentinel +# will announce the specified TCP port. +# +# The two options don't need to be used together, if only announce-ip is +# provided, the Sentinel will announce the specified IP and the server port +# as specified by the "port" option. If only announce-port is provided, the +# Sentinel will announce the auto-detected local IP and the specified port. +# +# Example: +# +# sentinel announce-ip 1.2.3.4 +sentinel announce-ip {{ inventory_hostname }} +sentinel announce-port {{ valkey_sentinel_port }} + +# dir +# Every long running process should have a well-defined working directory. +# For Valkey Sentinel to chdir to /tmp at startup is the simplest thing +# for the process to don't interfere with administrative tasks such as +# unmounting filesystems. +dir {{ valkey_data_dir }}/sentinel + +# sentinel monitor +# +# Tells Sentinel to monitor this master, and to consider it in O_DOWN +# (Objectively Down) state only if at least sentinels agree. +# +# Note that whatever is the ODOWN quorum, a Sentinel will require to +# be elected by the majority of the known Sentinels in order to +# start a failover, so no failover can be performed in minority. +# +# Replicas are auto-discovered, so you don't need to specify replicas in +# any way. Sentinel itself will rewrite this configuration file adding +# the replicas using additional configuration options. +# Also note that the configuration file is rewritten when a +# replica is promoted to master. +# +# Note: master name should not include special characters or spaces. +# The valid charset is A-z 0-9 and the three characters ".-_". +sentinel monitor {{ valkey_sentinel_master_name }} {{ groups['valkey_master'][0] }} {{ valkey_port }} {{ valkey_sentinel_quorum_final }} + +# sentinel auth-pass +# +# Set the password to use to authenticate with the master and replicas. +# Useful if there is a password set in the Valkey instances to monitor. +# +# Note that the master password is also used for replicas, so it is not +# possible to set a different password in masters and replicas instances +# if you want to be able to monitor these instances with Sentinel. +# +# However you can have Valkey instances without the authentication enabled +# mixed with Valkey instances requiring the authentication (as long as the +# password set is the same for all the instances requiring the password) as +# the AUTH command will have no effect in Valkey instances with authentication +# switched off. +# +# Example: +# +# sentinel auth-pass mymaster MySUPER--secret-0123passw0rd +{% if valkey_auth_enabled %} +sentinel auth-pass {{ valkey_sentinel_master_name }} {{ valkey_user_sentineluser_password }} +{% endif %} + +# sentinel auth-user +# +# This is useful in order to authenticate to instances having ACL capabilities, +# that is, running Valkey 6.0 or greater. When just auth-pass is provided the +# Sentinel instance will authenticate to Valkey using the old "AUTH " +# method. When also an username is provided, it will use "AUTH ". +# In the Valkey servers side, the ACL to provide just minimal access to +# Sentinel instances, should be configured along the following lines: +# +# user sentinel-user >somepassword +client +subscribe +publish \ +# +ping +info +multi +slaveof +config +client +exec on +{% if valkey_auth_enabled %} +sentinel auth-user {{ valkey_sentinel_master_name }} sentineluser + +user default off +user admin on >{{ valkey_user_sentineladmin_password }} ~* &* +@all +user sentineluser on >{{ valkey_user_sentineluser_password }} &* -@all +auth +client|getname +client|id +client|setname +command +hello +ping +role +sentinel|is-master-down-by-addr +sentinel|get-master-addr-by-name +sentinel|master +sentinel|myid +sentinel|replicas +sentinel|sentinels +{% if valkey_monitor_user_enabled and valkey_user_monitor_password %} +user monitor on >{{ valkey_user_monitor_password }} -@all +@connection -command +client -hello +info -auth +sentinel|masters +sentinel|replicas +sentinel|slaves +sentinel|sentinels +sentinel|ckquorum +{% endif %} +{% endif %} + +# sentinel down-after-milliseconds +# +# Number of milliseconds the master (or any attached replica or sentinel) should +# be unreachable (as in, not acceptable reply to PING, continuously, for the +# specified period) in order to consider it in S_DOWN state (Subjectively +# Down). +# +# Default is 30 seconds. +sentinel down-after-milliseconds {{ valkey_sentinel_master_name }} 5000 + +# IMPORTANT NOTE: starting with Valkey 6.2 ACL capability is supported for +# Sentinel mode, please refer to the Valkey website https://valkey.io/topics/acl +# for more details. + +# Sentinel's ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@admin +@connection ~* on >ffa9203c493aa99 +# +# For more information about ACL configuration please refer to the Valkey +# website at https://valkey.io/topics/acl and valkey server configuration +# template valkey.conf. + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the external +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside valkey.conf to describe users. +# +# aclfile /etc/valkey/sentinel-users.acl + +# requirepass +# +# You can configure Sentinel itself to require a password, however when doing +# so Sentinel will try to authenticate with the same password to all the +# other Sentinels. So you need to configure all your Sentinels in a given +# group with the same "requirepass" password. Check the following documentation +# for more info: https://valkey.io/topics/sentinel +# +# IMPORTANT NOTE: starting with Valkey 6.2 "requirepass" is a compatibility +# layer on top of the ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# New config files are advised to use separate authentication control for +# incoming connections (via ACL), and for outgoing connections (via +# sentinel-user and sentinel-pass) +# +# The requirepass is not compatable with aclfile option and the ACL LOAD +# command, these will cause requirepass to be ignored. +# +# sentinel sentinel-user +# +# You can configure Sentinel to authenticate with other Sentinels with specific +# user name. +{% if valkey_auth_enabled %} +sentinel sentinel-user sentineluser +sentinel sentinel-pass {{ valkey_user_sentineluser_password }} +{% endif %} + +# sentinel sentinel-pass +# +# The password for Sentinel to authenticate with other Sentinels. If sentinel-user +# is not configured, Sentinel will use 'default' user with sentinel-pass to authenticate. + +# sentinel parallel-syncs +# +# How many replicas we can reconfigure to point to the new replica simultaneously +# during the failover. Use a low number if you use the replicas to serve query +# to avoid that all the replicas will be unreachable at about the same +# time while performing the synchronization with the master. +sentinel parallel-syncs {{ valkey_sentinel_master_name }} 1 + +# sentinel failover-timeout +# +# Specifies the failover timeout in milliseconds. It is used in many ways: +# +# - The time needed to re-start a failover after a previous failover was +# already tried against the same master by a given Sentinel, is two +# times the failover timeout. +# +# - The time needed for a replica replicating to a wrong master according +# to a Sentinel current configuration, to be forced to replicate +# with the right master, is exactly the failover timeout (counting since +# the moment a Sentinel detected the misconfiguration). +# +# - The time needed to cancel a failover that is already in progress but +# did not produced any configuration change (SLAVEOF NO ONE yet not +# acknowledged by the promoted replica). +# +# - The maximum time a failover in progress waits for all the replicas to be +# reconfigured as replicas of the new master. However even after this time +# the replicas will be reconfigured by the Sentinels anyway, but not with +# the exact parallel-syncs progression as specified. +# +# Default is 3 minutes. +sentinel failover-timeout {{ valkey_sentinel_master_name }} 60000 + +# SCRIPTS EXECUTION +# +# sentinel notification-script and sentinel reconfig-script are used in order +# to configure scripts that are called to notify the system administrator +# or to reconfigure clients after a failover. The scripts are executed +# with the following rules for error handling: +# +# If script exits with "1" the execution is retried later (up to a maximum +# number of times currently set to 10). +# +# If script exits with "2" (or an higher value) the script execution is +# not retried. +# +# If script terminates because it receives a signal the behavior is the same +# as exit code 1. +# +# A script has a maximum running time of 60 seconds. After this limit is +# reached the script is terminated with a SIGKILL and the execution retried. + +# NOTIFICATION SCRIPT +# +# sentinel notification-script +# +# Call the specified notification script for any sentinel event that is +# generated in the WARNING level (for instance -sdown, -odown, and so forth). +# This script should notify the system administrator via email, SMS, or any +# other messaging system, that there is something wrong with the monitored +# Valkey systems. +# +# The script is called with just two arguments: the first is the event type +# and the second the event description. +# +# The script must exist and be executable in order for sentinel to start if +# this option is provided. +# +# Example: +# +# sentinel notification-script mymaster /var/valkey/notify.sh + +# CLIENTS RECONFIGURATION SCRIPT +# +# sentinel client-reconfig-script +# +# When the master changed because of a failover a script can be called in +# order to perform application-specific tasks to notify the clients that the +# configuration has changed and the master is at a different address. +# +# The following arguments are passed to the script: +# +# +# +# is currently always "failover" +# is either "leader" or "observer" +# +# The arguments from-ip, from-port, to-ip, to-port are used to communicate +# the old address of the master and the new address of the elected replica +# (now a master). +# +# This script should be resistant to multiple invocations. +# +# Example: +# +# sentinel client-reconfig-script mymaster /var/valkey/reconfig.sh + +# SECURITY +# +# By default SENTINEL SET will not be able to change the notification-script +# and client-reconfig-script at runtime. This avoids a trivial security issue +# where clients can set the script to anything and trigger a failover in order +# to get the program executed. + +sentinel deny-scripts-reconfig yes + +# VALKEY COMMANDS RENAMING +# +# Sometimes the Valkey server has certain commands, that are needed for Sentinel +# to work correctly, renamed to unguessable strings. This is often the case +# of CONFIG and SLAVEOF in the context of providers that provide Valkey as +# a service, and don't want the customers to reconfigure the instances outside +# of the administration console. +# +# In such case it is possible to tell Sentinel to use different command names +# instead of the normal ones. For example if the master "mymaster", and the +# associated replicas, have "CONFIG" all renamed to "GUESSME", I could use: +# +# SENTINEL rename-command mymaster CONFIG GUESSME +# +# After such configuration is set, every time Sentinel would use CONFIG it will +# use GUESSME instead. Note that there is no actual need to respect the command +# case, so writing "config guessme" is the same in the example above. +# +# SENTINEL SET can also be used in order to perform this configuration at runtime. +# +# In order to set a command back to its original name (undo the renaming), it +# is possible to just rename a command to itself: +# +# SENTINEL rename-command mymaster CONFIG CONFIG + +# HOSTNAMES SUPPORT +# +# Normally Sentinel uses only IP addresses and requires SENTINEL MONITOR +# to specify an IP address. Also, it requires the Valkey replica-announce-ip +# keyword to specify only IP addresses. +# +# You may enable hostnames support by enabling resolve-hostnames. Note +# that you must make sure your DNS is configured properly and that DNS +# resolution does not introduce very long delays. +# +SENTINEL resolve-hostnames yes + +# When resolve-hostnames is enabled, Sentinel still uses IP addresses +# when exposing instances to users, configuration files, etc. If you want +# to retain the hostnames when announced, enable announce-hostnames below. +# +SENTINEL announce-hostnames yes diff --git a/roles/valkey/templates/thp.service.j2 b/roles/valkey/templates/thp.service.j2 new file mode 100644 index 00000000..34ecf0e3 --- /dev/null +++ b/roles/valkey/templates/thp.service.j2 @@ -0,0 +1,12 @@ +[Unit] +Description={{ description }} +DefaultDependencies=no +After=sysinit.target local-fs.target +Before=valkey.service + +[Service] +Type=oneshot +ExecStart={{ command }} + +[Install] +WantedBy=basic.target diff --git a/roles/valkey/templates/tuned.conf.j2 b/roles/valkey/templates/tuned.conf.j2 new file mode 100644 index 00000000..638b8772 --- /dev/null +++ b/roles/valkey/templates/tuned.conf.j2 @@ -0,0 +1,5 @@ +[main] +include=virtual-guest + +[vm] +transparent_hugepages={{ tuned_action }} diff --git a/roles/valkey/templates/valkey-sentinel.logrotate.j2 b/roles/valkey/templates/valkey-sentinel.logrotate.j2 new file mode 100644 index 00000000..6fabaddc --- /dev/null +++ b/roles/valkey/templates/valkey-sentinel.logrotate.j2 @@ -0,0 +1,35 @@ +# ----------------------------------------------------- +# This file is managed by Ansible. +# Safe to edit, but if you re-run automation, it may be overwritten. +# +# To customize retention, compression, or actions, edit below. + +{{ valkey_log_dir }}/sentinel.log { + # How often to rotate (change to weekly/monthly if desired) + daily + + # How many rotations to keep (increase/decrease as needed) + rotate 7 + + # Enable compression for old logs (can comment to disable) + compress + delaycompress + + # Don't complain if log is missing or empty + missingok + notifempty + + # Ensure logrotate runs with the right user/group + su {{ valkey_owner }} {{ valkey_group }} + + # File permissions & ownership for new logs + create 0640 {{ valkey_owner }} {{ valkey_group }} + + # Safest for Sentinel: copy+truncate the active file in place + copytruncate + + # Ensures only one rotation at a time if multiple logs exist + sharedscripts + + # NOTE: Sentinel does NOT reopen logs on HUP. Avoid postrotate/HUP. +} \ No newline at end of file diff --git a/roles/valkey/templates/valkey-sentinel.service.j2 b/roles/valkey/templates/valkey-sentinel.service.j2 new file mode 100644 index 00000000..ebc8e326 --- /dev/null +++ b/roles/valkey/templates/valkey-sentinel.service.j2 @@ -0,0 +1,16 @@ +[Unit] +Description=Valkey Sentinel +After=network.target +After=network-online.target +Wants=network-online.target + +[Service] +ExecStart={{ valkey_bin_dir }}/valkey-sentinel {{ valkey_sentinel_conf_file }} --daemonize no --supervised systemd +Type=notify +User={{ valkey_owner }} +Group={{ valkey_group }} +RuntimeDirectory=valkey +RuntimeDirectoryMode=0755 + +[Install] +WantedBy=multi-user.target diff --git a/roles/valkey/templates/valkey-validation-report.md.j2 b/roles/valkey/templates/valkey-validation-report.md.j2 new file mode 100644 index 00000000..d2c4d4a3 --- /dev/null +++ b/roles/valkey/templates/valkey-validation-report.md.j2 @@ -0,0 +1,441 @@ +# Valkey Installation Validation Report + +- **Generated:** {{ ansible_date_time.iso8601 | default('Unknown') }} +- **Hostname:** {{ inventory_hostname | default('Unknown') }} +- **IP Address:** {{ ansible_default_ipv4.address | default('N/A') }} +- **OS:** {{ ansible_distribution | default('Unknown') }} {{ ansible_distribution_version | default('') }} + +--- + +## Host Details + +{% if host_details is defined %} +### Operating System +- **Distribution:** {{ host_details.os.distribution | default('Unknown') }} {{ host_details.os.distribution_version | default('') }} +- **OS Family:** {{ host_details.os.os_family | default('Unknown') }} +- **Kernel:** {{ host_details.os.kernel | default('Unknown') }} +- **Architecture:** {{ host_details.os.architecture | default('Unknown') }} +- **Hostname:** {{ host_details.os.hostname | default('Unknown') }} +- **FQDN:** {{ host_details.os.fqdn | default('Unknown') }} + +### Hardware +- **CPU Count:** {{ host_details.hardware.cpu.processor_count | default('Unknown') }} +- **CPU Cores:** {{ host_details.hardware.cpu.processor_cores | default('Unknown') }} +- **CPU vCPUs:** {{ host_details.hardware.cpu.processor_vcpus | default('Unknown') }} +- **Threads per Core:** {{ host_details.hardware.cpu.processor_threads_per_core | default('Unknown') }} +- **Total Memory:** {{ host_details.hardware.memory.memtotal_mb | default('Unknown') }} MB +- **Free Memory:** {{ host_details.hardware.memory.memfree_mb | default('Unknown') }} MB +- **Swap Total:** {{ host_details.hardware.memory.swaptotal_mb | default('Unknown') }} MB + +### Disk Mounts +{% if host_details.hardware.disk is defined and host_details.hardware.disk | length > 0 %} +{% for disk in host_details.hardware.disk %} +- **{{ disk.mount }}:** {{ disk.size_gb }} GB +{% endfor %} +{% else %} +- No disk information available +{% endif %} + +### Networking +- **Primary IP:** {{ host_details.networking.default_ipv4.address | default('N/A') }} +- **Gateway:** {{ host_details.networking.default_ipv4.gateway | default('N/A') }} +- **Interface:** {{ host_details.networking.default_ipv4.interface | default('N/A') }} +- **MAC Address:** {{ host_details.networking.default_ipv4.macaddress | default('N/A') }} + +### Security +{% if host_details.security.selinux is defined %} +- **SELinux Status:** {{ host_details.security.selinux.status | default('Unknown') }} +- **SELinux Mode:** {{ host_details.security.selinux.mode | default('Unknown') }} +- **SELinux Type:** {{ host_details.security.selinux.type | default('Unknown') }} +{% endif %} +{% if host_details.security.firewalld is defined %} +- **Firewalld:** {{ host_details.security.firewalld.state | default('Unknown') }} +{% endif %} +{% else %} +Host details not available +{% endif %} + +--- + +## Service Status + +{% if valkey_service_status is defined and valkey_service_status.status is defined %} +- **Service Name:** {{ valkey_service_status.name | default('Unknown') }} +- **Service State:** {{ valkey_service_status.status.ActiveState | default('Unknown') }} +- **Service SubState:** {{ valkey_service_status.status.SubState | default('Unknown') }} +- **Service Enabled:** {{ valkey_service_status.status.UnitFileState | default('Unknown') }} +{% else %} +- **Service Status:** Could not determine (service may not exist) +{% endif %} + +**Process Running:** {{ 'YES ✓' if (valkey_process is defined and valkey_process.rc == 0) else 'NO' }} + +{% if valkey_process is defined and valkey_process.rc == 0 %} +**Process Details:** +``` +{{ valkey_process.stdout | default('N/A') }} +``` +{% endif %} + +--- + +## Connectivity + +- **Valkey Port:** {{ valkey_port | default('6379') }} +- **Ping Response:** {{ valkey_ping.stdout | default('FAILED') if valkey_ping is defined else 'FAILED' }} +- **Connection Status:** {{ 'SUCCESS ✓' if (valkey_ping is defined and valkey_ping.rc == 0) else 'FAILED' }} + +**Listening Ports:** +``` +{{ valkey_ports.stdout | default('Could not determine') if valkey_ports is defined else 'Could not determine' }} +``` + +--- + +## Version Information + +``` +{{ valkey_version.stdout | default('Version information not available') if valkey_version is defined else 'Version information not available' }} +``` + +--- + +## Valkey Metrics (from INFO) + +{% if valkey_metrics is defined %} +- **OS:** {{ valkey_metrics.os | default(['N/A'], true) | first }} +- **Valkey Version:** {{ valkey_metrics.version | default(['N/A'], true) | first }} +- **Executable:** {{ valkey_metrics.executable | default(['N/A'], true) | first }} +- **Valkey Mode:** {{ valkey_metrics.mode | default(['N/A'], true) | first }} +- **Role:** {{ valkey_metrics.role | default(['N/A'], true) | first }} +- **Connected Clients:** {{ valkey_metrics.clients | default(['N/A'], true) | first }} +- **Connected Slaves:** {{ valkey_metrics.slaves | default(['0'], true) | first }} +- **Master Host:** {{ valkey_metrics.master_host | default(['N/A'], true) | first }} +- **Master Port:** {{ valkey_metrics.master_port | default(['N/A'], true) | first }} +- **Master Connection:** {{ valkey_metrics.master_link | default(['N/A'], true) | first }} +{% else %} +Valkey INFO not available - check connectivity and authentication +{% endif %} + +--- + +## Configuration File + +- **Config File Exists:** {{ valkey_conf_file.stat.exists if (valkey_conf_file is defined and valkey_conf_file.stat is defined) else 'Unknown' }} +{% if valkey_conf_file is defined and valkey_conf_file.stat is defined and valkey_conf_file.stat.exists %} +- **Config File Path:** `/etc/valkey/valkey.conf` +- **Permissions:** {{ valkey_conf_permissions.stdout | default('Unknown') if valkey_conf_permissions is defined else 'Unknown' }} +{% endif %} + +- **Systemd Unit File:** {{ valkey_systemd_file.stat.exists if (valkey_systemd_file is defined and valkey_systemd_file.stat is defined) else 'Unknown' }} +{% if valkey_systemd_file is defined and valkey_systemd_file.stat is defined and valkey_systemd_file.stat.exists %} +- **Unit File Path:** `/etc/systemd/system/valkey.service` +{% endif %} + +--- + +## TLS Certificates + +{% if valkey_tls_enabled | bool %} +- **TLS Status:** ENABLED + +#### Files + +| File | Exists | Permissions | Path | +|------|--------|-------------|------| +| Certificate | {{ 'YES' if (valkey_tls_cert_stat is defined and valkey_tls_cert_stat.stat is defined and valkey_tls_cert_stat.stat.exists) else 'NO' }} | {{ valkey_tls_cert_stat.stat.mode | default('N/A') if (valkey_tls_cert_stat is defined and valkey_tls_cert_stat.stat is defined and valkey_tls_cert_stat.stat.exists) else 'N/A' }} | {{ valkey_tls_cert_dest }} | +| Private Key | {{ 'YES' if (valkey_tls_key_stat is defined and valkey_tls_key_stat.stat is defined and valkey_tls_key_stat.stat.exists) else 'NO' }} | {{ valkey_tls_key_stat.stat.mode | default('N/A') if (valkey_tls_key_stat is defined and valkey_tls_key_stat.stat is defined and valkey_tls_key_stat.stat.exists) else 'N/A' }} | {{ valkey_tls_key_dest }} | +| CA Bundle | {{ 'YES' if (valkey_tls_ca_stat is defined and valkey_tls_ca_stat.stat is defined and valkey_tls_ca_stat.stat.exists) else 'NO' }} | {{ valkey_tls_ca_stat.stat.mode | default('N/A') if (valkey_tls_ca_stat is defined and valkey_tls_ca_stat.stat is defined and valkey_tls_ca_stat.stat.exists) else 'N/A' }} | {{ valkey_tls_ca_dest }} | + +{% if valkey_tls_cert_stat is defined and valkey_tls_cert_stat.stat is defined and valkey_tls_cert_stat.stat.exists %} +#### Certificate Details + +{% if valkey_tls_cert_subject_issuer is defined and valkey_tls_cert_subject_issuer.rc is defined and valkey_tls_cert_subject_issuer.rc == 0 %} +- **Subject:** {{ valkey_tls_cert_subject_issuer.stdout_lines | select('match', '^subject') | first | default('Unknown') }} +- **Issuer:** {{ valkey_tls_cert_subject_issuer.stdout_lines | select('match', '^issuer') | first | default('Unknown') }} +{% endif %} + +#### Validity + +{% if valkey_tls_cert_dates is defined and valkey_tls_cert_dates.rc is defined and valkey_tls_cert_dates.rc == 0 %} +- **Not Before:** {{ valkey_tls_cert_dates.stdout | regex_search('notBefore=(.+)', '\\1') | first | default('Unknown') }} +- **Not After:** {{ valkey_tls_cert_dates.stdout | regex_search('notAfter=(.+)', '\\1') | first | default('Unknown') }} +- **Expiry Warning:** {{ 'EXPIRES WITHIN 30 DAYS' if (valkey_tls_cert_expiry_check is defined and valkey_tls_cert_expiry_check.rc is defined and valkey_tls_cert_expiry_check.rc == 1) else 'OK' }} +{% endif %} + +#### Subject Alternative Names + +``` +{{ valkey_tls_cert_sans.stdout | default('Not available') if (valkey_tls_cert_sans is defined and valkey_tls_cert_sans.rc is defined and valkey_tls_cert_sans.rc == 0) else 'Not available' }} +``` + +- **inventory_hostname ({{ inventory_hostname }}) in SANs:** {{ 'YES' if (valkey_tls_san_hostname_match is defined and valkey_tls_san_hostname_match) else 'NO' }} +- **ansible_host ({{ ansible_host }}) in SANs:** {{ 'YES' if (valkey_tls_san_ip_match is defined and valkey_tls_san_ip_match) else 'NO' }} + +#### Validation + +- **Cert-Key Match:** {{ 'YES' if (valkey_tls_cert_key_match is defined and valkey_tls_cert_key_match) else ('NOT CHECKED' if not (valkey_tls_key_stat is defined and valkey_tls_key_stat.stat is defined and valkey_tls_key_stat.stat.exists) else 'FAILED') }} +- **Chain Valid:** {{ 'YES' if (valkey_tls_chain_valid is defined and valkey_tls_chain_valid.rc is defined and valkey_tls_chain_valid.rc == 0) else ('NOT CHECKED' if not (valkey_tls_ca_stat is defined and valkey_tls_ca_stat.stat is defined and valkey_tls_ca_stat.stat.exists) else 'FAILED') }} + +{% endif %} + +{% if valkey_tls_ca_stat is defined and valkey_tls_ca_stat.stat is defined and valkey_tls_ca_stat.stat.exists %} +#### CA Bundle Validity + +{% if valkey_tls_ca_dates is defined and valkey_tls_ca_dates.rc is defined and valkey_tls_ca_dates.rc == 0 %} +- **Not Before:** {{ valkey_tls_ca_dates.stdout | regex_search('notBefore=(.+)', '\\1') | first | default('Unknown') }} +- **Not After:** {{ valkey_tls_ca_dates.stdout | regex_search('notAfter=(.+)', '\\1') | first | default('Unknown') }} +- **Expiry Warning:** {{ 'EXPIRES WITHIN 30 DAYS' if (valkey_tls_ca_expiry_check is defined and valkey_tls_ca_expiry_check.rc is defined and valkey_tls_ca_expiry_check.rc == 1) else 'OK' }} +{% endif %} + +{% endif %} + +#### Live TLS Handshake + +{% if valkey_tls_handshake is defined and valkey_tls_handshake.rc is defined %} +Tested against: `{{ inventory_hostname }}:{{ valkey_port }}` + +``` +{{ valkey_tls_handshake.stdout | default('No output') }} +``` +{% else %} +Not tested (CA missing) +{% endif %} + +{% else %} +- **TLS Status:** DISABLED +{% endif %} + +--- + +## Valkey User Auth Tests + +**The following users were found:** + +{% if valkey_users is defined and valkey_users | length > 0 %} +{% for valkey in valkey_users %} +### User: {{ valkey.user | default('Unknown') }} +- **Enabled:** {{ valkey.enabled | default(false) }} +{% endfor %} + +### User Connection Test Results: +- **admin:** {{ 'PASSED ✓' if ((valkey_ping.rc | default(-1)) == 0 and 'PONG' in (valkey_ping.stdout | default(''))) else 'FAILED ✗' }} +- **itential:** {{ 'PASSED ✓' if ((valkey_itential_user_ping.rc | default(-1)) == 0 and 'PONG' in (valkey_itential_user_ping.stdout | default(''))) else 'FAILED ✗' }} +{% if valkey_has_replicas | default(false) | bool %} +- **repluser:** {{ 'PASSED ✓' if ((valkey_repl_user_ping.rc | default(-1)) == 0 and 'PONG' in (valkey_repl_user_ping.stdout | default(''))) else 'FAILED ✗' }} +{% endif %} +{% if valkey_has_sentinels | default(false) | bool %} +- **sentineluser:** {{ 'PASSED ✓' if ((valkey_sentineluser_user_ping.rc | default(-1)) == 0 and 'PONG' in (valkey_sentineluser_user_ping.stdout | default(''))) else 'FAILED ✗' }} +{% endif %} +{% if valkey_monitor_user_enabled | default(false) | bool %} +- **monitor:** {{ 'PASSED ✓' if ((valkey_monitor_user_ping.rc | default(-1)) == 0 and 'PONG' in (valkey_monitor_user_ping.stdout | default(''))) else 'FAILED ✗' }} +{% endif %} +{% else %} +No Valkey users were found! +{% endif %} + +--- + +## Recent Log Entries (Last 50 lines) + +``` +{{ valkey_logs.stdout | default('Log entries not available') if valkey_logs is defined else 'Log entries not available' }} +``` + +{% if sentinel_service_status is defined and sentinel_service_status.status is defined %} +--- + +## Sentinel Service Status + +- **Service Name:** {{ sentinel_service_status.name | default('Unknown') }} +- **Service State:** {{ sentinel_service_status.status.ActiveState | default('Unknown') }} +- **Service SubState:** {{ sentinel_service_status.status.SubState | default('Unknown') }} +- **Service Enabled:** {{ sentinel_service_status.status.UnitFileState | default('Unknown') }} + +**Process Running:** {{ 'YES ✓' if (sentinel_process is defined and sentinel_process.rc == 0) else 'NO' }} + +{% if sentinel_process is defined and sentinel_process.rc == 0 %} +**Process Details:** +``` +{{ sentinel_process.stdout | default('N/A') }} +``` +{% endif %} + +--- + +## Sentinel Connectivity + +- **Sentinel Port:** {{ valkey_sentinel_port | default('26379') }} +- **Ping Response:** {{ sentinel_ping.stdout | default('FAILED') if sentinel_ping is defined else 'FAILED' }} +- **Connection Status:** {{ 'SUCCESS ✓' if (sentinel_ping is defined and sentinel_ping.rc == 0) else 'FAILED' }} + +**Listening Ports:** +``` +{{ sentinel_ports.stdout | default('Could not determine') if sentinel_ports is defined else 'Could not determine' }} +``` + +--- + +## Sentinel Metrics (from INFO) + +{% if sentinel_metrics is defined %} +- **Valkey Version:** {{ sentinel_metrics.version | default(['N/A'], true) | first }} +- **Valkey Mode:** {{ sentinel_metrics.mode | default(['N/A'], true) | first }} +- **Monitored Masters:** {{ sentinel_metrics.masters | default(['N/A'], true) | first }} +{% else %} +Sentinel INFO not available +{% endif %} + +--- + +## Sentinel Master + +{% if itential_master is defined and itential_master.name is defined and itential_master.name == "itentialmaster" %} +**Number of Masters:** 1 +**Master Name:** {{ itential_master.name }} + +{% if monitored_master_details is defined %} +### Master Details: +- **IP:** {{ monitored_master_details.ip | default('N/A') }} +- **Connected Slaves:** {{ monitored_master_details["num-slaves"] | default('N/A') }} +- **Port:** {{ monitored_master_details.port | default('N/A') }} +- **Quorum:** {{ monitored_master_details.quorum | default('N/A') }} +- **Down After (ms):** {{ monitored_master_details["down-after-milliseconds"] | default('N/A') }} +- **Failover Timeout:** {{ monitored_master_details["failover-timeout"] | default('N/A') }} +- **Parallel Syncs:** {{ monitored_master_details["parallel-syncs"] | default('N/A') }} +{% endif %} +{% else %} +No masters are being monitored +{% endif %} + +--- + +## Sentinel Quorum Status + +{% if quorum_check_details is defined and quorum_check_details %} +- **Master:** {{ itential_master.name | default('Unknown') if itential_master is defined else 'Unknown' }} +- **Status:** {{ quorum_check_details }} +{% else %} +No quorum was found! +{% endif %} + +--- + +## Sentinel Known Sentinels + +**This Sentinel is aware of the following other Sentinels:** + +{% if known_sentinel_details is defined and known_sentinel_details | length > 0 %} +{% for sentinel in known_sentinel_details %} +### Sentinel: {{ sentinel.name | default('N/A') }} +- **IP:** {{ sentinel.ip | default('N/A') }} +- **Runid:** {{ sentinel.runid | default('N/A') }} +- **Port:** {{ sentinel.port | default('N/A') }} +- **Flags:** {{ sentinel.flags | default('N/A') }} + +{% endfor %} +{% else %} +No other Sentinels were found! +{% endif %} + +--- + +## Sentinel Known Replicas + +**This Sentinel is aware of the following Replicas:** + +{% if known_replica_details is defined and known_replica_details | length > 0 %} +{% for replica in known_replica_details %} +### Replica: {{ replica.name | default('N/A') }} +- **Master:** {{ replica["master-host"] | default('N/A') }}:{{ replica["master-port"] | default('N/A') }} +- **Master Connectivity:** {{ replica["master-link-status"] | default('N/A') }} +- **Replica Role:** {{ replica["role-reported"] | default('N/A') }} +- **Flags:** {{ replica.flags | default('N/A') }} + +{% endfor %} +{% else %} +No other Replicas were found! +{% endif %} + +--- + +## Sentinel Configuration File + +- **Config File Exists:** {{ sentinel_conf_file.stat.exists if (sentinel_conf_file is defined and sentinel_conf_file.stat is defined) else 'Unknown' }} +{% if sentinel_conf_file is defined and sentinel_conf_file.stat is defined and sentinel_conf_file.stat.exists %} +- **Config File Path:** `/etc/valkey/sentinel.conf` +- **Permissions:** {{ sentinel_conf_permissions.stdout | default('Unknown') if sentinel_conf_permissions is defined else 'Unknown' }} +{% endif %} + +- **Systemd Unit File:** {{ sentinel_systemd_file.stat.exists if (sentinel_systemd_file is defined and sentinel_systemd_file.stat is defined) else 'Unknown' }} +{% if sentinel_systemd_file is defined and sentinel_systemd_file.stat is defined and sentinel_systemd_file.stat.exists %} +- **Unit File Path:** `/etc/systemd/system/valkey-sentinel.service` +{% endif %} + +--- + +## Sentinel User Auth Tests + +**The following users were found:** + +{% if sentinel_users is defined and sentinel_users | length > 0 %} +{% for sentinel in sentinel_users %} +### User: {{ sentinel.user | default('Unknown') }} +- **Enabled:** {{ sentinel.enabled | default(false) }} +{% endfor %} + +### Connection Test Results: +- **admin:** {{ 'PASSED ✓' if ((sentinel_ping.rc | default(-1)) == 0 and 'PONG' in (sentinel_ping.stdout | default(''))) else 'FAILED ✗' }} +- **sentineluser:** {{ 'PASSED ✓' if ((sentinel_user_ping.rc | default(-1)) == 0 and 'PONG' in (sentinel_user_ping.stdout | default(''))) else 'FAILED ✗' }} +- **monitor:** {{ 'PASSED ✓' if ((sentinel_monitor_user_ping.rc | default(-1)) == 0 and 'PONG' in (sentinel_monitor_user_ping.stdout | default(''))) else 'FAILED ✗' }} +{% else %} +No Sentinel users were found! +{% endif %} + +--- + +## Sentinel Recent Log Entries (Last 50 lines) + +``` +{{ sentinel_logs.stdout | default('Log entries not available') if sentinel_logs is defined else 'Log entries not available' }} +``` + +{% endif %} + +--- + +## Validation Summary + +{% if sentinel_service_status is defined and sentinel_service_status.status is defined + and (valkey_service_status is not defined or valkey_service_status.status is not defined) %} +**Overall Status:** {{ 'PASSED ✓' if (sentinel_ping is defined and sentinel_ping.rc == 0 and sentinel_process is defined and sentinel_process.rc == 0) else 'FAILED' }} +{% else %} +**Overall Status:** {{ 'PASSED ✓' if (valkey_ping is defined and valkey_ping.rc == 0 and valkey_process is defined and valkey_process.rc == 0) else 'FAILED' }} +{% endif %} + +### Checks: + +{% if valkey_service_status is defined and valkey_service_status.status is defined %} +- **Valkey Service Exists:** YES ✓ +- **Valkey Service Active:** {{ valkey_service_status.status.ActiveState | default('unknown') | upper }} {{ '✓' if valkey_service_status.status.ActiveState == 'active' else '✗' }} +{% else %} +- **Valkey Service Exists:** NO ✗ +{% endif %} +- **Valkey Process Running:** {{ 'YES' if (valkey_process is defined and valkey_process.rc == 0) else 'NO' }} {{ '✓' if (valkey_process is defined and valkey_process.rc == 0) else '✗' }} +- **Valkey Responding:** {{ 'YES' if (valkey_ping is defined and valkey_ping.rc == 0) else 'NO' }} {{ '✓' if (valkey_ping is defined and valkey_ping.rc == 0) else '✗' }} +- **Valkey Config File Present:** {{ 'YES' if (valkey_conf_file is defined and valkey_conf_file.stat is defined and valkey_conf_file.stat.exists) else 'NO' }} {{ '✓' if (valkey_conf_file is defined and valkey_conf_file.stat is defined and valkey_conf_file.stat.exists) else '✗' }} +{% if sentinel_service_status is defined and sentinel_service_status.status is defined %} +- **Sentinel Service Exists:** YES ✓ +- **Sentinel Service Active:** {{ sentinel_service_status.status.ActiveState | default('unknown') | upper }} {{ '✓' if sentinel_service_status.status.ActiveState == 'active' else '✗' }} +- **Sentinel Process Running:** {{ 'YES' if (sentinel_process is defined and sentinel_process.rc == 0) else 'NO' }} {{ '✓' if (sentinel_process is defined and sentinel_process.rc == 0) else '✗' }} +- **Sentinel Responding:** {{ 'YES' if (sentinel_ping is defined and sentinel_ping.rc == 0) else 'NO' }} {{ '✓' if (sentinel_ping is defined and sentinel_ping.rc == 0) else '✗' }} +- **Sentinel Config File Present:** {{ 'YES' if (sentinel_conf_file is defined and sentinel_conf_file.stat is defined and sentinel_conf_file.stat.exists) else 'NO' }} {{ '✓' if (sentinel_conf_file is defined and sentinel_conf_file.stat is defined and sentinel_conf_file.stat.exists) else '✗' }} +- **Sentinel Monitoring:** {{ ([itential_master.name] if itential_master is defined and itential_master.name is defined else []) | length }} master(s) {{ '✓' if (itential_master is defined and itential_master.name is defined) else '✗' }} +- **Sentinel Quorum:** {{ 'OK' if (quorum_check_details is defined and 'OK' in quorum_check_details) else 'FAILED' }} {{ '✓' if (quorum_check_details is defined and 'OK' in quorum_check_details) else '✗' }} +{% else %} +- **Sentinel Service:** NOT RUNNING OR NOT DETECTED +{% endif %} + +--- + +**End of Report** \ No newline at end of file diff --git a/roles/valkey/templates/valkey.conf.j2 b/roles/valkey/templates/valkey.conf.j2 new file mode 100644 index 00000000..f6dcf466 --- /dev/null +++ b/roles/valkey/templates/valkey.conf.j2 @@ -0,0 +1,2117 @@ +# Valkey configuration file example. +# +# Note that in order to read the configuration file, Valkey must be +# started with the file path as first argument: +# +# ./valkey-server /path/to/valkey.conf + +# Note on units: when memory size is needed, it is possible to specify +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all Valkey servers but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +# Note that option "include" won't be rewritten by command "CONFIG REWRITE" +# from admin or Valkey Sentinel. Since Valkey always uses the last processed +# line as value of a configuration directive, you'd better put includes +# at the beginning of this file to avoid overwriting config change at runtime. +# +# If instead you are interested in using includes to override configuration +# options, it is better to use include as the last line. +# +# include /path/to/local.conf +# include /path/to/other.conf + +################################## MODULES ##################################### + +# Load modules at startup. If the server is not able to load modules +# it will abort. It is possible to use multiple loadmodule directives. +# +# loadmodule /path/to/my_module.so +# loadmodule /path/to/other_module.so + +################################## NETWORK ##################################### + +# By default, if no "bind" configuration directive is specified, Valkey listens +# for connections from all available network interfaces on the host machine. +# It is possible to listen to just one or multiple selected interfaces using +# the "bind" configuration directive, followed by one or more IP addresses. +# Each address can be prefixed by "-", which means that valkey will not fail to +# start if the address is not available. Being not available only refers to +# addresses that does not correspond to any network interfece. Addresses that +# are already in use will always fail, and unsupported protocols will always BE +# silently skipped. +# +# Examples: +# +# bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses +# bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6 +# bind * -::* # like the default, all available interfaces +# +# ~~~ WARNING ~~~ If the computer running Valkey is directly exposed to the +# internet, binding to all the interfaces is dangerous and will expose the +# instance to everybody on the internet. So by default we uncomment the +# following bind directive, that will force Valkey to listen only on the +# IPv4 and IPv6 (if available) loopback interface addresses (this means Valkey +# will only be able to accept client connections from the same host that it is +# running on). +# +# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES +# JUST COMMENT OUT THE FOLLOWING LINE. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +bind {{ valkey_bind }} + +# Protected mode is a layer of security protection, in order to avoid that +# Valkey instances left open on the internet are accessed and exploited. +# +# When protected mode is on and if: +# +# 1) The server is not binding explicitly to a set of addresses using the +# "bind" directive. +# 2) No password is configured. +# +# The server only accepts connections from clients connecting from the +# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain +# sockets. +# +# By default protected mode is enabled. You should disable it only if +# you are sure you want clients from other hosts to connect to Valkey +# even if no authentication is configured, nor a specific set of interfaces +# are explicitly listed using the "bind" directive. +# +# Itential recommends binding to specific addresses. Therefore, we recommend +# to disable protected mode +protected-mode no + +# Accept connections on the specified port, default is 6379 (IANA #815344). +# If port 0 is specified Valkey will not listen on a TCP socket. +port {{ valkey_port }} + +# TCP listen() backlog. +# +# In high requests-per-second environments you need a high backlog in order +# to avoid slow clients connection issues. Note that the Linux kernel +# will silently truncate it to the value of /proc/sys/net/core/somaxconn so +# make sure to raise both the value of somaxconn and tcp_max_syn_backlog +# in order to get the desired effect. +tcp-backlog 511 + +# Unix socket. +# +# Specify the path for the Unix socket that will be used to listen for +# incoming connections. There is no default, so Valkey will not listen +# on a unix socket when not specified. +# +# unixsocket /run/valkey.sock +# unixsocketperm 700 + +# Close the connection after a client is idle for N seconds (0 to disable) +timeout 0 + +# TCP keepalive. +# +# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence +# of communication. This is useful for two reasons: +# +# 1) Detect dead peers. +# 2) Force network equipment in the middle to consider the connection to be +# alive. +# +# On Linux, the specified value (in seconds) is the period used to send ACKs. +# Note that to close the connection the double of the time is needed. +# On other kernels the period depends on the kernel configuration. +# +# A reasonable value for this option is 300 seconds, which is the new +# Valkey default starting with Valkey 3.2.1. +tcp-keepalive 60 + +################################# TLS/SSL ##################################### + +# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration +# directive can be used to define TLS-listening ports. To enable TLS on the +# default port, use: +# +{% if valkey_tls_enabled | bool %} +port 0 +tls-port {{ valkey_port }} +{% else %} +# port 0 +# tls-port 6379 +{% endif %} + +# Configure a X.509 certificate and private key to use for authenticating the +# server to connected clients, masters or cluster peers. These files should be +# PEM formatted. +# +{% if valkey_tls_enabled | bool %} +tls-cert-file {{ valkey_tls_cert_dest }} +tls-key-file {{ valkey_tls_key_dest }} +{% else %} +# tls-cert-file valkey.crt +# tls-key-file valkey.key +{% endif %} +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-key-file-pass secret + +# Normally Valkey uses the same certificate for both server functions (accepting +# connections) and client functions (replicating from a master, establishing +# cluster bus connections, etc.). +# +# Sometimes certificates are issued with attributes that designate them as +# client-only or server-only certificates. In that case it may be desired to use +# different certificates for incoming (server) and outgoing (client) +# connections. To do that, use the following directives: +# +# tls-client-cert-file client.crt +# tls-client-key-file client.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-client-key-file-pass secret + +# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange, +# required by older versions of OpenSSL (<3.0). Newer versions do not require +# this configuration and recommend against it. +# +# tls-dh-params-file valkey.dh + +# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL +# clients and peers. Valkey requires an explicit configuration of at least one +# of these, and will not implicitly use the system wide configuration. +# +{% if valkey_tls_enabled | bool %} +tls-ca-cert-file {{ valkey_tls_ca_dest }} +{% else %} +# tls-ca-cert-file ca.crt +# tls-ca-cert-dir /etc/ssl/certs +{% endif %} + +# By default, clients (including replica servers) on a TLS port are required +# to authenticate using valid client side certificates. +# +# If "no" is specified, client certificates are not required and not accepted. +# If "optional" is specified, client certificates are accepted and must be +# valid if provided, but are not required. +# +{% if valkey_tls_enabled | bool %} +tls-auth-clients {{ valkey_tls_auth_clients }} +{% endif %} +# tls-auth-clients no +# tls-auth-clients optional + +# By default, a Valkey replica does not attempt to establish a TLS connection +# with its master. +# +# Use the following directive to enable TLS on replication links. +# +{% if valkey_tls_enabled | bool and valkey_has_replicas | bool %} +tls-replication yes +{% else %} +# tls-replication yes +{% endif %} + +# By default, the Valkey Cluster bus uses a plain TCP connection. To enable +# TLS for the bus protocol, use the following directive: +# +# tls-cluster yes + +# By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended +# that older formally deprecated versions are kept disabled to reduce the attack surface. +# You can explicitly specify TLS versions to support. +# Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2", +# "TLSv1.3" (OpenSSL >= 1.1.1) or any combination. +# To enable only TLSv1.2 and TLSv1.3, use: +# +{% if valkey_tls_enabled | bool %} +tls-protocols "{{ valkey_tls_protocols }}" +{% else %} +# tls-protocols "TLSv1.3" +{% endif %} + +# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information +# about the syntax of this string. +# +# Note: this configuration applies only to <= TLSv1.2. +# +# tls-ciphers DEFAULT:!MEDIUM + +# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more +# information about the syntax of this string, and specifically for TLSv1.3 +# ciphersuites. +# +# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 + +# When choosing a cipher, use the server's preference instead of the client +# preference. By default, the server follows the client's preference. +# +# tls-prefer-server-ciphers yes + +# By default, TLS session caching is enabled to allow faster and less expensive +# reconnections by clients that support it. Use the following directive to disable +# caching. +# +# tls-session-caching no + +# Change the default number of TLS sessions cached. A zero value sets the cache +# to unlimited size. The default size is 20480. +# +# tls-session-cache-size 5000 + +# Change the default timeout of cached TLS sessions. The default timeout is 300 +# seconds. +# +# tls-session-cache-timeout 60 + +################################# GENERAL ##################################### + +# By default Valkey does not run as a daemon. Use 'yes' if you need it. +# Note that Valkey will write a pid file in /var/run/valkey.pid when daemonized. +# When Valkey is supervised by upstart or systemd, this parameter has no impact. +daemonize no + +# If you run Valkey from upstart or systemd, Valkey can interact with your +# supervision tree. Options: +# supervised no - no supervision interaction +# supervised upstart - signal upstart by putting Valkey into SIGSTOP mode +# requires "expect stop" in your upstart job config +# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET +# on startup, and updating Valkey status on a regular +# basis. +# supervised auto - detect upstart or systemd method based on +# UPSTART_JOB or NOTIFY_SOCKET environment variables +# Note: these supervision methods only signal "process is ready." +# They do not enable continuous pings back to your supervisor. +# +# The default is "no". To run under upstart/systemd, you can simply uncomment +# the line below: +# +# supervised auto + +# If a pid file is specified, Valkey writes it where specified at startup +# and removes it at exit. +# +# When the server runs non daemonized, no pid file is created if none is +# specified in the configuration. When the server is daemonized, the pid file +# is used even if not specified, defaulting to "/var/run/valkey.pid". +# +# Creating a pid file is best effort: if Valkey is not able to create it +# nothing bad happens, the server will start and run normally. +# +# Note that on modern Linux systems "/run/valkey.pid" is more conforming +# and should be used instead. +# pidfile /run/valkey.pid + +# Specify the server verbosity level. +# This can be one of: +# debug (a lot of information, useful for development/testing) +# verbose (many rarely useful info, but not a mess like the debug level) +# notice (moderately verbose, what you want in production probably) +# warning (only very important / critical messages are logged) +loglevel notice + +# Specify the log file name. Also the empty string can be used to force +# Valkey to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile "{{ valkey_log }}" + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +# syslog-enabled no + +# Specify the syslog identity. +# syslog-ident valkey + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +# syslog-facility local0 + +# To disable the built in crash log, which will possibly produce cleaner core +# dumps when they are needed, uncomment the following: +# +# crash-log-enabled no + +# To disable the fast memory check that's run as part of the crash log, which +# will possibly let valkey terminate sooner, uncomment the following: +# +# crash-memcheck-enabled no + +# Set the number of databases. The default database is DB 0, you can select +# a different one on a per-connection basis using SELECT where +# dbid is a number between 0 and 'databases'-1 +databases 16 + +# By default Valkey shows an ASCII art logo only when started to log to the +# standard output and if the standard output is a TTY and syslog logging is +# disabled. Basically this means that normally a logo is displayed only in +# interactive sessions. +# +# However it is possible to force the pre-4.0 behavior and always show a +# ASCII art logo in startup logs by setting the following option to yes. +always-show-logo no + +# By default, Valkey modifies the process title (as seen in 'top' and 'ps') to +# provide some runtime information. It is possible to disable this and leave +# the process name as executed by setting the following to no. +set-proc-title yes + +# When changing the process title, Valkey uses the following template to construct +# the modified title. +# +# Template variables are specified in curly brackets. The following variables are +# supported: +# +# {title} Name of process as executed if parent, or type of child process. +# {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or +# Unix socket if only that's available. +# {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]". +# {port} TCP port listening on, or 0. +# {tls-port} TLS port listening on, or 0. +# {unixsocket} Unix domain socket listening on, or "". +# {config-file} Name of configuration file used. +# +proc-title-template "{title} {listen-addr} {server-mode}" + +################################ SNAPSHOTTING ################################ + +# Save the DB to disk. +# +# save +# +# Valkey will save the DB if both the given number of seconds and the given +# number of write operations against the DB occurred. +# +# Snapshotting can be completely disabled with a single empty string argument +# as in following example: +# +# save "" +# +# Unless specified otherwise, by default Valkey will save the DB: +# * After 3600 seconds (an hour) if at least 1 key changed +# * After 300 seconds (5 minutes) if at least 100 keys changed +# * After 60 seconds if at least 10000 keys changed +# +# You can set these explicitly by uncommenting the three following lines. +# +# save 3600 1 +# save 300 100 +# save 60 10000 + +# By default Valkey will stop accepting writes if RDB snapshots are enabled +# (at least one save point) and the latest background save failed. +# This will make the user aware (in a hard way) that data is not persisting +# on disk properly, otherwise chances are that no one will notice and some +# disaster will happen. +# +# If the background saving process will start working again Valkey will +# automatically allow writes again. +# +# However if you have setup your proper monitoring of the Valkey server +# and persistence, you may want to disable this feature so that Valkey will +# continue to work as usual even if there are problems with disk, +# permissions, and so forth. +stop-writes-on-bgsave-error yes + +# Compress string objects using LZF when dump .rdb databases? +# By default compression is enabled as it's almost always a win. +# If you want to save some CPU in the saving child set it to 'no' but +# the dataset will likely be bigger if you have compressible values or keys. +rdbcompression yes + +# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. +# This makes the format more resistant to corruption but there is a performance +# hit to pay (around 10%) when saving and loading RDB files, so you can disable it +# for maximum performances. +# +# RDB files created with checksum disabled have a checksum of zero that will +# tell the loading code to skip the check. +rdbchecksum yes + +# Enables or disables full sanitation checks for ziplist and listpack etc when +# loading an RDB or RESTORE payload. This reduces the chances of a assertion or +# crash later on while processing commands. +# Options: +# no - Never perform full sanitation +# yes - Always perform full sanitation +# clients - Perform full sanitation only for user connections. +# Excludes: RDB files, RESTORE commands received from the master +# connection, and client connections which have the +# skip-sanitize-payload ACL flag. +# The default should be 'clients' but since it currently affects cluster +# resharding via MIGRATE, it is temporarily set to 'no' by default. +# +# sanitize-dump-payload no + +# The filename where to dump the DB +dbfilename {{ valkey_db_filename }} + +# Remove RDB files used by replication in instances without persistence +# enabled. By default this option is disabled, however there are environments +# where for regulations or other security concerns, RDB files persisted on +# disk by masters in order to feed replicas, or stored on disk by replicas +# in order to load them for the initial synchronization, should be deleted +# ASAP. Note that this option ONLY WORKS in instances that have both AOF +# and RDB persistence disabled, otherwise is completely ignored. +# +# An alternative (and sometimes better) way to obtain the same effect is +# to use diskless replication on both master and replicas instances. However +# in the case of replicas, diskless is not always an option. +rdb-del-sync-files no + +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# The Append Only File will also be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir {{ valkey_data_dir }} + +################################# REPLICATION ################################# + +# Master-Replica replication. Use replicaof to make a Valkey instance a copy of +# another Valkey server. A few things to understand ASAP about Valkey replication. +# +# +------------------+ +---------------+ +# | Master | ---> | Replica | +# | (receive writes) | | (exact copy) | +# +------------------+ +---------------+ +# +# 1) Valkey replication is asynchronous, but you can configure a master to +# stop accepting writes if it appears to be not connected with at least +# a given number of replicas. +# 2) Valkey replicas are able to perform a partial resynchronization with the +# master if the replication link is lost for a relatively small amount of +# time. You may want to configure the replication backlog size (see the next +# sections of this file) with a sensible value depending on your needs. +# 3) Replication is automatic and does not need user intervention. After a +# network partition replicas automatically try to reconnect to masters +# and resynchronize with them. +# +# replicaof +{% if valkey_is_replica_node %} +replicaof {{ valkey_replicaof }} +{% endif %} + +# If the master is password protected (using the "requirepass" configuration +# directive below) it is possible to tell the replica to authenticate before +# starting the replication synchronization process, otherwise the master will +# refuse the replica request. +# +# masterauth +# +# However this is not enough if you are using Valkey ACLs (for Valkey version +# 6 or greater), and the default user is not capable of running the PSYNC +# command and/or other commands needed for replication. In this case it's +# better to configure a special user to use with replication, and specify the +# masteruser configuration as such: +# +# masteruser +# +# When masteruser is specified, the replica will authenticate against its +# master using the new AUTH form: AUTH . +{% if valkey_is_data_node and valkey_auth_enabled %} +masterauth {{ valkey_user_repluser_password }} +masteruser repluser +{% endif %} + +# When a replica loses its connection with the master, or when the replication +# is still in progress, the replica can act in two different ways: +# +# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will +# still reply to client requests, possibly with out of date data, or the +# data set may just be empty if this is the first synchronization. +# +# 2) If replica-serve-stale-data is set to 'no' the replica will reply with +# an error "SYNC with master in progress" to all commands except: +# INFO, REPLICAOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE, +# UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST, +# HOST and LATENCY. +# +replica-serve-stale-data yes + +# You can configure a replica instance to accept writes or not. Writing against +# a replica instance may be useful to store some ephemeral data (because data +# written on a replica will be easily deleted after resync with the master) but +# may also cause problems if clients are writing to it because of a +# misconfiguration. +# +# Since Valkey 2.6 by default replicas are read-only. +# +# Note: read only replicas are not designed to be exposed to untrusted clients +# on the internet. It's just a protection layer against misuse of the instance. +# Still a read only replica exports by default all the administrative commands +# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve +# security of read only replicas using 'rename-command' to shadow all the +# administrative / dangerous commands. +replica-read-only yes + +# Replication SYNC strategy: disk or socket. +# +# New replicas and reconnecting replicas that are not able to continue the +# replication process just receiving differences, need to do what is called a +# "full synchronization". An RDB file is transmitted from the master to the +# replicas. +# +# The transmission can happen in two different ways: +# +# 1) Disk-backed: The Valkey master creates a new process that writes the RDB +# file on disk. Later the file is transferred by the parent +# process to the replicas incrementally. +# 2) Diskless: The Valkey master creates a new process that directly writes the +# RDB file to replica sockets, without touching the disk at all. +# +# With disk-backed replication, while the RDB file is generated, more replicas +# can be queued and served with the RDB file as soon as the current child +# producing the RDB file finishes its work. With diskless replication instead +# once the transfer starts, new replicas arriving will be queued and a new +# transfer will start when the current one terminates. +# +# When diskless replication is used, the master waits a configurable amount of +# time (in seconds) before starting the transfer in the hope that multiple +# replicas will arrive and the transfer can be parallelized. +# +# With slow disks and fast (large bandwidth) networks, diskless replication +# works better. +repl-diskless-sync no + +# When diskless replication is enabled, it is possible to configure the delay +# the server waits in order to spawn the child that transfers the RDB via socket +# to the replicas. +# +# This is important since once the transfer starts, it is not possible to serve +# new replicas arriving, that will be queued for the next RDB transfer, so the +# server waits a delay in order to let more replicas arrive. +# +# The delay is specified in seconds, and by default is 5 seconds. To disable +# it entirely just set it to 0 seconds and the transfer will start ASAP. +repl-diskless-sync-delay 5 + +# ----------------------------------------------------------------------------- +# WARNING: RDB diskless load is experimental. Since in this setup the replica +# does not immediately store an RDB on disk, it may cause data loss during +# failovers. RDB diskless load + Valkey modules not handling I/O reads may also +# cause Valkey to abort in case of I/O errors during the initial synchronization +# stage with the master. Use only if you know what you are doing. +# ----------------------------------------------------------------------------- +# +# Replica can load the RDB it reads from the replication link directly from the +# socket, or store the RDB to a file and read that file after it was completely +# received from the master. +# +# In many cases the disk is slower than the network, and storing and loading +# the RDB file may increase replication time (and even increase the master's +# Copy on Write memory and salve buffers). +# However, parsing the RDB file directly from the socket may mean that we have +# to flush the contents of the current database before the full rdb was +# received. For this reason we have the following options: +# +# "disabled" - Don't use diskless load (store the rdb file to the disk first) +# "on-empty-db" - Use diskless load only when it is completely safe. +# "swapdb" - Keep a copy of the current db contents in RAM while parsing +# the data directly from the socket. note that this requires +# sufficient memory, if you don't have it, you risk an OOM kill. +repl-diskless-load disabled + +# Replicas send PINGs to server in a predefined interval. It's possible to +# change this interval with the repl_ping_replica_period option. The default +# value is 10 seconds. +# +# repl-ping-replica-period 10 +repl-ping-replica-period 5 + +# The following option sets the replication timeout for: +# +# 1) Bulk transfer I/O during SYNC, from the point of view of replica. +# 2) Master timeout from the point of view of replicas (data, pings). +# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-replica-period otherwise a timeout will be detected +# every time there is low traffic between the master and the replica. The default +# value is 60 seconds. +# +# repl-timeout 60 +repl-timeout 30 + +# Disable TCP_NODELAY on the replica socket after SYNC? +# +# If you select "yes" Valkey will use a smaller number of TCP packets and +# less bandwidth to send data to replicas. But this can add a delay for +# the data to appear on the replica side, up to 40 milliseconds with +# Linux kernels using a default configuration. +# +# If you select "no" the delay for data to appear on the replica side will +# be reduced but more bandwidth will be used for replication. +# +# By default we optimize for low latency, but in very high traffic conditions +# or when the master and replicas are many hops away, turning this to "yes" may +# be a good idea. +repl-disable-tcp-nodelay no + +# Set the replication backlog size. The backlog is a buffer that accumulates +# replica data when replicas are disconnected for some time, so that when a +# replica wants to reconnect again, often a full resync is not needed, but a +# partial resync is enough, just passing the portion of data the replica +# missed while disconnected. +# +# The bigger the replication backlog, the longer the replica can endure the +# disconnect and later be able to perform a partial resynchronization. +# +# The backlog is only allocated if there is at least one replica connected. +# +# repl-backlog-size 1mb +repl-backlog-size 536870912 + +# After a master has no connected replicas for some time, the backlog will be +# freed. The following option configures the amount of seconds that need to +# elapse, starting from the time the last replica disconnected, for the backlog +# buffer to be freed. +# +# Note that replicas never free the backlog for timeout, since they may be +# promoted to masters later, and should be able to correctly "partially +# resynchronize" with other replicas: hence they should always accumulate backlog. +# +# A value of 0 means to never release the backlog. +# +# repl-backlog-ttl 3600 + +# The replica priority is an integer number published by Valkey in the INFO +# output. It is used by Valkey Sentinel in order to select a replica to promote +# into a master if the master is no longer working correctly. +# +# A replica with a low priority number is considered better for promotion, so +# for instance if there are three replicas with priority 10, 100, 25 Sentinel +# will pick the one with priority 10, that is the lowest. +# +# However a special priority of 0 marks the replica as not able to perform the +# role of master, so a replica with priority of 0 will never be selected by +# Valkey Sentinel for promotion. +# +# By default the priority is 100. +{% if valkey_is_data_node %} +replica-priority {{ valkey_replica_priority_final | default(100) }} +{% endif %} + +# ----------------------------------------------------------------------------- +# By default, Valkey Sentinel includes all replicas in its reports. A replica +# can be excluded from Valkey Sentinel's announcements. An unannounced replica +# will be ignored by the 'sentinel replicas ' command and won't be +# exposed to Valkey Sentinel's clients. +# +# This option does not change the behavior of replica-priority. Even with +# replica-announced set to 'no', the replica can be promoted to master. To +# prevent this behavior, set replica-priority to 0. +# +# replica-announced yes + +# It is possible for a master to stop accepting writes if there are less than +# N replicas connected, having a lag less or equal than M seconds. +# +# The N replicas need to be in "online" state. +# +# The lag in seconds, that must be <= the specified value, is calculated from +# the last ping received from the replica, that is usually sent every second. +# +# This option does not GUARANTEE that N replicas will accept the write, but +# will limit the window of exposure for lost writes in case not enough replicas +# are available, to the specified number of seconds. +# +# For example to require at least 3 replicas with a lag <= 10 seconds use: +# +# min-replicas-to-write 3 +# min-replicas-max-lag 10 +# +# Setting one or the other to 0 disables the feature. +# +# By default min-replicas-to-write is set to 0 (feature disabled) and +# min-replicas-max-lag is set to 10. +{% if valkey_is_master_node and valkey_has_replicas %} +min-replicas-to-write 1 +min-replicas-max-lag 10 +{% endif %} + +# A Valkey master is able to list the address and port of the attached +# replicas in different ways. For example the "INFO replication" section +# offers this information, which is used, among other tools, by +# Valkey Sentinel in order to discover replica instances. +# Another place where this info is available is in the output of the +# "ROLE" command of a master. +# +# The listed IP address and port normally reported by a replica is +# obtained in the following way: +# +# IP: The address is auto detected by checking the peer address +# of the socket used by the replica to connect with the master. +# +# Port: The port is communicated by the replica during the replication +# handshake, and is normally the port that the replica is using to +# listen for connections. +# +# However when port forwarding or Network Address Translation (NAT) is +# used, the replica may actually be reachable via different IP and port +# pairs. The following two options can be used by a replica in order to +# report to its master a specific set of IP and port, so that both INFO +# and ROLE will report those values. +# +# There is no need to use both the options if you need to override just +# the port or the IP address. +# +{% if valkey_is_data_node %} +replica-announce-ip {{ inventory_hostname }} +replica-announce-port {{ valkey_port }} +{% endif %} +# replica-announce-ip 5.5.5.5 +# replica-announce-port 1234 + +############################### KEYS TRACKING ################################# + +# Valkey implements server assisted support for client side caching of values. +# This is implemented using an invalidation table that remembers, using +# a radix key indexed by key name, what clients have which keys. In turn +# this is used in order to send invalidation messages to clients. Please +# check this page to understand more about the feature: +# +# https://valkey.io/topics/client-side-caching +# +# When tracking is enabled for a client, all the read only queries are assumed +# to be cached: this will force Valkey to store information in the invalidation +# table. When keys are modified, such information is flushed away, and +# invalidation messages are sent to the clients. However if the workload is +# heavily dominated by reads, Valkey could use more and more memory in order +# to track the keys fetched by many clients. +# +# For this reason it is possible to configure a maximum fill value for the +# invalidation table. By default it is set to 1M of keys, and once this limit +# is reached, Valkey will start to evict keys in the invalidation table +# even if they were not modified, just to reclaim memory: this will in turn +# force the clients to invalidate the cached values. Basically the table +# maximum size is a trade off between the memory you want to spend server +# side to track information about who cached what, and the ability of clients +# to retain cached objects in memory. +# +# If you set the value to 0, it means there are no limits, and Valkey will +# retain as many keys as needed in the invalidation table. +# In the "stats" INFO section, you can find information about the number of +# keys in the invalidation table at every given moment. +# +# Note: when key tracking is used in broadcasting mode, no memory is used +# in the server side so this setting is useless. +# +# tracking-table-max-keys 1000000 + +################################## SECURITY ################################### + +# Warning: since Valkey is pretty fast, an outside user can try up to +# 1 million passwords per second against a modern box. This means that you +# should use very strong passwords, otherwise they will be very easy to break. +# Note that because the password is really a shared secret between the client +# and the server, and should not be memorized by any human, the password +# can be easily a long string from /dev/urandom or whatever, so by using a +# long and unguessable password no brute force attack will be possible. + +# Valkey ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 +# +# The special username "default" is used for new connections. If this user +# has the "nopass" rule, then new connections will be immediately authenticated +# as the "default" user without the need of any password provided via the +# AUTH command. Otherwise if the "default" user is not flagged with "nopass" +# the connections will start in not authenticated state, and will require +# AUTH (or the HELLO command AUTH option) in order to be authenticated and +# start to work. +# +# The ACL rules that describe what a user can do are the following: +# +# on Enable the user: it is possible to authenticate as this user. +# off Disable the user: it's no longer possible to authenticate +# with this user, however the already authenticated connections +# will still work. +# skip-sanitize-payload RESTORE dump-payload sanitation is skipped. +# sanitize-payload RESTORE dump-payload is sanitized (default). +# + Allow the execution of that command +# - Disallow the execution of that command +# +@ Allow the execution of all the commands in such category +# with valid categories are like @admin, @set, @sortedset, ... +# and so forth, see the full list in the server.c file where +# the Valkey command table is described and defined. +# The special category @all means all the commands, but currently +# present in the server, and that will be loaded in the future +# via modules. +# +|subcommand Allow a specific subcommand of an otherwise +# disabled command. Note that this form is not +# allowed as negative like -DEBUG|SEGFAULT, but +# only additive starting with "+". +# allcommands Alias for +@all. Note that it implies the ability to execute +# all the future commands loaded via the modules system. +# nocommands Alias for -@all. +# ~ Add a pattern of keys that can be mentioned as part of +# commands. For instance ~* allows all the keys. The pattern +# is a glob-style pattern like the one of KEYS. +# It is possible to specify multiple patterns. +# allkeys Alias for ~* +# resetkeys Flush the list of allowed keys patterns. +# & Add a glob-style pattern of Pub/Sub channels that can be +# accessed by the user. It is possible to specify multiple channel +# patterns. +# allchannels Alias for &* +# resetchannels Flush the list of allowed channel patterns. +# > Add this password to the list of valid password for the user. +# For example >mypass will add "mypass" to the list. +# This directive clears the "nopass" flag (see later). +# < Remove this password from the list of valid passwords. +# nopass All the set passwords of the user are removed, and the user +# is flagged as requiring no password: it means that every +# password will work against this user. If this directive is +# used for the default user, every new connection will be +# immediately authenticated with the default user without +# any explicit AUTH command required. Note that the "resetpass" +# directive will clear this condition. +# resetpass Flush the list of allowed passwords. Moreover removes the +# "nopass" status. After "resetpass" the user has no associated +# passwords and there is no way to authenticate without adding +# some password (or setting it as "nopass" later). +# reset Performs the following actions: resetpass, resetkeys, off, +# -@all. The user returns to the same state it has immediately +# after its creation. +# +# ACL rules can be specified in any order: for instance you can start with +# passwords, then flags, or key patterns. However note that the additive +# and subtractive rules will CHANGE MEANING depending on the ordering. +# For instance see the following example: +# +# user alice on +@all -DEBUG ~* >somepassword +# +# This will allow "alice" to use all the commands with the exception of the +# DEBUG command, since +@all added all the commands to the set of the commands +# alice can use, and later DEBUG was removed. However if we invert the order +# of two ACL rules the result will be different: +# +# user alice on -DEBUG +@all ~* >somepassword +# +# Now DEBUG was removed when alice had yet no commands in the set of allowed +# commands, later all the commands are added, so the user will be able to +# execute everything. +# +# Basically ACL rules are processed left-to-right. +# +# For more information about ACL configuration please refer to +# the Valkey web site at https://valkey.io/topics/acl +{% if valkey_auth_enabled %} +user default off +user admin on allkeys allchannels allcommands >{{ valkey_user_admin_password }} +user itential on ~* &* -@all +@read +@write +@stream +@transaction +@sortedset +@list +@hash +@string +@fast +@scripting +@connection +@pubsub +script|load +script|exists -script|flush -flushall -flushdb -save -bgsave -bgrewriteaof -replicaof -psync -replconf -shutdown -failover -cluster -asking -sync -readonly -readwrite +info +role >{{ valkey_user_itential_password }} +{% if valkey_monitor_user_enabled and valkey_user_monitor_password %} +user monitor on sanitize-payload ~* resetchannels -@all +@connection +memory -readonly +strlen +config|get +xinfo +pfcount -quit +zcard +type +xlen -readwrite -command +client -wait +scard +llen +hlen +get +eval +slowlog +cluster|info +cluster|slots +cluster|nodes -hello -echo +info +latency +scan -reset -auth -asking +evalsha +memory|usage +xinfo|stream >{{ valkey_user_monitor_password }} +{% endif %} +{% if valkey_is_data_node %} +{% if valkey_has_replicas %} +user repluser on allchannels +psync +replconf +ping >{{ valkey_user_repluser_password }} +{% endif %} +{% if valkey_has_sentinels %} +user sentineluser on &* -@all +slaveof +ping +info +role +publish +subscribe +psubscribe +punsubscribe +client|setname +client|kill +multi +exec +replicaof +script|kill +config|rewrite >{{ valkey_user_sentineluser_password }} +{% endif %} +{% endif %} +{% endif %} + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the external +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside valkey.conf to describe users. +# +# aclfile /etc/valkey/users.acl + +# IMPORTANT NOTE: starting with Valkey 6 "requirepass" is just a compatibility +# layer on top of the new ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# The requirepass is not compatable with aclfile option and the ACL LOAD +# command, these will cause requirepass to be ignored. +# +# requirepass foobared + +# New users are initialized with restrictive permissions by default, via the +# equivalent of this ACL rule 'off resetkeys -@all'. Starting with Valkey 6.2, it +# is possible to manage access to Pub/Sub channels with ACL rules as well. The +# default Pub/Sub channels permission if new users is controlled by the +# acl-pubsub-default configuration directive, which accepts one of these values: +# +# allchannels: grants access to all Pub/Sub channels +# resetchannels: revokes access to all Pub/Sub channels +# +# To ensure backward compatibility while upgrading Valkey 6.0, acl-pubsub-default +# defaults to the 'allchannels' permission. +# +# Future compatibility note: it is very likely that in a future version of Valkey +# the directive's default of 'allchannels' will be changed to 'resetchannels' in +# order to provide better out-of-the-box Pub/Sub security. Therefore, it is +# recommended that you explicitly define Pub/Sub permissions for all users +# rather then rely on implicit default values. Once you've set explicit +# Pub/Sub for all existing users, you should uncomment the following line. +# +# acl-pubsub-default resetchannels + +# Command renaming (DEPRECATED). +# +# ------------------------------------------------------------------------ +# WARNING: avoid using this option if possible. Instead use ACLs to remove +# commands from the default user, and put them only in some admin user you +# create for administrative purposes. +# ------------------------------------------------------------------------ +# +# It is possible to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# hard to guess so that it will still be available for internal-use tools +# but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possible to completely kill a command by renaming it into +# an empty string: +# +# rename-command CONFIG "" +# +# Please note that changing the name of commands that are logged into the +# AOF file or transmitted to replicas may cause problems. + +################################### CLIENTS #################################### + +# Set the max number of connected clients at the same time. By default +# this limit is set to 10000 clients, however if the Valkey server is not +# able to configure the process file limit to allow for the specified limit +# the max number of allowed clients is set to the current file limit +# minus 32 (as Valkey reserves a few file descriptors for internal uses). +# +# Once the limit is reached Valkey will close all the new connections sending +# an error 'max number of clients reached'. +# +# IMPORTANT: When Valkey Cluster is used, the max number of connections is also +# shared with the cluster bus: every node in the cluster will use two +# connections, one incoming and another outgoing. It is important to size the +# limit accordingly in case of very large clusters. +# +# maxclients 10000 + +############################## MEMORY MANAGEMENT ################################ + +# Set a memory usage limit to the specified amount of bytes. +# When the memory limit is reached Valkey will try to remove keys +# according to the eviction policy selected (see maxmemory-policy). +# +# If Valkey can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Valkey will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. +# +# This option is usually useful when using Valkey as an LRU or LFU cache, or to +# set a hard memory limit for an instance (using the 'noeviction' policy). +# +# WARNING: If you have replicas attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the replicas are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of replicas is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have replicas attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for replica +# output buffers (but this is not needed if the policy is 'noeviction'). +# +maxmemory {{ valkey_maxmemory_bytes }} + +# MAXMEMORY POLICY: how Valkey will select what to remove when maxmemory +# is reached. You can select one from the following behaviors: +# +# volatile-lru -> Evict using approximated LRU, only keys with an expire set. +# allkeys-lru -> Evict any key using approximated LRU. +# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. +# allkeys-lfu -> Evict any key using approximated LFU. +# volatile-random -> Remove a random key having an expire set. +# allkeys-random -> Remove a random key, any key. +# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) +# noeviction -> Don't evict anything, just return an error on write operations. +# +# LRU means Least Recently Used +# LFU means Least Frequently Used +# +# Both LRU, LFU and volatile-ttl are implemented using approximated +# randomized algorithms. +# +# Note: with any of the above policies, when there are no suitable keys for +# eviction, Valkey will return an error on write operations that require +# more memory. These are usually commands that create new keys, add data or +# modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE, +# SORT (due to the STORE argument), and EXEC (if the transaction includes any +# command that requires memory). +# +# The default is: +# +maxmemory-policy noeviction + +# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can tune it for speed or +# accuracy. By default Valkey will check five keys and pick the one that was +# used least recently, you can change the sample size using the following +# configuration directive. +# +# The default of 5 produces good enough results. 10 Approximates very closely +# true LRU but costs more CPU. 3 is faster but not very accurate. +# +# maxmemory-samples 5 + +# Eviction processing is designed to function well with the default setting. +# If there is an unusually large amount of write traffic, this value may need to +# be increased. Decreasing this value may reduce latency at the risk of +# eviction processing effectiveness +# 0 = minimum latency, 10 = default, 100 = process without regard to latency +# +# maxmemory-eviction-tenacity 10 + +# Starting from Valkey 5, by default a replica will ignore its maxmemory setting +# (unless it is promoted to master after a failover or manually). It means +# that the eviction of keys will be just handled by the master, sending the +# DEL commands to the replica as keys evict in the master side. +# +# This behavior ensures that masters and replicas stay consistent, and is usually +# what you want, however if your replica is writable, or you want the replica +# to have a different memory setting, and you are sure all the writes performed +# to the replica are idempotent, then you may change this default (but be sure +# to understand what you are doing). +# +# Note that since the replica by default does not evict, it may end using more +# memory than the one set via maxmemory (there are certain buffers that may +# be larger on the replica, or data structures may sometimes take more memory +# and so forth). So make sure you monitor your replicas and make sure they +# have enough memory to never hit a real out-of-memory condition before the +# master hits the configured maxmemory setting. +# +# replica-ignore-maxmemory yes + +# Valkey reclaims expired keys in two ways: upon access when those keys are +# found to be expired, and also in background, in what is called the +# "active expire key". The key space is slowly and interactively scanned +# looking for expired keys to reclaim, so that it is possible to free memory +# of keys that are expired and will never be accessed again in a short time. +# +# The default effort of the expire cycle will try to avoid having more than +# ten percent of expired keys still in memory, and will try to avoid consuming +# more than 25% of total memory and to add latency to the system. However +# it is possible to increase the expire "effort" that is normally set to +# "1", to a greater value, up to the value "10". At its maximum value the +# system will use more CPU, longer cycles (and technically may introduce +# more latency), and will tolerate less already expired keys still present +# in the system. It's a tradeoff between memory, CPU and latency. +# +# active-expire-effort 1 + +############################# LAZY FREEING #################################### + +# Valkey has two primitives to delete keys. One is called DEL and is a blocking +# deletion of the object. It means that the server stops processing new commands +# in order to reclaim all the memory associated with an object in a synchronous +# way. If the key deleted is associated with a small object, the time needed +# in order to execute the DEL command is very small and comparable to most other +# O(1) or O(log_N) commands in Valkey. However if the key is associated with an +# aggregated value containing millions of elements, the server can block for +# a long time (even seconds) in order to complete the operation. +# +# For the above reasons Valkey also offers non blocking deletion primitives +# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and +# FLUSHDB commands, in order to reclaim memory in background. Those commands +# are executed in constant time. Another thread will incrementally free the +# object in the background as fast as possible. +# +# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. +# It's up to the design of the application to understand when it is a good +# idea to use one or the other. However the Valkey server sometimes has to +# delete keys or flush the whole database as a side effect of other operations. +# Specifically Valkey deletes objects independently of a user call in the +# following scenarios: +# +# 1) On eviction, because of the maxmemory and maxmemory policy configurations, +# in order to make room for new data, without going over the specified +# memory limit. +# 2) Because of expire: when a key with an associated time to live (see the +# EXPIRE command) must be deleted from memory. +# 3) Because of a side effect of a command that stores data on a key that may +# already exist. For example the RENAME command may delete the old key +# content when it is replaced with another one. Similarly SUNIONSTORE +# or SORT with STORE option may delete existing keys. The SET command +# itself removes any old content of the specified key in order to replace +# it with the specified string. +# 4) During replication, when a replica performs a full resynchronization with +# its master, the content of the whole database is removed in order to +# load the RDB file just transferred. +# +# In all the above cases the default is to delete objects in a blocking way, +# like if DEL was called. However you can configure each case specifically +# in order to instead release memory in a non-blocking way like if UNLINK +# was called, using the following configuration directives. + +lazyfree-lazy-eviction no +lazyfree-lazy-expire no +lazyfree-lazy-server-del no +replica-lazy-flush no + +# It is also possible, for the case when to replace the user code DEL calls +# with UNLINK calls is not easy, to modify the default behavior of the DEL +# command to act exactly like UNLINK, using the following configuration +# directive: + +lazyfree-lazy-user-del no + +# FLUSHDB, FLUSHALL, and SCRIPT FLUSH support both asynchronous and synchronous +# deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the +# commands. When neither flag is passed, this directive will be used to determine +# if the data should be deleted asynchronously. + +lazyfree-lazy-user-flush no + +################################ THREADED I/O ################################# + +# Valkey is mostly single threaded, however there are certain threaded +# operations such as UNLINK, slow I/O accesses and other things that are +# performed on side threads. +# +# Now it is also possible to handle Valkey clients socket reads and writes +# in different I/O threads. Since especially writing is so slow, normally +# Valkey users use pipelining in order to speed up the Valkey performances per +# core, and spawn multiple instances in order to scale more. Using I/O +# threads it is possible to easily speedup two times Valkey without resorting +# to pipelining nor sharding of the instance. +# +# By default threading is disabled, we suggest enabling it only in machines +# that have at least 4 or more cores, leaving at least one spare core. +# Using more than 8 threads is unlikely to help much. We also recommend using +# threaded I/O only if you actually have performance problems, with Valkey +# instances being able to use a quite big percentage of CPU time, otherwise +# there is no point in using this feature. +# +# So for instance if you have a four cores boxes, try to use 2 or 3 I/O +# threads, if you have a 8 cores, try to use 6 threads. In order to +# enable I/O threads use the following configuration directive: +# +# io-threads 4 +# +# Setting io-threads to 1 will just use the main thread as usual. +# When I/O threads are enabled, we only use threads for writes, that is +# to thread the write(2) syscall and transfer the client buffers to the +# socket. However it is also possible to enable threading of reads and +# protocol parsing using the following configuration directive, by setting +# it to yes: +# +# io-threads-do-reads no +# +# Usually threading reads doesn't help much. +# +# NOTE 1: This configuration directive cannot be changed at runtime via +# CONFIG SET. Aso this feature currently does not work when SSL is +# enabled. +# +# NOTE 2: If you want to test the Valkey speedup using valkey-benchmark, make +# sure you also run the benchmark itself in threaded mode, using the +# --threads option to match the number of Valkey threads, otherwise you'll not +# be able to notice the improvements. + +############################ KERNEL OOM CONTROL ############################## + +# On Linux, it is possible to hint the kernel OOM killer on what processes +# should be killed first when out of memory. +# +# Enabling this feature makes Valkey actively control the oom_score_adj value +# for all its processes, depending on their role. The default scores will +# attempt to have background child processes killed before all others, and +# replicas killed before masters. +# +# Valkey supports three options: +# +# no: Don't make changes to oom-score-adj (default). +# yes: Alias to "relative" see below. +# absolute: Values in oom-score-adj-values are written as is to the kernel. +# relative: Values are used relative to the initial value of oom_score_adj when +# the server starts and are then clamped to a range of -1000 to 1000. +# Because typically the initial value is 0, they will often match the +# absolute values. +oom-score-adj no + +# When oom-score-adj is used, this directive controls the specific values used +# for master, replica and background child processes. Values range -2000 to +# 2000 (higher means more likely to be killed). +# +# Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities) +# can freely increase their value, but not decrease it below its initial +# settings. This means that setting oom-score-adj to "relative" and setting the +# oom-score-adj-values to positive values will always succeed. +oom-score-adj-values 0 200 800 + + +#################### KERNEL transparent hugepage CONTROL ###################### + +# Usually the kernel Transparent Huge Pages control is set to "madvise" or +# or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which +# case this config has no effect. On systems in which it is set to "always", +# valkey will attempt to disable it specifically for the valkey process in order +# to avoid latency problems specifically with fork(2) and CoW. +# If for some reason you prefer to keep it enabled, you can set this config to +# "no" and the kernel global to "always". + +disable-thp yes + +############################## APPEND ONLY MODE ############################### + +# By default Valkey asynchronously dumps the dataset on disk. This mode is +# good enough in many applications, but an issue with the Valkey process or +# a power outage may result into a few minutes of writes lost (depending on +# the configured save points). +# +# The Append Only File is an alternative persistence mode that provides +# much better durability. For instance using the default data fsync policy +# (see later in the config file) Valkey can lose just one second of writes in a +# dramatic event like a server power outage, or a single write if something +# wrong with the Valkey process itself happens, but the operating system is +# still running correctly. +# +# AOF and RDB persistence can be enabled at the same time without problems. +# If the AOF is enabled on startup Valkey will load the AOF, that is the file +# with the better durability guarantees. +# +# Please check https://valkey.io/topics/persistence for more information. + +appendonly yes + +# The name of the append only file (default: "appendonly.aof") + +appendfilename "appendonly.aof" + +# The fsync() call tells the Operating System to actually write data on disk +# instead of waiting for more data in the output buffer. Some OS will really flush +# data on disk, some other OS will just try to do it ASAP. +# +# Valkey supports three different modes: +# +# no: don't fsync, just let the OS flush the data when it wants. Faster. +# always: fsync after every write to the append only log. Slow, Safest. +# everysec: fsync only one time every second. Compromise. +# +# The default is "everysec", as that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# More details please check the following article: +# http://antirez.com/post/valkey-persistence-demystified.html +# +# If unsure, use "everysec". + +# appendfsync always +appendfsync everysec +# appendfsync no + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Valkey may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving, the durability of Valkey is +# the same as "appendfsync none". In practical terms, this means that it is +# possible to lose up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. + +no-appendfsync-on-rewrite yes + +# Automatic rewrite of the append only file. +# Valkey is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size grows by the specified percentage. +# +# This is how it works: Valkey remembers the size of the AOF file after the +# latest rewrite (if no rewrite has happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a percentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage 100 +auto-aof-rewrite-min-size 64mb + +# An AOF file may be found to be truncated at the end during the Valkey +# startup process, when the AOF data gets loaded back into memory. +# This may happen when the system where Valkey is running +# crashes, especially when an ext4 filesystem is mounted without the +# data=ordered option (however this can't happen when Valkey itself +# crashes or aborts but the operating system still works correctly). +# +# Valkey can either exit with an error when this happens, or load as much +# data as possible (the default now) and start if the AOF file is found +# to be truncated at the end. The following option controls this behavior. +# +# If aof-load-truncated is set to yes, a truncated AOF file is loaded and +# the Valkey server starts emitting a log to inform the user of the event. +# Otherwise if the option is set to no, the server aborts with an error +# and refuses to start. When the option is set to no, the user requires +# to fix the AOF file using the "valkey-check-aof" utility before to restart +# the server. +# +# Note that if the AOF file will be found to be corrupted in the middle +# the server will still exit with an error. This option only applies when +# Valkey will try to read more data from the AOF file but not enough bytes +# will be found. +aof-load-truncated yes + +# When rewriting the AOF file, Valkey is able to use an RDB preamble in the +# AOF file for faster rewrites and recoveries. When this option is turned +# on the rewritten AOF file is composed of two different stanzas: +# +# [RDB file][AOF tail] +# +# When loading, Valkey recognizes that the AOF file starts with the "VALKEY" +# string and loads the prefixed RDB file, then continues loading the AOF +# tail. +aof-use-rdb-preamble yes + +################################ LUA SCRIPTING ############################### + +# Max execution time of a Lua script in milliseconds. +# +# If the maximum execution time is reached Valkey will log that a script is +# still in execution after the maximum allowed time and will start to +# reply to queries with an error. +# +# When a long running script exceeds the maximum execution time only the +# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be +# used to stop a script that did not yet call any write commands. The second +# is the only way to shut down the server in the case a write command was +# already issued by the script but the user doesn't want to wait for the natural +# termination of the script. +# +# Set it to 0 or a negative value for unlimited execution without warnings. +lua-time-limit 5000 + +################################ VALKEY CLUSTER ############################### + +# Normal Valkey instances can't be part of a Valkey Cluster; only nodes that are +# started as cluster nodes can. In order to start a Valkey instance as a +# cluster node enable the cluster support uncommenting the following: +# +# cluster-enabled yes + +# Every cluster node has a cluster configuration file. This file is not +# intended to be edited by hand. It is created and updated by Valkey nodes. +# Every Valkey Cluster node requires a different cluster configuration file. +# Make sure that instances running in the same system do not have +# overlapping cluster configuration file names. +# +# cluster-config-file nodes-6379.conf + +# Cluster node timeout is the amount of milliseconds a node must be unreachable +# for it to be considered in failure state. +# Most other internal time limits are a multiple of the node timeout. +# +# cluster-node-timeout 15000 + +# A replica of a failing master will avoid to start a failover if its data +# looks too old. +# +# There is no simple way for a replica to actually have an exact measure of +# its "data age", so the following two checks are performed: +# +# 1) If there are multiple replicas able to failover, they exchange messages +# in order to try to give an advantage to the replica with the best +# replication offset (more data from the master processed). +# Replicas will try to get their rank by offset, and apply to the start +# of the failover a delay proportional to their rank. +# +# 2) Every single replica computes the time of the last interaction with +# its master. This can be the last ping or command received (if the master +# is still in the "connected" state), or the time that elapsed since the +# disconnection with the master (if the replication link is currently down). +# If the last interaction is too old, the replica will not try to failover +# at all. +# +# The point "2" can be tuned by user. Specifically a replica will not perform +# the failover if, since the last interaction with the master, the time +# elapsed is greater than: +# +# (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period +# +# So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor +# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the +# replica will not try to failover if it was not able to talk with the master +# for longer than 310 seconds. +# +# A large cluster-replica-validity-factor may allow replicas with too old data to failover +# a master, while a too small value may prevent the cluster from being able to +# elect a replica at all. +# +# For maximum availability, it is possible to set the cluster-replica-validity-factor +# to a value of 0, which means, that replicas will always try to failover the +# master regardless of the last time they interacted with the master. +# (However they'll always try to apply a delay proportional to their +# offset rank). +# +# Zero is the only value able to guarantee that when all the partitions heal +# the cluster will always be able to continue. +# +# cluster-replica-validity-factor 10 + +# Cluster replicas are able to migrate to orphaned masters, that are masters +# that are left without working replicas. This improves the cluster ability +# to resist to failures as otherwise an orphaned master can't be failed over +# in case of failure if it has no working replicas. +# +# Replicas migrate to orphaned masters only if there are still at least a +# given number of other working replicas for their old master. This number +# is the "migration barrier". A migration barrier of 1 means that a replica +# will migrate only if there is at least 1 other working replica for its master +# and so forth. It usually reflects the number of replicas you want for every +# master in your cluster. +# +# Default is 1 (replicas migrate only if their masters remain with at least +# one replica). To disable migration just set it to a very large value or +# set cluster-allow-replica-migration to 'no'. +# A value of 0 can be set but is useful only for debugging and dangerous +# in production. +# +# cluster-migration-barrier 1 + +# Turning off this option allows to use less automatic cluster configuration. +# It both disables migration to orphaned masters and migration from masters +# that became empty. +# +# Default is 'yes' (allow automatic migrations). +# +# cluster-allow-replica-migration yes + +# By default Valkey Cluster nodes stop accepting queries if they detect there +# is at least a hash slot uncovered (no available node is serving it). +# This way if the cluster is partially down (for example a range of hash slots +# are no longer covered) all the cluster becomes, eventually, unavailable. +# It automatically returns available as soon as all the slots are covered again. +# +# However sometimes you want the subset of the cluster which is working, +# to continue to accept queries for the part of the key space that is still +# covered. In order to do so, just set the cluster-require-full-coverage +# option to no. +# +# cluster-require-full-coverage yes + +# This option, when set to yes, prevents replicas from trying to failover its +# master during master failures. However the replica can still perform a +# manual failover, if forced to do so. +# +# This is useful in different scenarios, especially in the case of multiple +# data center operations, where we want one side to never be promoted if not +# in the case of a total DC failure. +# +# cluster-replica-no-failover no + +# This option, when set to yes, allows nodes to serve read traffic while the +# the cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful for two cases. The first case is for when an application +# doesn't require consistency of data during node failures or network partitions. +# One example of this is a cache, where as long as the node has the data it +# should be able to serve it. +# +# The second use case is for configurations that don't meet the recommended +# three shards but want to enable cluster mode and scale later. A +# master outage in a 1 or 2 shard configuration causes a read/write outage to the +# entire cluster without this option set, with it set there is only a write outage. +# Without a quorum of masters, slot ownership will not change automatically. +# +# cluster-allow-reads-when-down no + +# In order to setup your cluster make sure to read the documentation +# available at https://valkey.io web site. + +########################## CLUSTER DOCKER/NAT support ######################## + +# In certain deployments, Valkey Cluster nodes address discovery fails, because +# addresses are NAT-ted or because ports are forwarded (the typical case is +# Docker and other containers). +# +# In order to make Valkey Cluster working in such environments, a static +# configuration where each node knows its public address is needed. The +# following four options are used for this scope, and are: +# +# * cluster-announce-ip +# * cluster-announce-port +# * cluster-announce-tls-port +# * cluster-announce-bus-port +# +# Each instructs the node about its address, client ports (for connections +# without and with TLS) and cluster message bus port. The information is then +# published in the header of the bus packets so that other nodes will be able to +# correctly map the address of the node publishing the information. +# +# If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set +# to zero, then cluster-announce-port refers to the TLS port. Note also that +# cluster-announce-tls-port has no effect if cluster-tls is set to no. +# +# If the above options are not used, the normal Valkey Cluster auto-detection +# will be used instead. +# +# Note that when remapped, the bus port may not be at the fixed offset of +# clients port + 10000, so you can specify any port and bus-port depending +# on how they get remapped. If the bus-port is not set, a fixed offset of +# 10000 will be used as usual. +# +# Example: +# +# cluster-announce-ip 10.1.1.5 +# cluster-announce-tls-port 6379 +# cluster-announce-port 0 +# cluster-announce-bus-port 6380 + +################################## SLOW LOG ################################### + +# The Valkey Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Valkey +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than 10000 + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len 128 + +################################ LATENCY MONITOR ############################## + +# The Valkey latency monitoring subsystem samples different operations +# at runtime in order to collect data related to possible sources of +# latency of a Valkey instance. +# +# Via the LATENCY command this information is available to the user that can +# print graphs and obtain reports. +# +# The system only logs operations that were performed in a time equal or +# greater than the amount of milliseconds specified via the +# latency-monitor-threshold configuration directive. When its value is set +# to zero, the latency monitor is turned off. +# +# By default latency monitoring is disabled since it is mostly not needed +# if you don't have latency issues, and collecting data has a performance +# impact, that while very small, can be measured under big load. Latency +# monitoring can easily be enabled at runtime using the command +# "CONFIG SET latency-monitor-threshold " if needed. +latency-monitor-threshold 0 + +############################# EVENT NOTIFICATION ############################## + +# Valkey can notify Pub/Sub clients about events happening in the key space. +# This feature is documented at https://valkey.io/topics/notifications +# +# For instance if keyspace events notification is enabled, and a client +# performs a DEL operation on key "foo" stored in the Database 0, two +# messages will be published via Pub/Sub: +# +# PUBLISH __keyspace@0__:foo del +# PUBLISH __keyevent@0__:del foo +# +# It is possible to select the events that Valkey will notify among a set +# of classes. Every class is identified by a single character: +# +# K Keyspace events, published with __keyspace@__ prefix. +# E Keyevent events, published with __keyevent@__ prefix. +# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... +# $ String commands +# l List commands +# s Set commands +# h Hash commands +# z Sorted set commands +# x Expired events (events generated every time a key expires) +# e Evicted events (events generated when a key is evicted for maxmemory) +# t Stream commands +# d Module key type events +# m Key-miss events (Note: It is not included in the 'A' class) +# A Alias for g$lshzxetd, so that the "AKE" string means all the events +# (Except key-miss events which are excluded from 'A' due to their +# unique nature). +# +# The "notify-keyspace-events" takes as argument a string that is composed +# of zero or multiple characters. The empty string means that notifications +# are disabled. +# +# Example: to enable list and generic events, from the point of view of the +# event name, use: +# +# notify-keyspace-events Elg +# +# Example 2: to get the stream of the expired keys subscribing to channel +# name __keyevent@0__:expired use: +# +# notify-keyspace-events Ex +# +# By default all notifications are disabled because most users don't need +# this feature and the feature has some overhead. Note that if you don't +# specify at least one of K or E, no events will be delivered. +notify-keyspace-events "" + +############################### GOPHER SERVER ################################# + +# Valkey contains an implementation of the Gopher protocol, as specified in +# the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt). +# +# The Gopher protocol was very popular in the late '90s. It is an alternative +# to the web, and the implementation both server and client side is so simple +# that the Valkey server has just 100 lines of code in order to implement this +# support. +# +# What do you do with Gopher nowadays? Well Gopher never *really* died, and +# lately there is a movement in order for the Gopher more hierarchical content +# composed of just plain text documents to be resurrected. Some want a simpler +# internet, others believe that the mainstream internet became too much +# controlled, and it's cool to create an alternative space for people that +# want a bit of fresh air. +# +# Anyway for the 10nth birthday of the Valkey, we gave it the Gopher protocol +# as a gift. +# +# --- HOW IT WORKS? --- +# +# The Valkey Gopher support uses the inline protocol of Valkey, and specifically +# two kind of inline requests that were anyway illegal: an empty request +# or any request that starts with "/" (there are no Valkey commands starting +# with such a slash). Normal RESP2/RESP3 requests are completely out of the +# path of the Gopher protocol implementation and are served as usual as well. +# +# If you open a connection to Valkey when Gopher is enabled and send it +# a string like "/foo", if there is a key named "/foo" it is served via the +# Gopher protocol. +# +# In order to create a real Gopher "hole" (the name of a Gopher site in Gopher +# talking), you likely need a script like the following: +# +# https://github.com/antirez/gopher2valkey +# +# --- SECURITY WARNING --- +# +# If you plan to put Valkey on the internet in a publicly accessible address +# to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance. +# Once a password is set: +# +# 1. The Gopher server (when enabled, not by default) will still serve +# content via Gopher. +# 2. However other commands cannot be called before the client will +# authenticate. +# +# So use the 'requirepass' option to protect your instance. +# +# Note that Gopher is not currently supported when 'io-threads-do-reads' +# is enabled. +# +# To enable Gopher support, uncomment the following line and set the option +# from no (the default) to yes. +# +# gopher-enabled no + +############################### ADVANCED CONFIG ############################### + +# Hashes are encoded using a memory efficient data structure when they have a +# small number of entries, and the biggest entry does not exceed a given +# threshold. These thresholds can be configured using the following directives. +hash-max-ziplist-entries 512 +hash-max-ziplist-value 64 + +# Lists are also encoded in a special way to save a lot of space. +# The number of entries allowed per internal list node can be specified +# as a fixed maximum size or a maximum number of elements. +# For a fixed maximum size, use -5 through -1, meaning: +# -5: max size: 64 Kb <-- not recommended for normal workloads +# -4: max size: 32 Kb <-- not recommended +# -3: max size: 16 Kb <-- probably not recommended +# -2: max size: 8 Kb <-- good +# -1: max size: 4 Kb <-- good +# Positive numbers mean store up to _exactly_ that number of elements +# per list node. +# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), +# but if your use case is unique, adjust the settings as necessary. +list-max-ziplist-size -2 + +# Lists may also be compressed. +# Compress depth is the number of quicklist ziplist nodes from *each* side of +# the list to *exclude* from compression. The head and tail of the list +# are always uncompressed for fast push/pop operations. Settings are: +# 0: disable all list compression +# 1: depth 1 means "don't start compressing until after 1 node into the list, +# going from either the head or tail" +# So: [head]->node->node->...->node->[tail] +# [head], [tail] will always be uncompressed; inner nodes will compress. +# 2: [head]->[next]->node->node->...->node->[prev]->[tail] +# 2 here means: don't compress head or head->next or tail->prev or tail, +# but compress all nodes between them. +# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] +# etc. +list-compress-depth 0 + +# Sets have a special encoding in just one case: when a set is composed +# of just strings that happen to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries 512 + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-ziplist-entries 128 +zset-max-ziplist-value 64 + +# HyperLogLog sparse representation bytes limit. The limit includes the +# 16 bytes header. When an HyperLogLog using the sparse representation crosses +# this limit, it is converted into the dense representation. +# +# A value greater than 16000 is totally useless, since at that point the +# dense representation is more memory efficient. +# +# The suggested value is ~ 3000 in order to have the benefits of +# the space efficient encoding without slowing down too much PFADD, +# which is O(N) with the sparse encoding. The value can be raised to +# ~ 10000 when CPU is not a concern, but space is, and the data set is +# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. +hll-sparse-max-bytes 3000 + +# Streams macro node max size / items. The stream data structure is a radix +# tree of big nodes that encode multiple items inside. Using this configuration +# it is possible to configure how big a single node can be in bytes, and the +# maximum number of items it may contain before switching to a new node when +# appending new stream entries. If any of the following settings are set to +# zero, the limit is ignored, so for instance it is possible to set just a +# max entries limit by setting max-bytes to 0 and max-entries to the desired +# value. +stream-node-max-bytes 4096 +stream-node-max-entries 100 + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Valkey hash table (the one mapping top-level +# keys to values). The hash table implementation Valkey uses (see dict.c) +# performs a lazy rehashing: the more operation you run into a hash table +# that is rehashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# actively rehash the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Valkey can reply from time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing yes + +# The client output buffer limits can be used to force disconnection of clients +# that are not reading data from the server fast enough for some reason (a +# common reason is that a Pub/Sub client can't consume messages as fast as the +# publisher can produce them). +# +# The limit can be set differently for the three different classes of clients: +# +# normal -> normal clients including MONITOR clients +# replica -> replica clients +# pubsub -> clients subscribed to at least one pubsub channel or pattern +# +# The syntax of every client-output-buffer-limit directive is the following: +# +# client-output-buffer-limit +# +# A client is immediately disconnected once the hard limit is reached, or if +# the soft limit is reached and remains reached for the specified number of +# seconds (continuously). +# So for instance if the hard limit is 32 megabytes and the soft limit is +# 16 megabytes / 10 seconds, the client will get disconnected immediately +# if the size of the output buffers reach 32 megabytes, but will also get +# disconnected if the client reaches 16 megabytes and continuously overcomes +# the limit for 10 seconds. +# +# By default normal clients are not limited because they don't receive data +# without asking (in a push way), but just after a request, so only +# asynchronous clients may create a scenario where data is requested faster +# than it can read. +# +# Instead there is a default limit for pubsub and replica clients, since +# subscribers and replicas receive data in a push fashion. +# +# Both the hard or the soft limit can be disabled by setting them to zero. +client-output-buffer-limit normal 0 0 0 +client-output-buffer-limit replica 512mb 128mb 60 +client-output-buffer-limit pubsub 32mb 8mb 60 + +# Client query buffers accumulate new commands. They are limited to a fixed +# amount by default in order to avoid that a protocol desynchronization (for +# instance due to a bug in the client) will lead to unbound memory usage in +# the query buffer. However you can configure it here if you have very special +# needs, such us huge multi/exec requests or alike. +# +# client-query-buffer-limit 1gb + +# In the Valkey protocol, bulk requests, that are, elements representing single +# strings, are normally limited to 512 mb. However you can change this limit +# here, but must be 1mb or greater +# +# proto-max-bulk-len 512mb + +# Valkey calls an internal function to perform many background tasks, like +# closing connections of clients in timeout, purging expired keys that are +# never requested, and so forth. +# +# Not all tasks are performed with the same frequency, but Valkey checks for +# tasks to perform according to the specified "hz" value. +# +# By default "hz" is set to 10. Raising the value will use more CPU when +# Valkey is idle, but at the same time will make Valkey more responsive when +# there are many keys expiring at the same time, and timeouts may be +# handled with more precision. +# +# The range is between 1 and 500, however a value over 100 is usually not +# a good idea. Most users should use the default of 10 and raise this up to +# 100 only in environments where very low latency is required. +hz 10 + +# Normally it is useful to have an HZ value which is proportional to the +# number of clients connected. This is useful in order, for instance, to +# avoid too many clients are processed for each background task invocation +# in order to avoid latency spikes. +# +# Since the default HZ value by default is conservatively set to 10, Valkey +# offers, and enables by default, the ability to use an adaptive HZ value +# which will temporarily raise when there are many connected clients. +# +# When dynamic HZ is enabled, the actual configured HZ will be used +# as a baseline, but multiples of the configured HZ value will be actually +# used as needed once more clients are connected. In this way an idle +# instance will use very little CPU time while a busy instance will be +# more responsive. +dynamic-hz yes + +# When a child rewrites the AOF file, if the following option is enabled +# the file will be fsync-ed every 32 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +aof-rewrite-incremental-fsync yes + +# When valkey saves RDB file, if the following option is enabled +# the file will be fsync-ed every 32 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +rdb-save-incremental-fsync yes + +# Valkey LFU eviction (see maxmemory setting) can be tuned. However it is a good +# idea to start with the default settings and only change them after investigating +# how to improve the performances and how the keys LFU change over time, which +# is possible to inspect via the OBJECT FREQ command. +# +# There are two tunable parameters in the Valkey LFU implementation: the +# counter logarithm factor and the counter decay time. It is important to +# understand what the two parameters mean before changing them. +# +# The LFU counter is just 8 bits per key, it's maximum value is 255, so Valkey +# uses a probabilistic increment with logarithmic behavior. Given the value +# of the old counter, when a key is accessed, the counter is incremented in +# this way: +# +# 1. A random number R between 0 and 1 is extracted. +# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). +# 3. The counter is incremented only if R < P. +# +# The default lfu-log-factor is 10. This is a table of how the frequency +# counter changes with a different number of accesses with different +# logarithmic factors: +# +# +--------+------------+------------+------------+------------+------------+ +# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +# +--------+------------+------------+------------+------------+------------+ +# | 0 | 104 | 255 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 1 | 18 | 49 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 10 | 10 | 18 | 142 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 100 | 8 | 11 | 49 | 143 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# +# NOTE: The above table was obtained by running the following commands: +# +# valkey-benchmark -n 1000000 incr foo +# valkey-cli object freq foo +# +# NOTE 2: The counter initial value is 5 in order to give new objects a chance +# to accumulate hits. +# +# The counter decay time is the time, in minutes, that must elapse in order +# for the key counter to be divided by two (or decremented if it has a value +# less <= 10). +# +# The default value for the lfu-decay-time is 1. A special value of 0 means to +# decay the counter every time it happens to be scanned. +# +# lfu-log-factor 10 +# lfu-decay-time 1 + +########################### ACTIVE DEFRAGMENTATION ####################### +# +# What is active defragmentation? +# ------------------------------- +# +# Active (online) defragmentation allows a Valkey server to compact the +# spaces left between small allocations and deallocations of data in memory, +# thus allowing to reclaim back memory. +# +# Fragmentation is a natural process that happens with every allocator (but +# less so with Jemalloc, fortunately) and certain workloads. Normally a server +# restart is needed in order to lower the fragmentation, or at least to flush +# away all the data and create it again. However thanks to this feature +# implemented by Oran Agra for Valkey 4.0 this process can happen at runtime +# in a "hot" way, while the server is running. +# +# Basically when the fragmentation is over a certain level (see the +# configuration options below) Valkey will start to create new copies of the +# values in contiguous memory regions by exploiting certain specific Jemalloc +# features (in order to understand if an allocation is causing fragmentation +# and to allocate it in a better place), and at the same time, will release the +# old copies of the data. This process, repeated incrementally for all the keys +# will cause the fragmentation to drop back to normal values. +# +# Important things to understand: +# +# 1. This feature is disabled by default, and only works if you compiled Valkey +# to use the copy of Jemalloc we ship with the source code of Valkey. +# This is the default with Linux builds. +# +# 2. You never need to enable this feature if you don't have fragmentation +# issues. +# +# 3. Once you experience fragmentation, you can enable this feature when +# needed with the command "CONFIG SET activedefrag yes". +# +# The configuration parameters are able to fine tune the behavior of the +# defragmentation process. If you are not sure about what they mean it is +# a good idea to leave the defaults untouched. + +# Enabled active defragmentation +# activedefrag no + +# Minimum amount of fragmentation waste to start active defrag +# active-defrag-ignore-bytes 100mb + +# Minimum percentage of fragmentation to start active defrag +# active-defrag-threshold-lower 10 + +# Maximum percentage of fragmentation at which we use maximum effort +# active-defrag-threshold-upper 100 + +# Minimal effort for defrag in CPU percentage, to be used when the lower +# threshold is reached +# active-defrag-cycle-min 1 + +# Maximal effort for defrag in CPU percentage, to be used when the upper +# threshold is reached +# active-defrag-cycle-max 25 + +# Maximum number of set/hash/zset/list fields that will be processed from +# the main dictionary scan +# active-defrag-max-scan-fields 1000 + +# Jemalloc background thread for purging will be enabled by default +jemalloc-bg-thread yes + +# It is possible to pin different threads and processes of Valkey to specific +# CPUs in your system, in order to maximize the performances of the server. +# This is useful both in order to pin different Valkey threads in different +# CPUs, but also in order to make sure that multiple Valkey instances running +# in the same host will be pinned to different CPUs. +# +# Normally you can do this using the "taskset" command, however it is also +# possible to this via Valkey configuration directly, both in Linux and FreeBSD. +# +# You can pin the server/IO threads, bio threads, aof rewrite child process, and +# the bgsave child process. The syntax to specify the cpu list is the same as +# the taskset command: +# +# Set valkey server/io threads to cpu affinity 0,2,4,6: +# server_cpulist 0-7:2 +# +# Set bio threads to cpu affinity 1,3: +# bio_cpulist 1,3 +# +# Set aof rewrite child process to cpu affinity 8,9,10,11: +# aof_rewrite_cpulist 8-11 +# +# Set bgsave child process to cpu affinity 1,10,11 +# bgsave_cpulist 1,10-11 + +# In some cases valkey will emit warnings and even refuse to start if it detects +# that the system is in bad state, it is possible to suppress these warnings +# by setting the following config which takes a space delimited list of warnings +# to suppress +# +# ignore-warnings ARM64-COW-BUG diff --git a/roles/valkey/templates/valkey.logrotate.j2 b/roles/valkey/templates/valkey.logrotate.j2 new file mode 100644 index 00000000..ee38eb44 --- /dev/null +++ b/roles/valkey/templates/valkey.logrotate.j2 @@ -0,0 +1,35 @@ +# ----------------------------------------------------- +# This file is managed by Ansible. +# Safe to edit, but if you re-run automation, it may be overwritten. +# +# To customize retention, compression, or actions, edit below. + +{{ valkey_log_dir }}/valkey.log { + # How often to rotate (change to weekly/monthly if desired) + daily + + # How many rotations to keep (increase/decrease as needed) + rotate 7 + + # Enable compression for old logs (can comment to disable) + compress + delaycompress + + # Don't complain if log is missing or empty + missingok + notifempty + + # Ensure logrotate runs with the right user/group + su {{ valkey_owner }} {{ valkey_group }} + + # File permissions & ownership for new logs + create 0640 {{ valkey_owner }} {{ valkey_group }} + + # Safest for Valkey: copy+truncate the active file in place + copytruncate + + # Ensures only one rotation at a time if multiple logs exist + sharedscripts + + # NOTE: Valkey does NOT reopen logs on HUP. Avoid postrotate/HUP. +} \ No newline at end of file diff --git a/roles/valkey/templates/valkey.service.j2 b/roles/valkey/templates/valkey.service.j2 new file mode 100644 index 00000000..21776cab --- /dev/null +++ b/roles/valkey/templates/valkey.service.j2 @@ -0,0 +1,16 @@ +[Unit] +Description=Valkey persistent key-value database +After=network.target +After=network-online.target +Wants=network-online.target + +[Service] +ExecStart={{valkey_bin_dir }}/valkey-server {{ valkey_conf_file }} --daemonize no --supervised systemd +Type=notify +User={{ valkey_owner }} +Group={{ valkey_group }} +RuntimeDirectory=valkey +RuntimeDirectoryMode=0755 + +[Install] +WantedBy=multi-user.target diff --git a/roles/valkey/vars/main.yml b/roles/valkey/vars/main.yml new file mode 100644 index 00000000..488dfa5b --- /dev/null +++ b/roles/valkey/vars/main.yml @@ -0,0 +1,24 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# Default directories +valkey_bin_dir_default: /usr/bin +valkey_conf_dir_default: /etc/valkey +valkey_log_dir_default: /var/log/valkey +valkey_data_dir_default: /var/lib/valkey + +# Default ports +valkey_port_default: 6379 +valkey_sentinel_port_default: 26379 + +# Valkey is installed via the native OS package repositories (AppStream on EL9, Amazon Linux +# 2023's own core repo). Unlike roles/redis there is no third-party repository (Remi, EPEL, +# upstream source) to check. On Rocky/AlmaLinux this still resolves to a real, checkable public +# mirror; RHEL proper resolves AppStream through its own subscription-manager CDN instead of a +# fixed public URL, and Amazon Linux 2023 ships Valkey in its already-preconfigured core repo -- +# neither of those has a separate URL worth checking here. +valkey_required_repositories: + - url: "https://mirrors.rockylinux.org" + type: path + check_target: "https://mirrors.rockylinux.org/mirrorlist?arch=x86_64&repo=AppStream-9" + notes: "Rocky/AlmaLinux 9 AppStream mirror for the Valkey RPM" diff --git a/roles/valkey/vars/platform-release-6.yml b/roles/valkey/vars/platform-release-6.yml new file mode 100644 index 00000000..0a336001 --- /dev/null +++ b/roles/valkey/vars/platform-release-6.yml @@ -0,0 +1,26 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +# The keys represent the EL major version (ansible_distribution_major_version). +# Valkey is only supported on EL9 (via the native AppStream module) and Amazon Linux 2023 (via +# its own core repository) -- there is no "8" entry (see validate-vars.yml, which asserts one of +# these two before this is ever looked up). +valkey_packages_default: + "9": + - "valkey" + "2023": + - "valkey" + +valkey_hw_specs: + "dev": + "cpu_count": 8 + "ram_size": 16 + "disk_size": 100 + "test": + "cpu_count": 8 + "ram_size": 32 + "disk_size": 100 + "prod": + "cpu_count": 8 + "ram_size": 32 + "disk_size": 100 diff --git a/roles/valkey/vars/platform-release-undefined.yml b/roles/valkey/vars/platform-release-undefined.yml new file mode 100644 index 00000000..3c0f5533 --- /dev/null +++ b/roles/valkey/vars/platform-release-undefined.yml @@ -0,0 +1,4 @@ +# Copyright (c) 2024, Itential, Inc +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) +--- +valkey_invalid_platform_release: true