Description

OpenStack is a reliable cloud infrastructure. Its mission is to produce
the ubiquitous cloud computing platform that will meet the needs of public
and private cloud providers regardless of size, by being simple to implement
and massively scalable.
.
OpenStack Compute, codenamed Nova, is a cloud computing fabric controller. In
addition to its "native" API (the OpenStack API), it also supports the Amazon
EC2 API.
.
This charm provides the cloud controller service for OpenStack Nova and includes
nova-scheduler, nova-api and nova-conductor services.

nova-cloud-controller

Cloud controller node for OpenStack nova. Contains nova-schedule, nova-api, nova-network and nova-objectstore.

If console access is required then console-proxy-ip should be set to a client accessible IP that resolves
to the nova-cloud-controller. If running in HA mode then the public vip is used if console-proxy-ip is set
to local. Note: The console access protocol is baked into a guest when it is created, if you change it then
console access for existing guests will stop working

Special considerations to be deployed using Postgresql

juju deploy nova-cloud-controller
juju deploy postgresql
juju add-relation "nova-cloud-controller:pgsql-nova-db" "postgresql:db"
juju add-relation "nova-cloud-controller:pgsql-neutron-db" "postgresql:db"

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 nova-cloud-controller --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:

nova-cloud-controller:
  charm: cs:xenial/nova-cloud-controller
  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.

Configuration

ssl_key
(string) SSL key to use with certificate specified as ssl_cert.
vip_iface
(string) Default network interface to use for HA vip when it cannot be automatically determined.
eth0
verbose
(boolean) Enable verbose logging.
os-admin-network
(string) The IP address and netmask of the OpenStack Admin network (e.g. 192.168.0.0/24) This network will be used for admin endpoints.
console-ssl-cert
(string) Used for encrypted console connections. This differs from the SSL certificate used for API endpoints and is used for console sessions only. Setting this value along with console-ssl-key will enable encrypted console sessions. This has nothing to do with Nova API SSL and can be used independently. This can be used in conjunction when console-access-protocol is set to 'novnc' or 'spice'.
enable-serial-console
(boolean) Enable serial console access to instances using websockets (insecure). This is only supported on OpenStack Juno or later, and will disable the normal console-log output for an instance.
vip
(string) Virtual IP(s) to use to front API services in HA configuration. . If multiple networks are being used, a VIP should be provided for each network, separated by spaces.
console-access-protocol
(string) Protocol to use when accessing virtual machine console. Supported types are None, spice, xvpvnc, novnc and vnc (for both xvpvnc and novnc)
single-nova-consoleauth
(boolean) When this configuration is set to True, a single instance of nova-consoleauth service will be running, this allows users to always authenticate against the same instance and avoid authentications issues when the token used was stored in a different instance. If memcached is being used to store the tokens, then it's recommended to change this configuration to False.
True
worker-multiplier
(float) The CPU core multiplier to use when configuring worker processes for Nova and Neutron. By default, the number of workers for each daemon is set to twice the number of CPU cores a service unit has.
2
use-syslog
(boolean) Setting this to True will allow supporting services to log to syslog.
bridge-netmask
(string) Netmask to be assigned to bridge interface
255.255.255.0
rabbit-user
(string) Username used to access rabbitmq queue
nova
haproxy-queue-timeout
(int) Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 5000ms is used.
ssl_cert
(string) SSL certificate to install and use for API ports. Setting this value and ssl_key will enable reverse proxying, point Nova's entry in the Keystone catalog to use https, and override any certificate and key issued by Keystone (if it is configured to do so).
prefer-ipv6
(boolean) If True enables IPv6 support. The charm will expect network interfaces to be configured with an IPv6 address. If set to False (default) IPv4 is expected. NOTE: these charms do not currently support IPv6 privacy extension. In order for this charm to function correctly, the privacy extension must be disabled and a non-temporary address must be configured/available on your network interface.
neutron-external-network
(string) Name of the external network for floating IP addresses provided by Neutron.
ext_net
network-manager
(string) Network manager for the cloud; supports the following options: FlatDHCPManager (nova-network) (default) FlatManager (nova-network) Neutron (Full SDN solution) When using the Neutron option you will most likely want to use the neutron-gateway charm to provide L3 routing and DHCP Services.
FlatDHCPManager
ram-allocation-ratio
(float) The physical ram -> virtual ram ratio to use in the Nova scheduler. Increasing this value will increase instance density on compute nodes at the potential expense of instance performance.
1.5
rabbit-vhost
(string) Rabbitmq vhost
openstack
haproxy-server-timeout
(int) Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 30000ms is used.
bridge-interface
(string) Bridge interface to be configured
br100
scheduler-default-filters
(string) List of filter class names to use for filtering hosts when not specified in the request.
RetryFilter,AvailabilityZoneFilter,CoreFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter
os-public-network
(string) The IP address and netmask of the OpenStack Public network (e.g. 192.168.0.0/24) This network will be used for public endpoints.
bridge-ip
(string) IP to be assigned to bridge interface
11.0.0.1
ha-bindiface
(string) Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster.
eth0
nagios_servicegroups
(string) A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup.
console-ssl-key
(string) SSL key to use with certificate specified as console-ssl-cert.
haproxy-client-timeout
(int) Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 30000ms is used.
service-guard
(boolean) Ensure required relations are made and complete before allowing services to be started By default, services may be up and accepting API request from install onwards. Enabling this flag ensures that services will not be started until the minimum 'core relations' have been made between this charm and other charms. For this charm the following relations must be made: * shared-db or (pgsql-nova-db, pgsql-neutron-db) * amqp * identity-service
ha-mcastport
(int) Default multicast port number that will be used to communicate between HA Cluster nodes.
5404
os-public-hostname
(string) The hostname or address of the public endpoints provided by the nova-cloud-controller in the keystone identity provider. This value will be used for public endpoints. For example, an os-public-hostname set to 'ncc.example.com' with ssl enabled will create public endpoints such as: https://ncc.example.com:8775/v2/$(tenant_id)s
action-managed-upgrade
(boolean) If True enables openstack upgrades for this charm via juju actions. You will still need to set openstack-origin to the new repository but instead of an upgrade running automatically across all units, it will wait for you to execute the openstack-upgrade action for this charm on each unit. If False it will revert to existing behavior of upgrading all units on config change.
openstack-origin
(string) Repository from which to install. May be one of the following: distro (default), ppa:somecustom/ppa, a deb url sources entry, or a supported Cloud Archive release pocket. Supported Cloud Archive sources include: cloud:<series>-<openstack-release> cloud:<series>-<openstack-release>/updates cloud:<series>-<openstack-release>/staging cloud:<series>-<openstack-release>/proposed For series=Precise we support cloud archives for openstack-release: * icehouse For series=Trusty we support cloud archives for openstack-release: * juno * kilo * ... NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade.
distro
console-keymap
(string) Console keymap
en-us
use-internal-endpoints
(boolean) Openstack mostly defaults to using public endpoints for internal communication between services. If set to True this option will configure services to use internal endpoints where possible.
api-rate-limit-rules
(string) The API rate-limit rules to use for the deployed nova API, if any. Contents of this config options will be inserted in the api-paste.ini file under the "filter:ratelimit" section as "limits". The syntax for these rules is documented at http://docs.openstack.org/kilo/config-reference/content/configuring-compute-API.html
config-flags
(string) Comma-separated list of key=value config flags. These values will be placed in the nova.conf [DEFAULT] section.
dns-ha
(boolean) Use DNS HA with MAAS 2.0. Note if this is set do not set vip settings below.
cpu-allocation-ratio
(float) The per physical core -> virtual core ratio to use in the Nova scheduler. . Increasing this value will increase instance density on compute nodes at the expense of instance performance.
16
os-internal-network
(string) The IP address and netmask of the OpenStack Internal network (e.g. 192.168.0.0/24) This network will be used for internal endpoints.
database
(string) Database name
nova
nova-alchemy-flags
(string) Comma-separated list of key=value sqlalchemy related config flags to be set in nova.conf [database] section.
disable-aws-compat
(boolean) For OpenStack Icehouse, Juno and Kilo by default a compatibility layer for EC2 and S3 is configured, setting this option to `true` the services are stopped and disabled.
region
(string) OpenStack Region
RegionOne
nagios_context
(string) Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.
juju
console-proxy-ip
(string) If console-access-protocol != None then this is the ip published to clients for access to console proxy. Set to local for the ip address of the nova-cloud-controller serving the request to be used
local
ssl_ca
(string) SSL CA to use with the certificate and key provided - this is only required if you are providing a privately signed ssl_cert and ssl_key.
harden
(string) Apply system hardening. Supports a space-delimited list of modules to run. Supported modules currently include os, ssh, apache and mysql.
openstack-origin-git
(string) Specifies a default OpenStack release name, or a YAML dictionary listing the git repositories to install from. The default Openstack release name may be one of the following, where the corresponding OpenStack github branch will be used: * liberty * mitaka * newton * master The YAML must minimally include requirements, neutron, and nova repositories, and may also include repositories for other dependencies: repositories: - {name: requirements, repository: 'git://github.com/openstack/requirements', branch: master} - {name: neutron, repository: 'git://github.com/openstack/neutron', branch: master} - {name: nova, repository: 'git://github.com/openstack/nova', branch: master} release: master
os-admin-hostname
(string) The hostname or address of the admin endpoints provided by the nova-cloud-controller in the keystone identity provider. This value will be used for admin endpoints. For example, an os-admin-hostname set to 'ncc.admin.example.com' with ssl enabled will create a admin endpoint for as: https://ncc.admin.example.com:8775/v2/$(tenant_id)s
debug
(boolean) Enable debug logging.
os-internal-hostname
(string) The hostname or address of the internal endpoints provided by the nova-cloud-controller in the keystone identity provider. This value will be used for internal endpoints. For example, an os-internal-hostname set to 'ncc.internal.example.com' with ssl enabled will create a internal endpoint as: https://ncc.internal.example.com:8775/v2/$(tenant_id)s
haproxy-connect-timeout
(int) Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 5000ms is used.
database-user
(string) Username for database access
nova
vip_cidr
(int) Default CIDR netmask to use for HA vip when it cannot be automatically determined.
24