Catalyst has published example templates that demonstrate the use of the cloud orchestration service at: https://github.com/catalyst/catalystcloud-orchestration.
Note
The default username for all compute instances created by the cloud orchestration service (Heat) is “ec2-user”. This is done to retain compatibility with the AWS CloudFormation service.
The following Heat Orchestration Template (HOT) is a simple example that illustrates how to launch a single instance on the Catalyst Cloud using the Heat orchestration service. For a more interactive example of how to create an instance using a HOT template, please refer to ‘your first instance using orchestration’ in the documentation.
#
# Deploying a compute instance using Heat
#
heat_template_version: 2013-05-23
description: >
Deploying a single compute instance using Heat.
parameters:
key_name:
type: string
description: Name of an existing key pair to use for the server
constraints:
- custom_constraint: nova.keypair
flavor:
type: string
description: Flavor for the server to be created
default: c1.c1r1
constraints:
- custom_constraint: nova.flavor
image:
type: string
description: Image ID or image name to use for the server
default: atomic-7-x86_64
constraints:
- custom_constraint: glance.image
resources:
server:
type: OS::Nova::Server
properties:
key_name: { get_param: key_name }
image: { get_param: image }
flavor: { get_param: flavor }
outputs:
server_networks:
description: The networks of the deployed server
value: { get_attr: [server, networks] }
If the more typical choice of default user (i.e “ubuntu” for Ubuntu images,
“centos” for Centos etc.) is desired, then amend the template to specify
a user_data_format of “RAW” in the OS::Nova::Server properties:
resources:
server:
type: OS::Nova::Server
properties:
key_name: { get_param: key_name }
image: { get_param: image }
flavor: { get_param: flavor }
user_data_format: RAW
If your project has multiple private networks, then the above example will fail to start an instance - you need to specify which private network to attach to:
parameters:
net:
type: string
description: Network for the server use
default: private_net
constraints:
- custom_constraint: neutron.network
resources:
server:
type: OS::Nova::Server
properties:
key_name: { get_param: key_name }
image: { get_param: image }
flavor: { get_param: flavor }
user_data_format: RAW
networks:
- network: {get_param: net}
Before launching or updating a stack, you may want to ensure that the HOT provided is valid. The following command can be used to validate a HOT:
$ openstack orchestration template validate -f hot -t template-file.HOT
This command will return the yaml if it validates and will return an error with a message if it is invalid.
Note
A stack is the collection of resources that will be created by Heat. This might include instances (VMs), networks, subnets, routers, ports, router interfaces, security groups, security group rules, auto-scaling rules, etc.
The following example illustrates how to create a stack using Heat. Note that
parameters specified in the HOT without a default value must be passed
using the --parameter argument. You can pass multiple parameters by
separating them with a semicolon.
$ openstack stack create -t test.hot --parameter "key_name=mykey" mystack
Heat will return a confirmation message indicating the stack is being created:
+---------------------+-------------------------------------------------+
| Field | Value |
+---------------------+-------------------------------------------------+
| id | f2975b89-4a34-4333-90e3-xxxxxxxxxxxx |
| stack_name | mystack |
| description | Deploying a single compute instance using Heat. |
| | |
| creation_time | 2016-08-21T23:37:39Z |
| updated_time | None |
| stack_status | CREATE_IN_PROGRESS |
| stack_status_reason | Stack CREATE started |
+---------------------+-------------------------------------------------+
To obtain information about a running stack:
$ openstack stack show mystack
Heat will return the following information about the stack:
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Field | Value |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| id | 700a9425-8ed8-4993-8773-xxxxxxxxxxxx |
| stack_name | mystack |
| description | Deploying a single compute instance using Heat. |
| | |
| creation_time | 2016-08-22T00:44:14Z |
| updated_time | None |
| stack_status | CREATE_COMPLETE |
| stack_status_reason | Stack CREATE completed successfully |
| parameters | OS::project_id: 3d5d40b4a6904e6db4xxxxxxf53d4f39 |
| | OS::stack_id: 700a9425-8ed8-4993-8773-xxxxxxxxxxxx |
| | OS::stack_name: mystack |
| | flavor: c1.c1r1 |
| | image: atomic-7-x86_64 |
| | key_name: glxxxxxxes |
| | |
| outputs | - description: The networks of the deployed server |
| | output_key: server_networks |
| | output_value: |
| | private-net: |
| | - 192.168.100.17 |
| | |
| links | - href: https://api.nz-por-1.catalystcloud.io:8004/v1/3d5d40b4a6904e6db4xxxxxxf53d4f39/stacks/mystack/700a9425-8ed8-4993-8773-xxxxxxxxxxxx |
| | rel: self |
| | |
| parent | None |
| disable_rollback | True |
| stack_user_project_id | 3d5d40b4a6904e6db4xxxxxxf53d4f39 |
| stack_owner | None |
| capabilities | [] |
| notification_topics | [] |
| timeout_mins | None |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------
You can list the resources that belong to a stack with the command below:
$ openstack stack resource list mystack
+---------------+--------------------------------------+------------------+-----------------+----------------------+
| resource_name | physical_resource_id | resource_type | resource_status | updated_time |
+---------------+--------------------------------------+------------------+-----------------+----------------------+
| server | 498df201-7206-4565-822d-xxxxxxxxxxxx | OS::Nova::Server | CREATE_COMPLETE | 2016-08-22T00:44:14Z |
+---------------+--------------------------------------+------------------+-----------------+----------------------+
To delete a stack:
$ openstack stack delete mystack
Heat will return a confirmation message saying the stack is being deleted.
+--------------------------------------+------------+--------------------+----------------------+
| id | stack_name | stack_status | creation_time |
+--------------------------------------+------------+--------------------+----------------------+
| 1f913699-010e-4564-ba08-xxxxxxxxxxxx | mystack | DELETE_IN_PROGRESS | 2015-04-16T05:58:49Z |
+--------------------------------------+------------+--------------------+----------------------+