debops.pgbadger default variables

Sections

General configuration
Remote SSH configuration
Webserver configuration
pgBadger scripts and cron job configuration
pgBadger instances
Configuration for other Ansible roles

General configuration 

pgbadger__base_packages

The list of APT packages required to install pgBadger.

pgbadger__base_packages: [ 'pgbadger' ]

pgbadger__packages

List of additional APT packages to install with pgBadger.

pgbadger__packages: []

pgbadger__user

Name of the system UNIX account used by pgBadger to generate raports and connect to remote hosts via SSH.

pgbadger__user: 'pgbadger'

pgbadger__group

Name of the system UNIX group used by pgBadger.

pgbadger__group: 'pgbadger'

pgbadger__additional_groups

List of additional UNIX groups in which the pgBadger UNIX account will be added. The adm UNIX group is traditionally used for access to log files and might be needed if pgBadger will be used to generate PostgreSQL logs on the same host.

pgbadger__additional_groups: [ 'adm' ]

pgbadger__home

Absolute path to the $HOME directory of the pgBadger UNIX account.

pgbadger__home: '{{ (ansible_local.fhs.www | d("/srv/www")) + "/" + pgbadger__user }}'

pgbadger__comment

The contents of the GECOS field set for the pgBadger UNIX account.

pgbadger__comment: 'pgBadger'

Remote SSH configuration 

pgbadger__ssh_accounts_enabled

Enable or disable management of SSH public keys on the remote hosts accessed by pgBadger.

pgbadger__ssh_accounts_enabled: True

pgbadger__ssh_inventory_group

Name of the Ansisble inventory group which will be used as the list of hosts on which the role will configure SSH access for pgBadger. The default group is the same as the inventory group used by the debops.postgresql_server role and its playbook. If the pgBadger host is included in this group, SSH configuration on that host will be automatically skipped.

pgbadger__ssh_inventory_group: 'debops_service_postgresql_server'

pgbadger__ssh_user

Name of the remote UNIX account which will be created to allow pgBadger access over SSH.

pgbadger__ssh_user: 'pgbadger'

pgbadger__ssh_group

Name of the remote UNIX group created as the primary group for the pgBadger UNIX account.

pgbadger__ssh_group: 'pgbadger'

pgbadger__ssh_additional_groups

List of additional UNIX groups the remote pgBadger UNIX account will be included in. The sshusers group permits access over SSH (managed by the debops.system_groups Ansible role), the adm group is used to permit access to the log files.

pgbadger__ssh_additional_groups:
  - '{{ (ansible_local.system_groups.local_prefix | d("")) + "sshusers" }}'
  - 'adm'

pgbadger__ssh_home

The absolute path of the $HOME directory for the remote pgBadger UNIX account.

pgbadger__ssh_home: '{{ (ansible_local.fhs.home | d("/var/local")) + "/" + pgbadger__user }}'

pgbadger__ssh_public_key_file

Path of the SSH public key of the pgBadger UNIX account, created by default by Ansible. The contents of this file will be added to the ~/.ssh/authorized_keys files on the remote pgBadger UNIX accounts to allow for SSH access.

pgbadger__ssh_public_key_file: '{{ pgbadger__home + "/.ssh/id_rsa.pub" }}'

Webserver configuration 

pgbadger__fqdn

The Fully Qualified Domain Name of the pgBadger website configured in the webserver, managed by the debops.nginx role.

pgbadger__fqdn: '{{ "pgbadger." + ansible_domain }}'

pgbadger__www_root

Absolute path to the WWW root directory published by the webserver.

pgbadger__www_root: '{{ pgbadger__home + "/sites/" + pgbadger__fqdn + "/public" }}'

pgbadger__nginx_access_policy

Name of the "HTTP access policy" defined in the nginx inventory configuration for pgBadger webpages. If set to empty, an access policy is not enabled. See debops.nginx Ansible role for more details.

pgbadger__nginx_access_policy: ''

pgbadger__nginx_auth_realm

Text displayed in the nginx HTTP Auth window when access policy is enabled.

pgbadger__nginx_auth_realm: 'pgBadger access is restricted'

pgBadger scripts and cron job configuration 

pgbadger__scripts_path

Absolute path to directory where Bash scripts that execute pgbadger will be generated. All of them will be executed in order by the cron job.

pgbadger__scripts_path: '{{ pgbadger__home + "/scripts" }}'

pgbadger__scripts_command

The default pgbadger command used in generated scripts. The --outfile parameter will be added automatically.

pgbadger__scripts_command: 'pgbadger --quiet --start-monday'

pgbadger__cron_deploy_state

Variable used to control the presence if the default cron job which will execute all pgBadger scripts. To enable more fine-grained control, set the state to absent and use the debops.cron role to create custom cron jobs.

pgbadger__cron_deploy_state: 'present'

pgbadger__cron_interval

The default interval for the cron job that executes the pgBadger scripts. Can be hourly, daily, hourly.

pgbadger__cron_interval: 'daily'

pgBadger instances 

These variables define the contents of the pgBadger scripts that are generated by the role. See pgbadger__instances documentation for more details.

pgbadger__default_instances

List of pgBadger instances defined in the role by default.

pgbadger__default_instances:

  - name: 'local'
    output: 'local.html'
    host: 'localhost'
    state: '{{ "present"
               if (inventory_hostname in (groups[pgbadger__ssh_inventory_group] | d([])))
               else "absent" }}'

pgbadger__instances

List of pgBadger instances that should be created on all hosts in the Ansible inventory.

pgbadger__instances: []

pgbadger__group_instances

List of pgBadger instances that should be created on hosts in a specific Ansible inventory group.

pgbadger__group_instances: []

pgbadger__host_instances

List of pgBadger instances that should be created on specific hosts in the Ansible inventory.

pgbadger__host_instances: []

pgbadger__combined_instances

Variable which combines all pgBadger instance lists and is used in role tasks and templates.

pgbadger__combined_instances: '{{ pgbadger__default_instances
                                  + pgbadger__instances
                                  + pgbadger__group_instances
                                  + pgbadger__host_instances }}'

Configuration for other Ansible roles 

pgbadger__nginx__dependent_servers

Configuration for the debops.nginx Ansible role.

pgbadger__nginx__dependent_servers:

  - name: '{{ pgbadger__fqdn }}'
    filename: 'debops.pgbadger'
    root: '{{ pgbadger__www_root }}'
    webroot_create: False
    access_policy: '{{ pgbadger__nginx_access_policy }}'
    auth_basic_realm: '{{ pgbadger__nginx_auth_realm }}'
    location_list:
      - pattern: '/'
        options: |
          try_files $uri $uri/ $uri.html $uri.htm $uri/index.html =404;
          autoindex on;
    state: 'present'

debops.pgbadger default variables

General configuration

Remote SSH configuration

Webserver configuration

pgBadger scripts and cron job configuration

pgBadger instances

Configuration for other Ansible roles