README

The final part of the role we need to complete is the README.md file; this contains the information that is displayed on the Ansible Galaxy website. When we initiated our role using ansible-galaxy, it created a README.md file with a basic structure. The one for our role looks like the following file:

Ansible Docker Role
=========
This role installs the current Edge build Docker CE using the official repo, for more information on Docker CE see the official site at [https://www.docker.com/community-edition](https://www.docker.com/community-edition).

Requirements
------------
Apart from requiring root access via `become: yes` this role has no special requirements.

Role Variables
--------------
All of the variables can be found in the `vars` folder.

Dependencies
------------
None.

Example Playbook
----------------
An example playbook can be found below;

```
- hosts: docker
gather_facts: true
become: yes
become_method: sudo

roles:
- russmckendrick.docker
```

License
-------
BSD

Author Information
------------------
This role is published by [Russ McKendrick](http://russ.mckendrick.io/).

Now that we have all of the files we need in place, we can look at committing our role to GitHub and, from there, publish it on Ansible Galaxy.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
18.223.125.219