docker_machine – Docker Machine inventory source¶
Synopsis¶
Get inventory hosts from Docker Machine.
Uses a YAML configuration file that ends with docker_machine.(yml|yaml).
The plugin sets standard host variables
ansible_host
,ansible_port
,ansible_user
andansible_ssh_private_key
.The plugin stores the Docker Machine ‘env’ output variables in dm_ prefixed host variables.
Requirements¶
The below requirements are needed on the local master node that executes this inventory.
Parameters¶
Examples¶
# Minimal example
plugin: docker_machine
# Example using constructed features to create a group per Docker Machine driver
# (https://docs.docker.com/machine/drivers/), e.g.:
# $ docker-machine create --driver digitalocean ... mymachine
# $ ansible-inventory -i ./path/to/docker-machine.yml --host=mymachine
# {
# ...
# "digitalocean": {
# "hosts": [
# "mymachine"
# ]
# ...
# }
strict: no
keyed_groups:
- separator: ''
key: docker_machine_node_attributes.DriverName
# Example grouping hosts by Digital Machine tag
strict: no
keyed_groups:
- prefix: tag
key: 'dm_tags'
# Example using compose to override the default SSH behaviour of asking the user to accept the remote host key
compose:
ansible_ssh_common_args: '"-o StrictHostKeyChecking=accept-new"'
Status¶
This inventory is not guaranteed to have a backwards compatible interface. [preview]
This inventory is maintained by the Ansible Community. [community]
Authors¶
Ximon Eighteen (@ximon18)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.