More README updates to read(?)

This commit is contained in:
2019-08-31 02:47:50 -04:00
parent 8619d41265
commit 2bebf584f8
11 changed files with 208 additions and 74 deletions

View File

@@ -1,38 +1,36 @@
Role Name
docker
=========
A brief description of the role goes here.
A simple role for installing Docker and Docker Compose on a new Ubuntu host using Ansible.
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.
Expects that the host is using apt package manager, and running a Debian / Ubuntu system.
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.
Found in `.../roles/docker/defaults/main.yml`
```
---
docker_users: [user1, user2]
```
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.
docker_users - A list of users to configure / add to the docker group
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:
After setting the users to configure with Docker in `.../defaults/main.yml`, create the following play.yml and run `ansible-playbook play.yml` after setting the correct hosts in your `/etc/ansible/hosts` file.
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
```
---
- hosts: docker-host
become: yes
roles:
- docker
```
License
-------
Feel free to rename play.yml, hosts group name, etc. Just be sure it reflects to your settings in the related files.
BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).