nova cloud controller #495

Supports: xenial bionic eoan focal trusty groovy
Add to new model

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.


Overview

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

Usage

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.

Spaces

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.

Default Quota Configuration

This charm supports default quota settings for projects. This feature is only available from OpenStack Icehouse and later releases.

The default quota settings do not overwrite post-deployment CLI quotas set by operators. Existing projects whose quotas were not modified will adopt the new defaults when a config-changed hook occurs. Newly created projects will also adopt the defaults set in the charm's config.

By default, the charm's quota configs are not set and OpenStack projects have the below default values:

quota-instances : 10
quota-cores : 20
quota-ram : 51200
quota-metadata_items : 128
quota-injected_files : 5
quota-injected_file_content_bytes : 10240
quota-injected_file_path_length : 255
quota-key_pairs : 100
quota-server_groups : 10 (available since Juno)
quota-server_group_members : 10 (available since Juno)

SSH knownhosts caching

This section covers the option involving the caching of SSH host lookups (knownhosts) on each nova-compute unit. Caching of SSH host lookups speeds up deployment of nova-compute units when first deploying a cloud, and when adding a new unit.

There is a Boolean configuration key cache-known-hosts that ensures that any given host lookup to be performed just once. The default is true which means that caching is performed.

Note: A cloud can be deployed with the cache-known-hosts key set to false, and be set to true post-deployment. At that point the hosts will have been cached. The key only controls whether the cache is used or not.

If the above key is set, a new Juju action clear-unit-knownhost-cache is provided to clear the cache. This can be applied to a unit, service, or an entire nova-cloud-controller application. This would be needed if DNS resolution had changed in an existing cloud or during a cloud deployment. Not clearing the cache in such cases could result in an inconsistent set of knownhosts files.

This action will cause DNS resolution to be performed (for unit/service/application), thus potentially triggering a relation-set on the nova-cloud-controller unit(s) and subsequent changed hook on the related nova-compute units.

The action is used as follows, based on unit, service, or application, respectively:

juju run-action nova-cloud-controller/0 clear-unit-knownhost-cache target=nova-compute/2
juju run-action nova-cloud-controller/0 clear-unit-knownhost-cache target=nova-compute
juju run-action nova-cloud-controller/0 clear-unit-knownhost-cache

In a high-availability setup, the action must be run on all nova-cloud-controller units.

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 nova-cloud-controller policyd-override=overrides.zip
juju config nova-cloud-controller use-policyd-override=true

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

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.


Configuration

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.
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
bridge-interface
(string) Bridge interface to be configured.
br100
bridge-ip
(string) IP to be assigned to bridge interface.
11.0.0.1
bridge-netmask
(string) Netmask to be assigned to bridge interface.
255.255.255.0
cache-known-hosts
(boolean) If true then the charm will cache host and ip lookups for a unit when populating the knownhosts file for nova-compute service. This is a known performance issue around maintaining the knownhosts files for each nova-compute service, and caching is a strategy to reduce the hook execution time when the 'cloud-compute' relation changes. If false, then no caching is performed. Changing from true to false will NOT cause new lookups to be performed. . To clear the caches and force new lookups to be performed, the action 'clear-unit-knownhost-cache' should be used. . This config flag is new. If there are any DNS issues during the deployment onto different platforms then the knownhost lookups may be inconsistent. Thus it may be preferred to keep the flag false during deployment and then switch to true after deployment. . Note that the charm keeps a record of the lookups for each unit regardless of the setting of this flag. The cache is only used if the flag is true.
True
config-flags
(string) Comma-separated list of key=value config flags. These values will be placed in the nova.conf [DEFAULT] section.
console-access-port
(int) Used to customize the console access port.
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). . NOTE: xvpvnc is not supported with bionic/ussuri or focal (or later) releases.
console-keymap
(string) Console keymap.
en-us
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
console-ssl-cert
(string) DEPRECATED: Please use ssl_cert configuration option or the vault certificates relation. This configuration option will be removed in the 19.07 charm release. . 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'.
console-ssl-key
(string) DEPRECATED: Please use ssl_key configuration option or the vault certificates relation. This configuration option will be removed in the 19.07 charm release. . SSL key to use with certificate specified as console-ssl-cert.
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
cross-az-attach
(boolean) Allow attach between instance and volume in different availability zones. . If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. . If that AZ is not in Cinder, the volume create request will fail and the instance will fail the build request. . By default there is no availability zone restriction on volume attach.
True
database
(string) Database name.
nova
database-user
(string) Username for database access.
nova
debug
(boolean) Enable debug logging.
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.
disk-allocation-ratio
(float) Increase the amount of disk space that nova can overcommit to guests. . Increasing this value will increase instance density on compute nodes with an increased risk of hypervisor storage becoming full.
1
dns-ha
(boolean) Use DNS HA with MAAS 2.0. Note if this is set do not set vip settings below.
enable-new-services
(boolean) Enable new nova-compute services on this host automatically. When a new nova-compute service starts up, it gets registered in the database as an enabled service. Sometimes it can be useful to register new compute services in disabled state and then enabled them at a later point in time. This option only sets this behavior for nova-compute services, it does not auto-disable other services like nova-conductor, nova-scheduler, nova-consoleauth, or nova-osapi_compute. Possible values: True: Each new compute service is enabled as soon as it registers itself. False: Compute services must be enabled via an os-services REST API call or with the CLI with nova service-enable <hostname> <binary>, otherwise they are not ready to use.
True
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.
ha-bindiface
(string) Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster.
eth0
ha-mcastport
(int) Default multicast port number that will be used to communicate between HA Cluster nodes.
5404
haproxy-client-timeout
(int) Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.
haproxy-connect-timeout
(int) Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.
haproxy-queue-timeout
(int) Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.
haproxy-server-timeout
(int) Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.
harden
(string) Apply system hardening. Supports a space-delimited list of modules to run. Supported modules currently include os, ssh, apache and mysql.
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
nagios_servicegroups
(string) A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup.
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
neutron-external-network
(string) Name of the external network for floating IP addresses provided by Neutron.
ext_net
notification-format
(string) Specifies which notification format shall be used by nova-cloud-controller. . Starting in the Pike release, the notification_format includes both the versioned and unversioned message notifications. Ceilometer does not yet consume the versioned message notifications, so intentionally make the default notification format unversioned until this is implemented. . Possible Values are both, versioned, unversioned.
unversioned
nova-alchemy-flags
(string) Comma-separated list of key=value sqlalchemy related config flags to be set in nova.conf [database] section.
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 Ubuntu Cloud Archive e.g. . cloud:<series>-<openstack-release> cloud:<series>-<openstack-release>/updates cloud:<series>-<openstack-release>/staging cloud:<series>-<openstack-release>/proposed . See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which cloud archives are available and supported. . NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade unless action-managed-upgrade is set to True.
distro
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
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.
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
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.
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
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.
pci-alias
(string) The pci-passthrough-whitelist option of nova-compute charm is used for specifying which PCI devices are allowed passthrough. pci-alias is more a convenience that can be used in conjunction with Nova flavor properties to automatically assign required PCI devices to new instances. You could, for example, have a GPU flavor or a SR-IOV flavor: . pci-alias='{"vendor_id":"8086","product_id":"10ca","name":"a1"}' . This configures a new PCI alias 'a1' which will request a PCI device with a vendor id of 0x8086 and a product id of 10ca. . For more information about the syntax of pci_alias, refer to https://docs.openstack.org/ocata/config-reference/compute/config-options.html
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.
quota-cores
(int) The number of instance cores or vCPUs allowed per project. Possible Values are positive integers or 0 and -1 to disable the quota.
quota-count-usage-from-placement
(boolean) Setting this to True, enables the counting of quota usage from the placement service. . By default, the parameter is False and Nova will count quota usage for instances, cores, and ram from its cell databases. . This is only supported on OpenStack Train or later releases.
quota-injected-file-size
(int) The number of bytes allowed per injected file. . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-injected-files
(int) The number of injected files allowed. . File injection allows users to customize the personality of an instance by injecting data into it upon boot. Only text file injection is permitted: binary or ZIP files are not accepted. During file injection, any existing files that match specified files are renamed to include .bak extension appended with a timestamp. . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-injected-path-size
(int) The maximum allowed injected file path length. . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-instances
(int) The number of instances allowed per project. Possible Values are positive integers or 0 and -1 to disable the quota.
quota-key-pairs
(int) The maximum number of key pairs allowed per user. . Users can create at least one key pair for each project and use the key pair for multiple instances that belong to that project. . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-metadata-items
(int) The number of metadata items allowed per instance. . Users can associate metadata with an instance during instance creation. This metadata takes the form of key-value pairs. . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-ram
(int) The number of megabytes of instance RAM allowed per project. Possible Values are positive integers or 0 and -1 to disable the quota.
quota-server-group-members
(int) The maximum number of servers per server group. Not supported in Icehouse and before . Possible Values are positive integers or 0 and -1 to disable the quota.
quota-server-groups
(int) The maxiumum number of server groups per project. Not supported in Icehouse and before . Server groups are used to control the affinity and anti-affinity scheduling policy for a group of servers or instances. Reducing the quota will not affect any existing group, but new servers will not be allowed into groups that have become over quota. . Possible Values are positive integers or 0 and -1 to disable the quota.
rabbit-user
(string) Username used to access rabbitmq queue.
nova
rabbit-vhost
(string) Rabbitmq vhost.
openstack
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. . NOTE: When in a hyper-converged architecture, make sure to make enough room for infrastructure services running on your compute hosts by adjusting this value.
0.98
region
(string) OpenStack Region
RegionOne
scheduler-default-filters
(string) List of filter class names to use for filtering hosts when not specified in the request. The default filters varies based on OpenStack release.
scheduler-host-subset-size
(int) The value to be configured for the host_subset_size property on FilterScheduler. This property sets the size of the subset of best hosts selected by the scheduler. . When a new instance is created, it will be scheduled on a host chosen randomly from a subset of the best hosts with the size set by this property. . Possible Values are positive integers. Any value less than 1 will be treated as 1.
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 * amqp * identity-service
spice-agent-enabled
(boolean) Enable the SPICE guest agent support on the instances. . The Spice agent works with the Spice protocol to offer a better guest console experience. However, the Spice console can still be used without the Spice Agent. . For Windows guests is recommended to set this to configuration option to False and for those images set the property hw_pointer_model=usbtablet
True
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.
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).
ssl_key
(string) SSL key to use with certificate specified as ssl_cert.
unique-server-names
(string) Sets the scope of the check for unique instance names. . An empty value (the default) means that no uniqueness check is done and duplicate names are possible. 'project': The instance name check is done only for instances within the same project. 'global': The instance name check is done for all instances regardless of the project.
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.
use-policyd-override
(boolean) If True then use the resource file named 'policyd-override' to install override YAML files in the service's policy.d directory. The resource file should be a ZIP file containing at least one yaml file with a .yaml or .yml extension. If False then remove the overrides.
use-syslog
(boolean) Setting this to True will allow supporting services to log to syslog.
vendor-data
(string) A JSON-formatted string that will serve as vendor metadata (via "StaticJSON" provider) to all VM's within an OpenStack deployment, regardless of project or domain. For deployments prior to Rocky and if metadata is configured to be provided by neutron-gateway, this value should be set in the neutron-gateway charm.
vendor-data-url
(string) A URL serving JSON-formatted data that will serve as vendor metadata (via "DynamicJSON" provider) to all VM's within an OpenStack deployment, regardless of project or domain. . Only supported in OpenStack Newton and higher. For deployments prior to Rocky and if metadata is configured to be provided by neutron-gateway, this value should be set in the neutron-gateway charm.
verbose
(boolean) Enable verbose logging.
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.
vip_cidr
(int) Default CIDR netmask to use for HA vip when it cannot be automatically determined.
24
vip_iface
(string) Default network interface to use for HA vip when it cannot be automatically determined.
eth0
worker-multiplier
(float) The CPU core multiplier to use when configuring worker processes for this service. By default, the number of workers for each daemon is set to twice the number of CPU cores a service unit has. When deployed in a LXD container, this default value will be capped to 4 workers unless this configuration option is set.