diff --git a/README.md b/README.md index 5db4bec..3fe5f0e 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ -Manage Docker Machine -========= +# Manage Docker Machine Ansible role to manage machines for Docker Machine. + - Install Docker Machine - Docker Machine create to each target host in inventory - Search and replace docker machine config.json file to change directory to where it stores You can see example how to make playbook, configuration and sample commands here https://github.com/winggundamth/ansible-wing-playbook -Remarks ------------- +## Remarks - This role will run docker-machine command on local machine -- The target machine name in inventory file will be the name of machine name in ```docker-machine ls``` -- Default Docker Machine storage path will be at ```files/docker-machine``` of the playbook. You can change it via ```docker_machine_storage_path``` variable +- The target machine name in inventory file will be the name of machine name in `docker-machine ls` +- Default Docker Machine storage path will be at `files/docker-machine` of the playbook. You can change it via `docker_machine_storage_path` variable - This role intends to be conditional role so in playbook you need to configure variable to specific task to run. You can see example in [Example Playbook](#Example-Playbook) section - - Set ```docker_machine_create``` variable to ```true``` to run docker-machine create - - Set ```docker_machine_manage_config``` variable to ```true``` to search and replace docker machine config.json + - Set `docker_machine_create` variable to `true` to run docker-machine create + - Set `docker_machine_manage_config` variable to `true` to search and replace docker machine config.json -Requirements ------------- +## Requirements - You must can ssh to target host with ssh key -Role Variables --------------- +## Role Variables ```yaml # This is default variables +## Краткое описание +Настраивает хост через утилиту docker-machine + docker_machine_create: false docker_machine_manage_config: false docker_machine_install_version: 0.7.0 @@ -47,17 +47,22 @@ docker_machine_config_variables: - { regexp: '"ClientKeyPath": "(.*)",$', replace: '"ClientKeyPath": "{{ docker_machine_storage_path }}/certs/key.pem",' } - { regexp: '"ClientCertPath": "(.*)",$', replace: '"ClientCertPath": "{{ docker_machine_storage_path }}/certs/cert.pem",' } + + +## Ответственные + +- Code owner: [Александр Ковытин](https://skyeng.slack.com/team/U7ZTTP9JL) +- Product owner: [Артем Науменко](https://skyeng.slack.com/team/U9AGNCBC1) +- Команда: Infra DevOps # This is optional variables docker_machine_extra_parameters: --engine-registry-mirror https://registry-mirror.example.com ``` -Dependencies ------------- +## Dependencies NA -Example Playbook ----------------- +## Example Playbook ```yaml - hosts: all @@ -72,21 +77,18 @@ Example Playbook - "{{ docker_machine_vars_file }}" ``` -List of useful tags ----------------- +## List of useful tags There are some useful tags that you can use to maintain Docker Machine -- docker-machine-create (this needs to configure ```docker_machine_create``` variable to ```true```) -- docker-machine-install (this needs to configure ```docker_machine_create``` variable to ```true```) -- docker-machine-manage-config (this needs to configure ```docker_machine_manage_config``` variable to ```true```) +- docker-machine-create (this needs to configure `docker_machine_create` variable to `true`) +- docker-machine-install (this needs to configure `docker_machine_create` variable to `true`) +- docker-machine-manage-config (this needs to configure `docker_machine_manage_config` variable to `true`) -License -------- +## License MIT -Author Information ------------------- +## Author Information You can see my works at https://github.com/winggundamth