Skip to content

README.md

Latest commit

 

History

History
85 lines (59 loc) · 2.81 KB

README.md

File metadata and controls

85 lines (59 loc) · 2.81 KB

ansible-role-cyhy-core

GitHub Build Status License CodeQL

An Ansible role for installing cyhy-core.

Requirements

None.

Role Variables

Variable Description Default Required
cyhy_core_install_geoipupdate Whether to install the MaxMind geoipupdate tool. false No
cyhy_core_maxmind_account_id The MaxMind account ID for access to a GeoIP2 database subscription. n/a Yes
cyhy_core_maxmind_license_key The MaxMind license key that provides access to a GeoIP2 database subscription. n/a Yes
cyhy_core_version The version of cisagov/cyhy-core to install; must be a valid git reference. v1.2.0 No

Dependencies

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_core
  src: https://github.com/cisagov/ansible-role-cyhy-core

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 cisagov/cyhy-core
      ansible.builtin.include_role:
        name: cyhy_core

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