Juju Charm - Heat
Go to file
Andrew McLeod 600a4fd0c4 Enable xenial-pike amulet test
Make default func27-smoke xenial-pike
Charm-helpers sync

Change-Id: If59ca2cdc42100b34a4806d54cf9229ccb2fc2ef
2017-11-18 13:13:22 +13:00
actions Correctly scope role assignment for heat_domain_admin 2017-09-18 11:38:36 +01:00
hooks Enable xenial-pike amulet test 2017-11-18 13:13:22 +13:00
lib Update tox.ini files from release-tools gold copy 2016-09-09 19:42:39 +00:00
templates Add support for use-internal-endpoints 2017-09-05 11:52:39 +01:00
tests Enable xenial-pike amulet test 2017-11-18 13:13:22 +13:00
unit_tests Ensure auth_encryption_key is identical for all units 2017-09-22 16:23:30 +01:00
.coveragerc added tests 2013-11-27 13:06:15 +01:00
.gitignore DNS HA 2016-06-15 11:40:19 -07:00
.gitreview Add gitreview prior to migration to openstack 2016-02-24 21:53:31 +00:00
.project Add support for application version 2016-09-20 12:15:23 +01:00
.pydevproject Add support for application version 2016-09-20 12:15:23 +01:00
.testr.conf Add tox support 2015-11-02 11:18:46 +00:00
actions.yaml Make some notes 2016-02-10 14:38:58 +00:00
charm-helpers-hooks.yaml Update repo to do ch-sync from Git 2017-09-26 10:22:26 +02:00
charm-helpers-tests.yaml Update repo to do ch-sync from Git 2017-09-26 10:22:26 +02:00
config.yaml Add support for use-internal-endpoints 2017-09-05 11:52:39 +01:00
copyright Re-license charm as Apache-2.0 2016-07-01 17:23:55 +01:00
hardening.yaml Add hardening support 2016-03-24 10:39:29 +00:00
icon.svg Update charm icon 2017-08-02 16:01:41 +01:00
LICENSE Re-license charm as Apache-2.0 2016-07-01 17:23:55 +01:00
Makefile Update repo to do ch-sync from Git 2017-09-26 10:22:26 +02:00
metadata.yaml Add Artful dev series metadata 2017-09-26 14:16:48 -04:00
README.md doc: Drop Contact Info section 2017-09-21 17:12:45 +01:00
requirements.txt Fix pbr requirement 2016-04-13 10:23:33 +00:00
revision added syslog functionality 2014-02-03 14:05:03 +01:00
test-requirements.txt Enable Zesty-Ocata Amulet Tests 2017-04-30 13:09:12 -07:00
TODO first version 2013-11-19 13:14:57 +01:00
tox.ini Enable xenial-pike amulet test 2017-11-18 13:13:22 +13:00

Overview

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.

Usage

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.

HA/Clustering

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:

heat:
  charm: cs:xenial/heat
  num_units: 1
  bindings:
    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.