Juju Charm - Heat
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins af500cd2af OpenDev Migration Patch 6 days ago
actions Series Upgrade 6 months ago
hooks Sync charm-helpers to enable Ubuntu Disco 2 weeks ago
lib Update tox.ini files from release-tools gold copy 2 years ago
templates Update rabbit driver config options 1 month ago
tests Enable bionic/stein and disco/stein functional tests 2 weeks ago
unit_tests Use chelper generate_ha_relation_data for ha rel 4 months ago
.gitignore Series Upgrade 6 months ago
.gitreview OpenDev Migration Patch 6 days ago
.project Add support for application version 2 years ago
.pydevproject Add support for application version 2 years ago
.stestr.conf Update for Python 3 execution 1 year ago
.zuul.yaml Added tox environment for gathering coverage 1 month ago
LICENSE Re-license charm as Apache-2.0 2 years ago
Makefile Tests dir no longer need copy of charmhelpers 6 months ago
README.md doc: Drop Contact Info section 1 year ago
TODO first version 5 years ago
actions.yaml Series Upgrade 6 months ago
charm-helpers-hooks.yaml Update charm-helpers-hooks.yaml and sync ch 2 months ago
config.yaml Remove deploy from source support 1 year ago
copyright Re-license charm as Apache-2.0 2 years ago
hardening.yaml Add hardening support 3 years ago
icon.svg Update charm icon 1 year ago
metadata.yaml Update series metadata 2 weeks ago
requirements.txt Update requirements 6 months ago
revision added syslog functionality 5 years ago
test-requirements.txt Replace ostestr with stestr in testing framework. 1 month ago
tox.ini Replace ostestr with stestr in testing framework. 1 month ago



Heat is the main project in the OpenStack Orchestration program. It implements an orchestration engine to launch multiple composite cloud applications based on templates in the form of text files that can be treated like code.

This charm deploys the Heat infrastructure.


Heat requires the existence of the other core OpenStack services deployed via Juju charms, specifically: mysql, rabbitmq-server, keystone and nova-cloud-controller. The following assumes these services have already been deployed.

After deployment of the cloud, the domain-setup action must be run to configure required domains, roles and users in the cloud for Heat stacks.

For juju 2.x deployments use:

juju run-action heat/0 domain-setup

If using juju 1.x run:

juju action do heat/0 domain-setup

This is only required for >= OpenStack Kilo.


There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node’s interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option ‘vip’ must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or “reserved” IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option ‘dns-ha’ must be set to true and at least one of ‘os-public-hostname’, ‘os-internal-hostname’ or ‘os-internal-hostname’ must be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances: If neither ‘vip’ nor ‘dns-ha’ is set and the charm is related to hacluster If both ‘vip’ and ‘dns-ha’ are set as they are mutually exclusive If ‘dns-ha’ is set and none of the os-{admin,internal,public}-hostname(s) are set

Network Space support

This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal and admin endpoints.

Access to the underlying MySQL instance can also be bound to a specific space using the shared-db relation.

To use this feature, use the --bind option when deploying the charm:

juju deploy heat --bind "public=public-space internal=internal-space admin=admin-space shared-db=internal-space"

alternatively these can also be provided as part of a juju native bundle configuration:

  charm: cs:xenial/heat
  num_units: 1
    public: public-space
    admin: admin-space
    internal: internal-space
    shared-db: internal-space

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using os-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set.