From 47e423b4d26fd77fa29901e03e857ca0a09d51a6 Mon Sep 17 00:00:00 2001 From: Edward Hope-Morley Date: Fri, 10 Jul 2015 15:14:23 +0100 Subject: [PATCH] [trivial] Cleanup config.yaml Partially-Closes-Bug: 1473426 --- config.yaml | 128 +++++++++++++++++++++++++++++----------------------- 1 file changed, 72 insertions(+), 56 deletions(-) diff --git a/config.yaml b/config.yaml index 72a78a18..b09172fd 100644 --- a/config.yaml +++ b/config.yaml @@ -1,4 +1,17 @@ options: + debug: + default: False + type: boolean + description: Enable debug logging. + verbose: + default: False + type: boolean + description: Enable verbose logging. + use-syslog: + type: boolean + default: False + description: | + Setting this to True will allow supporting services to log to syslog. openstack-origin: default: distro type: string @@ -7,17 +20,27 @@ options: distro (default), ppa:somecustom/ppa, a deb url sources entry, or a supported Cloud Archive release pocket. - Supported Cloud Archive sources include: cloud:precise-folsom, - cloud:precise-folsom/updates, cloud:precise-folsom/staging, - cloud:precise-folsom/proposed. + Supported Cloud Archive sources include: - Note that updating this setting to a source that is known to - provide a later version of OpenStack will trigger a software - upgrade. + cloud:- + cloud:-/updates + cloud:-/staging + cloud:-/proposed - Note that when openstack-origin-git is specified, openstack - specific packages will be installed from source rather than - from the openstack-origin repository. + 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. + + NOTE: when openstack-origin-git is specified, openstack specific + packages will be installed from source rather than from the + openstack-origin repository. openstack-origin-git: default: type: string @@ -70,12 +93,12 @@ options: default: FlatDHCPManager type: string description: | - Network manager for the cloud; supports the following options - . + Network manager for the cloud; supports the following options: + FlatDHCPManager (nova-network) (default) FlatManager (nova-network) Neutron|Quantum (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. bridge-interface: @@ -94,15 +117,15 @@ options: default: ovs type: string description: | - Quantum plugin to use for network management; supports - . + Quantum plugin to use for network management; supports: + ovs - OpenvSwitch Plugin nvp|nsx - Nicira Network Virtualization Platform/ VMware NSX Network Virtualization Platform (renamed for Icehouse) - . - This configuration only has context when used with - network-manager Quantum|Neutron. + + This configuration only has context when used with network-manager + Quantum|Neutron. quantum-security-groups: type: string default: "no" @@ -113,11 +136,15 @@ options: neutron-external-network: type: string default: ext_net - description: Name of the external network for floating IP addresses provided by Neutron. + description: | + Name of the external network for floating IP addresses provided by + Neutron. config-flags: - default: None type: string - description: Comma separated list of key=value config flags to be set in nova.conf. + default: + description: | + Comma-separated list of key=value config flags. These values will be + placed in the nova.conf [DEFAULT] section. region: default: RegionOne type: string @@ -135,8 +162,8 @@ options: type: string default: eth0 description: | - Default network interface to use for HA vip when it cannot be automatically - determined. + Default network interface to use for HA vip when it cannot be + automatically determined. vip_cidr: type: int default: 24 @@ -159,14 +186,14 @@ options: type: int default: description: | - Server timeout configuration in ms for haproxy, used in HA configurations. - If not provided, default value of 30000ms is used. + Server timeout configuration in ms for haproxy, used in HA + configurations. If not provided, default value of 30000ms is used. haproxy-client-timeout: type: int default: description: | - Client timeout configuration in ms for haproxy, used in HA configurations. - If not provided, default value of 30000ms is used. + Client timeout configuration in ms for haproxy, used in HA + configurations. If not provided, default value of 30000ms is used. ssl_cert: type: string default: @@ -185,11 +212,6 @@ options: description: | 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. - use-syslog: - type: boolean - default: False - description: | - If set to True, supporting services will log to syslog. # Neutron NVP and VMware NSX plugin configuration nvp-controllers: type: string @@ -226,25 +248,25 @@ options: type: string default: description: | - The IP address and netmask of the OpenStack Admin network (e.g., + 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-network: type: string default: description: | - The IP address and netmask of the OpenStack Internal network (e.g., + 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-network: type: string default: description: | - The IP address and netmask of the OpenStack Public network (e.g., + 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. os-public-hostname: type: string @@ -252,11 +274,11 @@ options: description: | 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 service-guard: type: boolean @@ -264,16 +286,16 @@ options: description: | 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 @@ -295,14 +317,6 @@ options: default: 'en-us' description: | Console keymap - debug: - default: False - type: boolean - description: Enable debug logging - verbose: - default: False - type: boolean - description: Enable verbose logging worker-multiplier: type: int default: 2 @@ -323,7 +337,7 @@ options: default: 1.5 description: | 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. prefer-ipv6: @@ -333,7 +347,7 @@ options: 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 @@ -345,15 +359,17 @@ options: 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 + + juju-myservice-0 + If you're running multiple environments with the same services in them this allows you to differentiate between them. nagios_servicegroups: default: "" type: string description: | - A comma-separated list of nagios servicegroups. - If left empty, the nagios_context will be used as the servicegroup + A comma-separated list of nagios servicegroups. If left empty, the + nagios_context will be used as the servicegroup. single-nova-consoleauth: type: boolean default: true