openstack.cloud.stack – Add/Remove Heat Stack
Note
This plugin is part of the openstack.cloud collection (version 1.5.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify: openstack.cloud.stack.
Requirements
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.12.0
python >= 3.6
Parameters
Parameter |
Comments |
|---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
List of environment files that should be used for the stack creation |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name of the stack that should be created, name could be char and digit, no space |
|
Dictionary of parameters for the stack creation |
|
Name of the region. |
|
Rollback stack creation Choices:
|
|
Indicate desired state of the resource Choices:
|
|
Tag for the stack that should be created, name could be char and digit, no space |
|
Path of the template file to use for the stack creation |
|
Maximum number of seconds to wait for the stack creation Default: 3600 |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
---
- name: create stack
ignore_errors: True
register: stack_create
openstack.cloud.stack:
name: "{{ stack_name }}"
tag: "{{ tag_name }}"
state: present
template: "/path/to/my_stack.yaml"
environment:
- /path/to/resource-registry.yaml
- /path/to/environment.yaml
parameters:
bmc_flavor: m1.medium
bmc_image: CentOS
key_name: default
private_net: "{{ private_net_param }}"
node_count: 2
name: undercloud
image: CentOS
my_flavor: m1.large
external_net: "{{ external_net_param }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Stack ID. Returned: always Sample: “97a3f543-8136-4570-920e-fd7605c989d6” |
|
stack info Returned: always |
|
Action, could be Create or Update. Returned: success Sample: “CREATE” |
|
Time when the action has been made. Returned: success Sample: “2016-07-05T17:38:12Z” |
|
Description of the Stack provided in the heat template. Returned: success Sample: “HOT template to create a new instance and networks” |
|
Stack ID. Returned: success Sample: “97a3f543-8136-4570-920e-fd7605c989d6” |
|
Identifier of the current Stack action. Returned: success Sample: “test-stack/97a3f543-8136-4570-920e-fd7605c989d6” |
|
Links to the current Stack. Returned: success Sample: “[{\u0027href\u0027: \u0027http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6\u0027]” |
|
Name of the Stack Returned: success Sample: “test-stack” |
|
Output returned by the Stack. Returned: success Sample: “{\u0027description\u0027: \u0027IP address of server1 in private network\u0027, \u0027output_key\u0027: \u0027server1_private_ip\u0027, \u0027output_value\u0027: \u002710.1.10.103\u0027}” |
|
Parameters of the current Stack Returned: success Sample: “{\u0027OS::project_id\u0027: \u00277f6a3a3e01164a4eb4eecb2ab7742101\u0027, \u0027OS::stack_id\u0027: \u002797a3f543-8136-4570-920e-fd7605c989d6\u0027, \u0027OS::stack_name\u0027: \u0027test-stack\u0027, \u0027stack_status\u0027: \u0027CREATE_COMPLETE\u0027, \u0027stack_status_reason\u0027: \u0027Stack CREATE completed successfully\u0027, \u0027status\u0027: \u0027COMPLETE\u0027, \u0027template_description\u0027: \u0027HOT template to create a new instance and networks\u0027, \u0027timeout_mins\u0027: 60, \u0027updated_time\u0027: null}” |
Authors
OpenStack Ansible SIG