Browse Source

Updated readme and info files

Jeroen De Meerleer 1 year ago
parent
commit
b708528de3
2 changed files with 41 additions and 22 deletions
  1. 32 11
      README.md
  2. 9 11
      meta/main.yml

+ 32 - 11
README.md

@@ -1,38 +1,59 @@
-Role Name
+Ansible-Role-IPv6
 =========
 
-A brief description of the role goes here.
+Configures IPv6 networking as documented on [OVH documentation](http://docs.ovh.ca/en/guides-network-ipv6.html)
 
 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.
+* Ubuntu
+* IPv6 capabilities
 
 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.
+ipv6_address: The actual IPv6 address (eg: ::1)
+ipv6_netmask: Netmask for IPv6
+ipv6_gateway: The gateway (eg: ::1)
+ipv6_interface: The interface to confiure (eg. eth0)
+
+All variables are required
 
 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.
+(No dependencies)
 
 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:
+Variables are better placed in `host_vars` as IP-addresses are unique to hosts
+
+```
+# playbook-dir/host_vars/localhost.yml
+
+ipv6_address: ::1
+ipv6_netmask: 128
+ipv6_gateway: ::1
+ipv6_interface: eth0
+```
+
+```
+# playbook-dir/playbook.yml
+
+- hosts: localhost
+  roles:
+   - { role: jeroened.ipv6 }
+```
 
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
 
 License
 -------
 
-BSD
+MIT
 
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Contributors:
+- Jeroen "JeroenED" De Meerleer <me@jeroened.be> (maintainer)

+ 9 - 11
meta/main.yml

@@ -1,7 +1,6 @@
 galaxy_info:
-  author: your name
-  description: your description
-  company: your company (optional)
+  author: JeroenED
+  description: Configures IPv6
 
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
@@ -14,9 +13,9 @@ galaxy_info:
   # - GPLv3
   # - Apache
   # - CC-BY
-  license: license (GPLv2, CC-BY, etc)
+  license: MIT
 
-  min_ansible_version: 1.2
+  min_ansible_version: 1.9
 
   # If this a Container Enabled role, provide the minimum Ansible Container version.
   # min_ansible_container_version:
@@ -32,11 +31,10 @@ galaxy_info:
   #
   # platforms is a list of platforms, and each platform has a name and a list of versions.
   #
-  # platforms:
-  # - name: Fedora
-  #   versions:
-  #   - all
-  #   - 25
+  platforms:
+  - name: Ubuntu
+    versions:
+    - all
   # - name: SomePlatform
   #   versions:
   #   - all
@@ -44,7 +42,7 @@ galaxy_info:
   #   - 7
   #   - 99.99
 
-  galaxy_tags: []
+  galaxy_tags: [IPv6, Networking]
     # List tags for your role here, one per line. A tag is a keyword that describes
     # and categorizes the role. Users find roles by searching for tags. Be sure to
     # remove the '[]' above, if you add tags to this list.