Random Repo
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Justin Lecher a671e38c6a [UPD] parallel testing 2 months ago
..
meta [FIX] rename 2 months ago
molecule/default [UPD] parallel testing 2 months ago
tests [FIX] role usage 2 months ago
.yamllint [FIX] rename 2 months ago
Makefile [FIX] duplicated make target 2 months ago
README.md [FIX] rename 2 months ago

README.md

{{ cookiecutter.ansible_namespace }}.{{ cookiecutter.ansible_collection }}.{{ cookiecutter.role_name }}

{{ cookiecutter.role_short_description }}

Requirements

Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.

Role Variables

A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.

Variable Type Default Description
foo string null Foo is so generic

Dependencies

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: servers
      roles:
         - role: {{ cookiecutter.ansible_namespace }}.{{ cookiecutter.ansible_collection }}.{{ cookiecutter.role_name }}
          vars: {}

License

Apache-2.0

Author Information

  • {{ cookiecutter.full_name }} <{{ cookiecutter.email }}>