Skip to content
Snippets Groups Projects
Commit be25b658 authored by Aleksandr Kurbatov's avatar Aleksandr Kurbatov
Browse files

Update roles README

parent ba8e86bb
Branches
Tags
1 merge request!184Updates to the edge_port role
Pipeline #89890 failed
Role Name Role Name
========= =========
A brief description of the role goes here. A role for configuring Edge (access) ports on Nokia SR routers.
Requirements 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. GEANT custom netconf module with Nokia "commit_comment" and "config_mode" features.
Role Variables 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. - vars/main.yaml
- external inventory (group_vars)
- orchestrator (GSO)
Dependencies 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. n/a
Example Playbook 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: Role is supposed to be driven by GSO.
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
License License
------- -------
BSD MIT
Author Information Author Information
------------------ ------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed). A. Kurbatov, S. Spinelli. GEANT Orchestration and Automation Team (GOAT).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment