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.
Zuul 8e5149b739 Merge "Add new osci.yaml" 2 days ago
actions Sync libraries & common files prior to freeze 4 months ago
files Sync charm/ceph helpers, tox, and requirements 1 year ago
hooks Hotfix charmhelpers sync for local_address() fix 1 month ago
lib Update tox.ini files from release-tools gold copy 4 years ago
templates Add max-stacks-per-tenant config option 9 months ago
tests Prune gate tests 1 week ago
unit_tests Updates for testing period for 20.01 release 1 month ago
.gitignore Series Upgrade 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.project Add support for application version 4 years ago
.pydevproject Add support for application version 4 years ago
.stestr.conf Update for Python 3 execution 3 years ago
.zuul.yaml Switch to using openstack-python3-charm-jobs 7 months ago
LICENSE Re-license charm as Apache-2.0 4 years ago
Makefile Updates for 20.08 cycle start for groovy and libs 9 months ago
README.md Apply HA section template to README 9 months ago
TODO first version 7 years ago
actions.yaml Series Upgrade 2 years ago
charm-helpers-hooks.yaml Add nrpe support 3 months ago
config.yaml Add nrpe support 3 months ago
copyright Re-license charm as Apache-2.0 4 years ago
hardening.yaml Add hardening support 5 years ago
icon.svg Update charm icon 3 years ago
metadata.yaml Remove Disco and Eoan bits 1 month ago
osci.yaml Add new osci.yaml 1 week ago
requirements.txt Sync release-tools 2 months ago
revision added syslog functionality 7 years ago
test-requirements.txt Updates for testing period for 20.01 release 1 month ago
tox.ini Sync release-tools 2 months 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.

High availability

When more than one unit is deployed with the hacluster application the charm will bring up an HA active/active cluster.

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases the hacluster subordinate charm is used to provide the Corosync and Pacemaker backend HA functionality.

See OpenStack high availability in the OpenStack Charms Deployment Guide for details.


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 \

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.

Policy Overrides

Policy overrides is an advanced feature that allows an operator to override the default policy of an OpenStack service. The policies that the service supports, the defaults it implements in its code, and the defaults that a charm may include should all be clearly understood before proceeding.

Caution: It is possible to break the system (for tenants and other services) if policies are incorrectly applied to the service.

Policy statements are placed in a YAML file. This file (or files) is then (ZIP) compressed into a single file and used as an application resource. The override is then enabled via a Boolean charm option.

Here are the essential commands (filenames are arbitrary):

zip overrides.zip override-file.yaml
juju attach-resource heat policyd-override=overrides.zip
juju config heat use-policyd-override=true

See appendix Policy Overrides in the OpenStack Charms Deployment Guide for a thorough treatment of this feature.


Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.