argument_specs.yml

# Copyright 2022-2024 Chris Croome
#
# This file is part of the Webarchitects JC Ansible role.
#
# The Webarchitects JC 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 JC 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 JC Ansible role. If not, see <https://www.gnu.org/licenses/>.
---
argument_specs:
  main:
    author: Chris Croome
    description: Ansible role to install JC on Debian and Ubuntu using apt, pipx or git.
    short_description: The main entry point for the JC role.
    options:
      jc:
        type: bool
        required: true
        description: Run the tasks in this role.
      jc_bash:
        type: bool
        required: true
        description: Install Bash completion if the jc version is >= 1.20.1 and not the .deb package, unless the jc version is <= 1.20.1.
      jc_home:
        type: str
        required: true
        description: Generated variable for the HOME directory of the Ansible user that JC is to be present for.
      jc_install:
        type: str
        required: true
        choices:
          - deb
          - git
          - pipx
        description: Install method for JC.
      jc_jmespath_queries:
        type: dict
        required: true
        description: JMESPath queries.
      jc_pipx_root_env:
        type: dict
        required: false
        description: The pipx environment variables for the root user.
        options:
          PIPX_HOME:
            type: str
            required: false
            description: The PIPX_HOME environment variable value for pipx when run as root.
          PIPX_BIN_DIR:
            type: str
            required: false
            description: The PIPX_BIN_DIR environment variable value for pipx when run as root.
      jc_pipx_user_env:
        type: dict
        required: false
        description: The pipx environment variables for a regular user.
        options:
          PIPX_HOME:
            type: str
            required: false
            description: The PIPX_HOME environment variable value for pipx when run as a regular user.
          PIPX_BIN_DIR:
            type: str
            required: false
            description: The PIPX_BIN_DIR environment variable value for pipx when run as a regular user.
      jc_verify:
        type: bool
        required: true
        description: Verify variables that start with jc underscore using the argument specification.
      jc_version:
        type: str
        required: true
        description: JC version number, branch name or latest.
...