Skip to content

Automation CLI

Heat · OpenStack CLI · python-heatclient

Deploy and manage orchestration stacks from HOT templates. Inspect resources, events, and outputs from the command line.

Stacks

openstack stack listList stacks
openstack stack show <name|id>Show stack details
openstack stack create -t <template> <name>Create a stack from a template
openstack stack update -t <template> <name|id>Update an existing stack
openstack stack delete <name|id>Delete a stack
openstack stack output list <name|id>List stack outputs
openstack stack output show <name|id> <output-key>Show a specific output value

Resources

openstack stack resource list <stack>List resources in a stack
openstack stack resource show <stack> <resource>Show resource details

Events

openstack stack event list <stack>List stack events
openstack stack failures list <stack>List failure events (debugging)

Templates

openstack orchestration template validate -t <template>Validate a HOT template
openstack orchestration resource type listList available resource types

Examples

Deploy a stack from a template

# Validate a template first
openstack orchestration template validate -t my-stack.yaml
# Output: (empty = valid)

# Create the stack
openstack stack create -t my-stack.yaml \
  --parameter image=Ubuntu-22.04 \
  --parameter flavor=r1.medium \
  --parameter key_name=my-laptop \
  --wait \
  my-app-stack

# Check outputs
openstack stack output list my-app-stack
# +-------------+-----------------------------+
# | output_key  | description                 |
# +-------------+-----------------------------+
# | server_ip   | Public IP of the server     |
# | server_id   | Instance ID                 |
# +-------------+-----------------------------+

openstack stack output show my-app-stack server_ip
# output_value: 203.0.113.55

Debug a failed stack

# Check stack status
openstack stack show my-app-stack -c stack_status -c stack_status_reason
# stack_status: CREATE_FAILED
# stack_status_reason: Resource CREATE failed: ...

# List failures
openstack stack failures list my-app-stack

# Inspect specific resource
openstack stack resource list my-app-stack
openstack stack resource show my-app-stack my-server

# View event timeline
openstack stack event list my-app-stack --nested-depth 2

Quake AI tips

Template version

Use heat_template_version: 2021-04-06 (Wallaby), which is the latest supported version on Quake AI (Antelope release).

Stack update

openstack stack update performs in-place updates. Resources that cannot be updated in-place are recreated. Review the template diff before updating production stacks.

Resource types

Run openstack orchestration resource type list to see all available resource types. Quake AI supports standard OpenStack resources (OS::Nova::Server, OS::Neutron::*, OS::Cinder::*, etc.).

Related

Automation API Reference →Automation CLI (docs) →OpenStack CLI setup →
← Kubernetes CLIS3 Tools →