ansible-role-cyhy-commander

An Ansible role for installing cisagov/cyhy-commander.

Requirements

None.

Role Variables

Variable	Description	Default	Required
cyhy_commander_cyhy_core_version	The version of cisagov/cyhy-core to use; must be a valid git reference.	v1.2.0	No
cyhy_commander_domainsync_frequency	The frequency of running cyhy-domainsync, the hostname housekeeping script. Must be a calendar event in the format understood by systemd.	daily	No
cyhy_commander_file_owner_group	The name of the group that should own any non-system files or directories created by this role.	Omitted	No
cyhy_commander_file_owner_username	The name of the user that should own any non-system files or directories created by this role.	Omitted	No
cyhy_commander_install_geoipupdate	Whether to install the MaxMind geoipupdate tool.	false	No
cyhy_commander_maxmind_account_id	The MaxMind account ID for access to a GeoIP2 database subscription.	n/a	Yes
cyhy_commander_maxmind_license_key	The MaxMind license key that provides access to a GeoIP2 database subscription.	n/a	Yes
cyhy_commander_version	The version of cisagov/cyhy-commander to install; must be a valid git reference.	v1.1.0	No

Dependencies

• cisagov/ansible-role-cyhy-core
• cisagov/ansible-role-pip
• cisagov/ansible-role-python

Installation

This role can be installed via the command:

ansible-galaxy install --role-file path/to/requirements.yml

where requirements.yml looks like:

---
- name: cyhy_commander
  src: https://github.com/cisagov/ansible-role-cyhy-commander

and may contain other roles as well.

For more information about installing Ansible roles via a YAML file, please see the ansible-galaxy documentation.

Example Playbook

Here's how to use it in a playbook:

- hosts: all
  become: true
  become_method: sudo
  tasks:
    - name: Install the CyHy commander
      ansible.builtin.include_role:
        name: cyhy_commander

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Author Information

Shane Frasier - jeremy.frasier@gwe.cisa.dhs.gov