Juju Charm - Neutron API
Go to file
OpenDev Sysadmins a68e530b2e OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:44:52 +00:00
actions Re-license charm as Apache-2.0 2016-07-03 17:47:52 +01:00
files MidoNet support up until Liberty 2016-01-22 16:14:59 +01:00
hooks Replace openstack.org git:// URLs with https:// 2019-03-24 20:33:00 +00:00
templates notification topics missed from mitaka config 2016-07-25 17:32:16 +00:00
tests Updates for stable branch creation for 16.07 2016-07-28 16:04:56 +02:00
unit_tests Replace openstack.org git:// URLs with https:// 2019-03-24 20:33:00 +00:00
.coveragerc Added openstack upgrade, unit tests and lint fixes 2014-06-20 11:02:09 +01:00
.gitignore DNS HA 2016-06-23 09:21:03 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:44:52 +00:00
.project Rationalize endpoint generation, rework tests, add support for multiple network support 2014-06-27 12:55:45 +01:00
.pydevproject Rationalize endpoint generation, rework tests, add support for multiple network support 2014-06-27 12:55:45 +01:00
.testr.conf Add tox support 2015-11-02 09:28:57 +00:00
LICENSE Re-license charm as Apache-2.0 2016-07-03 17:47:52 +01:00
Makefile Use bundletester for amulet test execution 2016-07-18 17:57:18 +01:00
README.md DNS HA 2016-06-23 09:21:03 +01:00
actions.yaml Add pause/resume actions and sync charm-helpers 2016-03-20 14:25:47 +00:00
charm-helpers-hooks.yaml Updates for stable branch creation for 16.07 2016-07-28 16:04:56 +02:00
charm-helpers-tests.yaml Updates for stable branch creation for 16.07 2016-07-28 16:04:56 +02:00
config.yaml Merge "Install networking-hyperv when deploying from source." 2016-07-21 21:51:08 +00:00
copyright Re-license charm as Apache-2.0 2016-07-03 17:47:52 +01:00
hardening.yaml Add hardening support 2016-03-31 10:40:23 +01:00
icon.svg Updated with fixes suggested from bug comments 2014-06-23 12:18:17 +01:00
metadata.yaml Add Juju Network Space support 2016-03-31 12:28:22 +01:00
requirements.txt Fix pbr requirement 2016-04-13 10:24:26 +00:00
setup.cfg Added openstack upgrade, unit tests and lint fixes 2014-06-20 11:02:09 +01:00
test-requirements.txt Use bundletester for amulet test execution 2016-07-18 17:57:18 +01:00
tox.ini Use bundletester for amulet test execution 2016-07-18 17:57:18 +01:00

README.md

Overview

This principle charm provides the OpenStack Neutron API service which was previously provided by the nova-cloud-controller charm.

When this charm is related to the nova-cloud-controller charm the nova-cloud controller charm will shutdown its api service, de-register it from keystone and inform the compute nodes of the new neutron url.

Usage

To deploy (partial deployment only):

juju deploy neutron-api
juju deploy neutron-openvswitch

juju add-relation neutron-api mysql
juju add-relation neutron-api rabbitmq-server
juju add-relation neutron-api neutron-openvswitch
juju add-relation neutron-api nova-cloud-controller

This charm also supports scale out and high availability using the hacluster charm:

juju deploy hacluster neutron-hacluster
juju add-unit neutron-api
juju set neutron-api vip=<VIP FOR ACCESS>
juju add-relation neutron-hacluster neutron-api

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

Restrictions

This charm only support deployment with OpenStack Icehouse or better.

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 neutron-api --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:

neutron-api:
  charm: cs:xenial/neutron-api
  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.