argument_specs.yml

# Copyright 2025 Chris Croome
#
# This file is part of the Webarchitects Valkey Ansible role.
#
# The Webarchitects Valkey Ansible role is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
#
# The Webarchitects Valkey Ansible role is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with the Webarchitects Valkey Ansible role. If not, see <https://www.gnu.org/licenses/>.
---
argument_specs:
  main:
    author: Chris Croome
    description: Ansible role for installing and configuring nftables on Debian.
    short_description: The main entry point for the Valkey role.
    options:
      valkey:
        type: bool
        required: true
        description: Run the tasks in this role.
      valkey_apt_backports:
        type: str
        required: true
        description: String that will be present in the apt cache policy when backports are enabled.
      valkey_config:
        type: list
        required: false
        description: A list of Valkey config names and values.
        options:
          name:
            type: str
            required: true
            description: A Valkey config variable name.
          value:
            type: str
            required: true
            description: A Valkey config variable value.
      valkey_config_backup:
        type: str
        required: true
        description: Path for the Valkey config backup.
      valkey_enabled:
        type: bool
        required: true
        description: Enable and start Valkey.
      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.
      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
            required: true
            description: A list of deb packages that should be present from backports.
      valkey_protected_configs:
        type: list
        required: false
        description: A list of Valkey config to be editing using lineinfile.
      valkey_verify:
        type: bool
        required: true
        description: Use the argument specification to verify the variables that start with valkey_.
...