Documentation

os_stack - Add/Remove Heat Stack

New in version 2.2.

Synopsis

  • Add or Remove a Stack to an OpenStack Heat

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
api_timeout
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.
auth
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 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.
auth_type
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.
availability_zone
Ignored. Present for backwards compatibility
cacert
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
A path to a client certificate to use as part of the SSL transaction.
cloud
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.
environment
List of environment files that should be used for the stack creation
interface
(added in 2.3)
    Choices:
  • public ←
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
key
A path to a client key to use as part of the SSL transaction.
name
required
Name of the stack that should be created, name could be char and digit, no space
parameters
Dictionary of parameters for the stack creation
region_name
Name of the region.
rollback
bool
    Choices:
  • no
  • yes ←
Rollback stack creation
state
    Choices:
  • present ←
  • absent
Indicate desired state of the resource
tag
(added in 2.5)
Tag for the stack that should be created, name could be char and digit, no space
template
Path of the template file to use for the stack creation
timeout Default:
3600
Maximum number of seconds to wait for the stack creation
verify
bool
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
bool
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

Examples

---
- name: create stack
  ignore_errors: True
  register: stack_create
  os_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 Returned Description
id
string
always
Stack ID.

Sample:
97a3f543-8136-4570-920e-fd7605c989d6
stack
complex
always
stack info

  identifier
string
Identifier of the current Stack action.

Sample:
test-stack/97a3f543-8136-4570-920e-fd7605c989d6
  description
string
Description of the Stack provided in the heat template.

Sample:
HOT template to create a new instance and networks
  links
list of dict
Links to the current Stack.

Sample:
[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6']
  outputs
list of dict
Output returned by the Stack.

Sample:
{'description': 'IP address of server1 in private network', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}
  creation_time
string
Time when the action has been made.

Sample:
2016-07-05T17:38:12Z
  action
string
Action, could be Create or Update.

Sample:
CREATE
  parameters
dict
Parameters of the current Stack

Sample:
{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': 'Stack CREATE completed successfully', 'status': 'COMPLETE', 'template_description': 'HOT template to create a new instance and networks', 'timeout_mins': 60, 'updated_time': null}
  id
string
Stack ID.

Sample:
97a3f543-8136-4570-920e-fd7605c989d6
  name
string
Name of the Stack

Sample:
test-stack


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Mathieu Bultel (matbu), Steve Baker (steveb)

Hint

If you notice any issues in this documentation you can edit this document to improve it.