Added role info and Galaxy info

Signed-off-by: Larry Smith Jr <mrlesmithjr@gmail.coml>
This commit is contained in:
Larry Smith Jr 2016-01-21 09:50:33 -05:00
parent 4990df6238
commit 6afe303cfd
2 changed files with 45 additions and 23 deletions

View file

@ -1,31 +1,52 @@
Role Name
=========
A brief description of the role goes here.
Installs and configures tftpd-hpa role.
[![Build Status](https://travis-ci.org/mrlesmithjr/ansible-tftpd-hpa.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-tftpd-hpa)
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.
None
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.
````
---
# defaults file for ansible-tftpd-hpa
tftp_directory: '/var/lib/tftpboot' #defines tftp root directory
tftp_options: '--secure -c' #defines tftp options for daemon...(-c allow new files to be created)
````
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.
None
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:
#### GitHub
````
- hosts: all
become: true
vars:
roles:
- role: ansible-tftpd-hpa
tasks:
````
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
#### Galaxy
````
- hosts: all
become: true
vars:
roles:
- role: mrlesmithjr.tftpd-hpa
tasks:
````
License
-------

View file

@ -1,12 +1,12 @@
galaxy_info:
author: your name
description:
company: your company (optional)
author: Larry Smith Jr.
description: Installs and configures tftpd-hpa role.
#company: your company (optional)
# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
# issue_tracker_url: http://example.com/issue/tracker
# Some suggested licenses:
# - BSD (default)
# - MIT
@ -15,7 +15,7 @@ galaxy_info:
# - Apache
# - CC-BY
license: license (GPLv2, CC-BY, etc)
min_ansible_version: 1.2
# Optionally specify the branch Galaxy will use when accessing the GitHub
@ -25,13 +25,13 @@ galaxy_info:
# branch will be accepted. Otherwise, in all cases, the repo's default branch
# (usually master) will be used.
#github_branch:
#
# Below are all platforms currently available. Just uncomment
# the ones that apply to your role. If you don't see your
# platform on this list, let us know and we'll get it added!
#
#platforms:
platforms:
#- name: EL
# versions:
# - all
@ -97,8 +97,8 @@ galaxy_info:
# - 9.1
# - 9.1
# - 9.2
#- name: Ubuntu
# versions:
- name: Ubuntu
versions:
# - all
# - lucid
# - maverick
@ -108,7 +108,7 @@ galaxy_info:
# - quantal
# - raring
# - saucy
# - trusty
- trusty
# - utopic
# - vivid
#- name: SLES
@ -132,8 +132,8 @@ galaxy_info:
# - lenny
# - squeeze
# - wheezy
galaxy_tags: []
galaxy_tags:
# 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
@ -141,8 +141,9 @@ galaxy_info:
#
# NOTE: A tag is limited to a single word comprised of
# alphanumeric characters. Maximum 20 tags per role.
- system
- network
dependencies: []
# List your role dependencies here, one per line.
# Be sure to remove the '[]' above if you add dependencies
# to this list.
# to this list.