argument_specs.yml

# Copyright 2020-2025 Chris Croome
#
# This file is part of the Webarchitects PostgreSQL Ansible role.
#
# The Webarchitects PostgreSQL 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 PostgreSQL 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 PostgreSQL Ansible role. If not, see <https://www.gnu.org/licenses/>.
---
argument_specs:
  main:
    author: Chris Croome
    description: Ansible role to install PostgreSQL on Debian and optionally create a user and database.
    short_description: The main entry point for the PostgreSQL role.
    options:
      postgresql:
        type: bool
        required: true
        description: Run the tasks in this role.
      postgresql_backups:
        type: str
        required: false
        description: Directory for PostgreSQL backups.
      postgresql_cron_hour:
        type: str
        required: false
        description: Hour for PostgreSQL backup creation.
      postgresql_cron_min_list:
        type: list
        elements: str
        description: Internal list of minutes that can be used for the backup crontab entry.
      postgresql_cron_min_regex:
        type: str
        required: false
        description: Internal regex for the crontab minute.
      postgresql_db:
        type: str
        required: false
        description: PostgreSQL database name.
      postgresql_db_encoding:
        type: str
        required: false
        description: PostgreSQL database encoding.
      postgresql_db_lc_collate:
        type: str
        required: false
        description: PostgreSQL database collation order (LC_COLLATE).
      postgresql_db_lc_ctype:
        type: str
        required: false
        description: PostgreSQL database character classification (LC_CTYPE).
      postgresql_db_locale:
        type: str
        required: false
        description: PostgreSQL database locale.
      postgresql_db_owner:
        type: str
        required: false
        description: PostgreSQL database owner.
      postgresql_db_state:
        type: str
        required: false
        description: PostgreSQL database state.
        choices:
          - absent
          - present
      postgresql_host:
        type: str
        required: true
        description: PostgreSQL host.
      postgresql_maintenance_db:
        type: str
        required: true
        description: PostgreSQL initial database (which is also called as maintenance DB) that Ansible connects to.
      postgresql_pkgs:
        type: list
        elements: str
        required: false
        description: A list of .deb packages that should be present.
      postgresql_port:
        type: int
        required: true
        description: PostgreSQL port number.
      postgresql_postgres_home_query:
        type: str
        required: true
        description: Internal JMESPATH query variable.
      postgresql_psycopg_pkg:
        type: list
        required: true
        description: Internal list of psycopg packges for different Debian / Ubuntu versions
        options:
          distro:
            type: str
            required: true
            description: The value of the ansible_facts.distribution_release variable.
          pkg:
            type: str
            required: true
            description: The name of the psycopg package.
      postgresql_psycopg_pkg_query:
        type: str
        required: true
        description: Internal JMESPath query for the distro / psycopg package.
      postgresql_superuser:
        type: str
        required: true
        description: PostgreSQL superuser.
      postgresql_user:
        type: str
        required: false
        description: PostgreSQL user name.
      postgresql_user_canlogin_query:
        type: str
        required: true
        description: Internal JMESPath query used with the community.postgresql.postgresql_info module results.
      postgresql_user_privs:
        type: str
        required: false
        description: PostgreSQL user database privileges list, comma separated.
      postgresql_validate:
        type: bool
        required: true
        description: Vaildate all variables that start with postgresql_.
  pgpass_read:
    author: Chris Croome
    description: Ansible role to install PostgreSQL on Debian and optionally create a user and database.
    short_description: The read PostgreSQL user password entry point for the PostgreSQL role.
    options:
      postgresql_db:
        type: str
        required: false
        description: The PostgreSQL database name.
      postgresql_host:
        type: str
        required: true
        description: PostgreSQL host.
      postgresql_port:
        type: int
        required: true
        description: PostgreSQL port number.
      postgresql_user:
        type: str
        required: false
        description: The PostgreSQL user name.
...