cleanup README file

master
pkrupa 7 years ago
parent c0781c0743
commit b6c7436b2e

@ -1,12 +1,10 @@
[![Build Status](https://travis-ci.org/mongrelion/ansible-role-docker.svg?branch=master)](https://travis-ci.org/mongrelion/ansible-role-docker) [![Build Status](https://travis-ci.org/mongrelion/ansible-role-docker.svg?branch=master)](https://travis-ci.org/mongrelion/ansible-role-docker)
docker # docker
=========
Install and configure Docker. Install and configure Docker.
Role Variables ## Role Variables
--------------
### `docker_config` ### `docker_config`
@ -23,7 +21,7 @@ Specify the version of Docker to install, e.g. `1.12.6`, `17.05`.
Default value: `17.03` Default value: `17.03`
### `setup_script_md5_sum` ### `docker_setup_script_md5_sum`
Default value: md5 checksum of default `docker_version` setup script (see `defaults/main.yml` for exact default value) Default value: md5 checksum of default `docker_version` setup script (see `defaults/main.yml` for exact default value)
@ -34,7 +32,7 @@ Either:
1. Generate an md5 checksum for the desired version's install script 1. Generate an md5 checksum for the desired version's install script
1. If you know what you are doing and are not worried about security, set this variable to "no" or "false" to disable checksum verification of the setup script. 1. If you know what you are doing and are not worried about security, set this variable to "no" or "false" to disable checksum verification of the setup script.
### `setup_script_url` ### `docker_setup_script_url`
URL pointing to a Docker setup script that will install the specified `docker_version`. URL pointing to a Docker setup script that will install the specified `docker_version`.
@ -42,31 +40,30 @@ Default value: `https://releases.rancher.com/install-docker/{{ docker_version }}
The default URL utilizes [Rancher Labs' version-specific, OS-agnostic setup scripts](https://github.com/rancher/install-docker), which in turn just install the appropriate version of `docker-ce` or `docker-engine` from the official Docker `apt` and `yum` repositories. The default URL utilizes [Rancher Labs' version-specific, OS-agnostic setup scripts](https://github.com/rancher/install-docker), which in turn just install the appropriate version of `docker-ce` or `docker-engine` from the official Docker `apt` and `yum` repositories.
### `upgrade_docker` ### `docker_upgrade`
Per default, this role will only download and run the installation script when Per default, this role will only download and run the installation script when
Docker is not installed (or more precise: when `dockerd` is not in `$PATH`). Set Docker is not installed (or more precise: when `dockerd` is not in `$PATH`). Set
`upgrade_docker` to `True` to override this behavior and force the install `docker_upgrade` to `True` to override this behavior and force the install
script to be run. script to be run.
So in order to upgrade Docker on managed systems, take the following steps: So in order to upgrade Docker on managed systems, take the following steps:
0. Either download a newer version of this role (with a more recent default 0. Either download a newer version of this role (with a more recent default
version) or update `docker_version` and `setup_script_md5_sum` in your version) or update `docker_version` and `docker_setup_script_md5_sum` in your
host/group vars. host/group vars.
1. Run your playbook with `-e upgrade_docker=True` 1. Run your playbook with `-e docker_upgrade=True`
### `docker_proxy`, `docker_http_proxy`, `docker_https_proxy`, `docker_no_proxy` ### `docker_proxy`, `docker_http_proxy`, `docker_https_proxy`, `docker_no_proxy`
`docker_proxy` specifies if proxy need to be applied. Default value of `docker_proxy` is no. If you need proxy set it to yes and updated other three variables as needed. `docker_proxy` specifies if proxy need to be applied. Default value of `docker_proxy` is no. If you need proxy set it to yes and updated other three variables as needed.
Dependencies ## Dependencies
------------
None None
Example Playbook ## Example Playbook
----------------
Install Docker Install Docker
```yaml ```yaml
- hosts: servers - hosts: servers
@ -84,28 +81,24 @@ Install and configure docker
userland-proxy: false userland-proxy: false
``` ```
Testing ## Testing
-------
For development, we use Vagrant.
Bring the VM up with
```
$ vagrant up
```
This will automatically run the playbooks against the virtual machine once it's up.
After making changes to any playbook, you can test the provisioning with
The preferred way of locally testing the role is to use Docker and [molecule](https://github.com/metacloud/molecule) (v1.25). You will have to install Docker on your system. See Get started for a Docker package suitable to for your system.
All packages you need to can be specified in one line:
```sh
pip install ansible 'ansible-lint>=3.4.15' 'molecule==1.25.0' docker 'testinfra>=1.7.0,<=1.10.1'
``` ```
$ vagrant provision This should be similar to one listed in `.travis.yml` file in `install` section.
After installing test suit you can run test by running
```sh
molecule test
``` ```
For more information about molecule go to their [docs](http://molecule.readthedocs.io/en/stable-1.25/).
License ## License
-------
MIT MIT
Author Information ## Author Information
------------------
You can find me on Twitter: [@mongrelion](https://twitter.com/mongrelion) You can find me on Twitter: [@mongrelion](https://twitter.com/mongrelion)

Loading…
Cancel
Save