Skip to content
Snippets Groups Projects
README.md 1.3 KiB
Newer Older
  • Learn to ignore specific revisions
  • Marica Antonacci's avatar
    Marica Antonacci committed
    Role Name
    =========
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    A brief description of the role goes here.
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Requirements
    ------------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    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.
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Role Variables
    --------------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    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.
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Dependencies
    ------------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    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.
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Example Playbook
    ----------------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
        - hosts: servers
          roles:
             - { role: username.rolename, x: 42 }
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    License
    -------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    BSD
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    Author Information
    ------------------
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    
    
    Marica Antonacci's avatar
    Marica Antonacci committed
    An optional section for the role authors to include contact information, or a website (HTML is not allowed).
    
    Gioacchino Vino's avatar
    Gioacchino Vino committed
    Test