chore: update README
This commit is contained in:
parent
62b98a3770
commit
c04be3941c
1 changed files with 13 additions and 29 deletions
42
README.md
42
README.md
|
@ -11,25 +11,21 @@ Install and configure docker with swarm
|
|||
|
||||
## Role variables
|
||||
|
||||
* `docker_swarm_manager` - set the cluster role (default: `false`)
|
||||
* `docker_advertise_addr` - listen address
|
||||
* `docker_join_token` - join token for slave node
|
||||
* `docker_remote_addrs` - manager addresses for slave node
|
||||
* `docker_networks` - array with the docker networks
|
||||
* `swarm_manager` - set the cluster role (default: `false`)
|
||||
* `swarm_advertise_addr` - listen address
|
||||
* `swarm_join_token` - join token for slave node
|
||||
* `swarm_remote_addrs` - manager addresses for slave node
|
||||
* `swarm_networks` - array with the docker networks
|
||||
|
||||
```
|
||||
- name: proxy
|
||||
config:
|
||||
- gateway: 192.168.0.1
|
||||
subnet: 192.168.0.0/16
|
||||
iprange: 192.168.0.0/16
|
||||
proxy:
|
||||
state: present
|
||||
```
|
||||
|
||||
* `docker_services` - array with the service to manage
|
||||
* `swarm_services` - hash with the service to manage
|
||||
|
||||
```
|
||||
- name: wordpress
|
||||
wordpress:
|
||||
image: wordpress:latest
|
||||
args:
|
||||
- '--api'
|
||||
|
@ -67,24 +63,12 @@ Install and configure docker with swarm
|
|||
|
||||
## Development
|
||||
|
||||
### Test syntax with yamllint
|
||||
### Test with molecule and docker
|
||||
|
||||
* install `python` and `python-pip`
|
||||
* install yamllint `pip install yamllint`
|
||||
* run `yamllint .`
|
||||
|
||||
### Test syntax with ansible-lint
|
||||
|
||||
* install `python` and `python-pip`
|
||||
* install yamllint `pip install ansible-lint`
|
||||
* run `ansible-lint .`
|
||||
|
||||
### Tests with docker
|
||||
|
||||
* install ruby, vagrant and virtualbox
|
||||
* install bundler `gem install bundler`
|
||||
* install dependencies `bundle install`
|
||||
* run the tests `kitchen test`
|
||||
* install [docker](https://docs.docker.com/engine/installation/)
|
||||
* install `python3` and `python3-pip`
|
||||
* install molecule and dependencies `pip3 install molecule 'molecule[docker]' docker ansible-lint testinfra yamllint`
|
||||
* run `molecule test`
|
||||
|
||||
## License
|
||||
|
||||
|
|
Loading…
Reference in a new issue