Skip to content
Snippets Groups Projects
argument_specs.yml 55.6 KiB
Newer Older
                description: 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. The default is 512.
              hash_max_listpack_value:
                type: int
                required: false
                description: 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. The default is 64.
              list_max_listpack_size:
                type: str
                required: false
                description: he 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. Positive numbers mean store up to exactly that number of elements per list node. The default is -2 (max size 8 Kb).
              list_compress_depth:
                type: int
                choices:
                  - 0
                  - 1
                  - 2
                  - 3
                required: false
                description: Compress depth is the number of quicklist ziplist nodes from each side of the list to exclude from compression. The default is 0, disable all list compression.
              set_max_intset_entries:
                type: int
                required: false
                description: Sets containing non-integer values are also 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. The default value is 128.
              set_max_listpack_entries:
                type: int
                required: false
                description: Sets containing non-integer values are also 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. The default value is 64.
              set_max_listpack_value:
                type: int
                required: false
                description: Sets containing non-integer values are also 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. The default value is 64.
              zset_max_listpack_entries:
                type: int
                required: false
                description: Similarly to hashes and lists, sorted sets are also specially encoded in order to save a lot of space. The default value is 128.
              zset_max_listpack_value:
                type: int
                required: false
                description: Similarly to hashes and lists, sorted sets are also specially encoded in order to save a lot of space. The default value is 64.
              hll_sparse_max_bytes:
                type: int
                required: false
                description: HyperLogLog sparse representation bytes limit. The default value is 3000.
Chris Croome's avatar
Chris Croome committed
              stream_node_max_bytes:
                type: int
                required: false
                description: Streams macro node max size, the default is 4096. When set to zero, the limit is ignored.
              stream_node_max_entries:
                type: int
                required: false
                description: Streams macro node max items, the default is 100. When set to zero, the limit is ignored.
              activerehashing:
                type: bool
                required: false
                description: Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in order to help rehashing the main server hash table (the one mapping top-level keys to values). The default is true.
              client_output_buffer_limit:
                type: list
                elements: str
                required: false
                description: 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, replica and pubsub.
              client_query_buffer_limit:
                type: str
                required: false
                description: 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. The commented default is 1gb.
              maxmemory_clients:
                type: str
                required: false
                description: A memory value can be used for the client eviction threshold, The commented default is 1g.
              proto_max_bulk_len:
                type: str
                required: false
                description: In the server 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.
              hz:
                type: int
                required: false
                description: The server 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. ot all tasks are performed with the same frequency, but the server checks for tasks to perform according to the specified "hz" value. 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.
              dynamic_hz:
                type: bool
                required: false
                description: Normally it is useful to have an HZ value which is proportional to the number of clients connected. Since the default HZ value by default is conservatively set to 10, the server offers, and enables by default, the ability to use an adaptive HZ value which will temporarily raise when there are many connected clients.
Chris Croome's avatar
Chris Croome committed
              aof_rewrite_incremental_fsync:
                type: bool
                required: false
                description: When a child rewrites the AOF file, if the following option is enabled the file will be fsync-ed every 4 MB of data generated. This is useful in order to commit the file to the disk more incrementally and avoid big latency spikes.
Chris Croome's avatar
Chris Croome committed
              rdb_save_incremental_fsync:
                type: bool
                required: false
                description: When the server saves RDB file, if the following option is enabled the file will be fsync-ed every 4 MB of data generated. This is useful in order to commit the file to the disk more incrementally and avoid big latency spikes. The default is true.
              lfu_log_factor:
                type: int
                required: false
                description: The server's 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. The default lfu-log-factor is 10.
              lfu_decay_time:
                type: int
                required: false
                description: The counter decay time is the time, in minutes, that must elapse in order for the key counter to be decremented. The default value for the lfu-decay-time is 1. A special value of 0 means we will never decay the counter.
              max_new_connections_per_cycle:
                type: int
                required: false
                description: The maximum number of new client connections accepted per event-loop cycle. By default, up to 10 new connection will be accepted per event-loop cycle for normal connections.
              max_new_tls_connections_per_cycle:
                type: int
                required: false
                description: The maximum number of new TLS connections accepted per event-loop cycle. By default up to 1 new connection per event-loop cycle for TLS connections.
              activedefrag:
                type: bool
                required: false
                description: Active (online) defragmentation allows a server to compact the spaces left between small allocations and deallocations of data in memory, thus allowing to reclaim back memory. Active defragmentation is disabled by default.
              active_defrag_ignore_bytes:
                type: int
                required: false
                description: Minimum amount of fragmentation waste to start active defrag.
              active_defrag_threshold_lower:
                type: int
                required: false
                description: Minimum percentage of fragmentation to start active defrag.
              active_defrag_threshold_upper:
                type: int
                required: false
                description: Maximum percentage of fragmentation at which we use maximum effort.
              active_defrag_cycle_min:
                type: int
                required: false
                description: Minimal effort for defrag in CPU percentage, to be used when the lower threshold is reached.
              active_defrag_cycle_max:
                type: int
                required: false
                description: Maximal effort for defrag in CPU percentage, to be used when the upper threshold is reached.
              active_defrag_max_scan_fields:
                type: int
                required: false
                description: Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan.
              jemalloc_bg_thread:
                type: bool
                required: false
                description: Jemalloc background thread for purging will be enabled by default.
              server_cpulist:
                type: str
                required: false
                description: It is possible to pin different threads and processes of the server to specific CPUs in your system, in order to maximize the performances of the server. You can pin the server/IO threads, bio threads, aof rewrite child process, and the bgsave child process.
              bio_cpulist:
                type: str
                required: false
                description: Unset by deafult.
              aof_rewrite_cpulist:
                type: str
                required: false
                description: Set aof rewrite child process to cpu affinity, unset by deafult.
              bgsave_cpulist:
                type: str
                required: false
                description: Set bgsave child process to cpu affinity, unset by deafult.
              ignore_warnings:
                type: str
                required: false
                description: In some cases the server 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.
              availability_zone:
                type: str
                required: false
                description: Inform Valkey of the availability zone if running in a cloud environment.  Currently this is only exposed via the info command for clients to use, but in the future we we may also use this when making decisions for replication.
Chris Croome's avatar
Chris Croome committed
              pidfile:
                type: str
                required: false
                description: Path to the pid file.
Chris Croome's avatar
Chris Croome committed
      valkey_enabled:
        type: bool
        required: true
        description: Enable and start Valkey.
Chris Croome's avatar
Chris Croome committed
      valkey_jpq:
        type: dict
        required: true
        description: A dictionary of JMESPath query strings.
        options:
          pkgs_absent:
            type: str
            required: true
            description: JMESPath query string for the packages absent.
          pkgs_present:
            type: str
            required: true
            description: JMESPath query string for the packages present.
          pkgs_present_backports:
            type: str
            required: true
            description: JMESPath query string for the backports packages present.
          service:
            type: str
            required: true
            description: JMESPath query string for the Valkey service.
Chris Croome's avatar
Chris Croome committed
      valkey_pkgs:
        type: list
        elements: dict
        required: true
        description: A list of distros and deb packages that should be absent and present.
        options:
          name:
            type: str
            required: true
            description: The Linux distro name.
            choices:
              - bookworm
              - noble
              - trixie
          pkgs_absent:
            type: list
            required: false
            description: A list of deb packages that should be absent.
          pkgs_present:
            type: list
            required: false
            description: A list of deb packages that should be present.
          pkgs_present_backports:
            type: list
Chris Croome's avatar
Chris Croome committed
            required: true
Chris Croome's avatar
Chris Croome committed
            description: A list of deb packages that should be present from backports.
Chris Croome's avatar
Chris Croome committed
      valkey_protected_configs:
        type: list
        required: false
        description: A list of Valkey config to be editing using lineinfile.
Chris Croome's avatar
Chris Croome committed
      valkey_verify:
        type: bool
        required: true
        description: Use the argument specification to verify the variables that start with valkey_.
Chris Croome's avatar
Chris Croome committed
...