Ansible playbook driver options
Ansible playbook driver options specification
Keywords reference for Ansible Playbook driver
The following table describes the attributes that can be configured on the Ansible playbook driver.
| Keyword | Type | Description | Value |
|---|---|---|---|
| playbook | string | It is the playbook file location path mandatory | - |
| inventory | string | It is the ansible-playbook inventory mandatory | It can be either an inventory file or and adhoc inventory, such 127.0.0.1, |
Variables-mapping reference
ansible-playbook driver provides to ansible-playbook the variables-mapping entries as extra-vars.
| Key name | Description | Default argument-name | Default argument-value |
|---|---|---|---|
| image_builder_label_key | This is the argument-name to set the name of the intermediate container that is used to create the Docker image using the ansible-playbook driver | image_builder_label | The argument-value is set as the full qualified name of the image |
| image_from_name_key | This is the argument-name to set the name of the parent image from which the new image will be built using the ansible-playbook driver | image_from_name | The argument-value is set as the parent image’s name within the images-tree |
| image_from_registry_host_key | This is the argument-name to set the parent image’s registry host when creating a Docker image using the ansible-playbook driver | image_from_registry_host | The argument-value is set as the parent image’s registry host within the images-tree |
| image_from_registry_namespace_key | This is the argument-name to set the parent image’s namespace within the registry when creating a Docker image using the ansible-playbook driver | image_from_registry_namespace | The argument-value is set as the parent image’s namespace within the images-tree |
| image_from_tag_key | This is the argument-name to set the parent image’s tag when creating a Docker image using the ansible-playbook driver. | image_from_tag | The argument-value is set as the parent image’s version within the images-tree |
| image_name_key | This is the argument-name to set the name of the new Docker image that will be built using the ansible-playbook driver | image_name | If not specified, the argument-value for the image name will be derived from the name of the image within the images-tree |
| image_tag_key | This is the argument-name to set the tag for the new Docker image that will be built using the ansible-playbook driver | image_tag | If not specified, the argument-value for the default tag will be the version of the image within the images-tree |
| image_registry_namespace_key | This is the argument-name that you can use to set the namespace or organization of the registry where the image will be pushed. It allows you to specify the namespace separately from the image name when pushing the image to a registry | image_registry_namespace | There is no default argument-value. If it is not specified, the image will be pushed to the root namespace of the specified registry |
| image_registry_host_key | This is the argument-name that you can use to set the Docker registry host when creating a Docker image | image_registry_host | Stevedore leaves the argument-value empty, which means that the Docker Hub registry host is used |
| image_extra_tags_key | This is the argument-name that you can use to specify additional tags to be applied to the Docker image when it is built using the ansible-playbook driver. You can specify multiple tags providing a JSON array | image_extra_tags_key | - |
| push_image_key | Use this argument-name to specify a variable that controls whether the Docker image should be automatically pushed after it’s built | push_image | The argument-value is set as false |
Last modified March 26, 2023: change header image (ef70c3b)