Juju Charm - Neutron API
Go to file
Frode Nordahl 67901457bd
Enable Ussuri and Focal
Do c-h sync.

Keep focal at dev-bundles until neighbouring charms are enabled.

Change-Id: Ia834fe36f9683703c58ea4c678b8aa454efcc38d
2020-03-07 15:37:29 +01:00
actions Sync in security guide fixes and fix local 2019-06-19 08:35:48 +02:00
files MidoNet support up until Liberty 2016-01-22 16:14:59 +01:00
hooks Enable Ussuri and Focal 2020-03-07 15:37:29 +01:00
lib Update tox.ini files from release-tools gold copy 2016-09-09 19:42:45 +00:00
templates Merge "Disable Apache port 80" 2020-01-31 15:48:35 +00:00
tests Enable Ussuri and Focal 2020-03-07 15:37:29 +01:00
unit_tests Conditionally make neutron-plugin relations required 2020-02-24 16:44:54 +01:00
.gitignore Enable support for security group logging 2018-10-09 12:01:03 +03: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
.stestr.conf Replace ostestr with stestr in testing framework. 2019-03-07 17:12:09 -05:00
.zuul.yaml Switch to Ussuri jobs 2019-10-22 11:55:10 +08:00
LICENSE Re-license charm as Apache-2.0 2016-07-03 17:47:52 +01:00
Makefile Enable Ussuri and Focal 2020-03-07 15:37:29 +01:00
README.md Streamline README for policy overrides 2020-01-09 13:21:00 -05:00
actions.yaml Add security-checklist audit 2019-03-13 10:32:50 +01:00
charm-helpers-hooks.yaml Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:12 -05:00
config.yaml Conditional default of ``manage-neutron-plugin-legacy-mode`` 2020-02-24 16:44:54 +01:00
copyright Update http to https. 2018-12-11 14:33:34 +08:00
hardening.yaml Add hardening support 2016-03-31 10:40:23 +01:00
icon.svg Update charm icon 2017-08-02 18:19:28 +01:00
metadata.yaml Enable Ussuri and Focal 2020-03-07 15:37:29 +01:00
requirements.txt Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:12 -05:00
setup.cfg Add Python 3 Train unit tests 2019-07-30 10:18:44 -04:00
test-requirements.txt Conditional default of ``manage-neutron-plugin-legacy-mode`` 2020-02-24 16:44:54 +01:00
tox.ini Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:12 -05:00



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.


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


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


This charm only support deployment with OpenStack Icehouse or better.

Internal DNS for Cloud Guests

The charm supports enabling internal DNS resolution for cloud guests in accordance with the OpenStack DNS integration guide. To enable internal DNS resolution, the 'enable-ml2-dns' option must be set to True. When enabled, the domain name specified in the 'dns-domain' will be advertised as the nameserver search path by the dhcp agents.

The Nova compute service will leverage this functionality when enabled. When ports are allocated by the compute service, the dns_name of the port is populated with a DNS sanitized version of the instance's display name. The Neutron DHCP agents will then create host entries in the dnsmasq's configuration files matching the dns_name of the port to the IP address associated with the port.

Note that the DNS nameserver provided to the instance by the DHCP agent depends on the tenant's network setup. The Neutron DHCP agent only advertises itself as a nameserver when the Neutron subnet does not have nameservers configured. If additional nameservers are needed and internal DNS is desired, then the IP address of the DHCP port should be added to the subnet's list of configured nameservers.

For more information refer to the OpenStack documentation on DNS Integration.

External DNS for Cloud Guests

To add support for DNS record auto-generation when Neutron ports and floating IPs are created the charm needs a relation with designate charm:

juju deploy designate
juju add-relation neutron-api designate

In order to enable the creation of reverse lookup (PTR) records, enable "allow-reverse-dns-lookup" charm option:

juju config neutron-api allow-reverse-dns-lookup=True

and configure the following charm options:

juju config neutron-api ipv4-ptr-zone-prefix-size=<IPV4 PREFIX SIZE>
juju config neutron-api ipv6-ptr-zone-prefix-size=<IPV6 PREFIX SIZE>

For example, if prefix sizes of your IPv4 and IPv6 subnets are "24" (e.g. "") and "64" (e.g. "fdcd:06ca:e498:216b::/64") respectively, configure the charm options as follows:

juju config neutron-api ipv4-ptr-zone-prefix-size=24
juju config neutron-api ipv6-ptr-zone-prefix-size=64

For more information refer to the OpenStack documentation on DNS Integration


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 \

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

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

Additional Middleware Requests by Neutron Plugin Charms

Some neutron plugins may require additional middleware to be added to api-paste.ini. In order to support that a subordinate may pass extra_middleware via the neutron-plugin-api-subordinate relation.

Relation data to be set by subordinates: {'extra_middleware': [{ 'type': 'middleware_type', 'name': 'middleware_name', 'config': { 'setting_1': 'value_1', 'setting_2': 'value_2'}}]}

It would not be correct to do that from your own plugin as this requires the neutron-api service restart which should be handled in this charm.

The developer guide for Neutron contains a description of the startup process which makes it clear that api-paste.ini is parsed only once in neutron-api's lifetime (see the "WSGI Application" section):


For the api-paste.ini format in general, please consult PasteDeploy repository docs/index.txt, "Config Format" section: https://github.com/Pylons/pastedeploy

Classes in loadwsgi.py contain config_prefixes that can be used for middleware types - these are the prefixes the charm code validates passed data against:


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 neutron-api policyd-override=overrides.zip
juju config neutron-api 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.