From 35316017144fd6808d4f51d1883a50f804d10e92 Mon Sep 17 00:00:00 2001 From: Edward Hope-Morley Date: Mon, 5 Jun 2017 23:12:44 +0100 Subject: [PATCH] Cleanup config.yaml Change-Id: I5e42168cd74ebe973912db2003c242c9eb534fc2 --- config.yaml | 185 +++++++++++++++++++++++++--------------------------- 1 file changed, 89 insertions(+), 96 deletions(-) diff --git a/config.yaml b/config.yaml index 210fb078..2243daf0 100644 --- a/config.yaml +++ b/config.yaml @@ -1,11 +1,11 @@ options: debug: - default: False type: boolean + default: False description: Enable debug logging. verbose: - default: False type: boolean + default: False description: Enable verbose logging. use-syslog: type: boolean @@ -13,44 +13,38 @@ options: description: | Setting this to True will allow supporting services to log to syslog. openstack-origin: - default: distro type: string + default: distro description: | - Repository from which to install. May be one of the following: + 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: - + or a supported Ubuntu Cloud Archive e.g. + . cloud:- cloud:-/updates cloud:-/staging cloud:-/proposed - - For series=Precise we support cloud archives for openstack-release: - * icehouse - - For series=Trusty we support cloud archives for openstack-release: - * juno - * kilo - * ... - + . + 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. + a later version of OpenStack will trigger a software upgrade unless + action-managed-upgrade is set to True. openstack-origin-git: - default: type: string + default: description: | 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 and glance repositories, and may also include repositories for other dependencies: repositories: @@ -61,13 +55,29 @@ options: repository: 'git://github.com/openstack/glance', branch: master} release: master - database-user: - default: glance + action-managed-upgrade: + type: boolean + default: False + description: | + 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. + harden: type: string + default: + description: | + Apply system hardening. Supports a space-delimited list of modules + to run. Supported modules currently include os, ssh, apache and mysql. + database-user: + type: string + default: glance description: Database username database: - default: glance type: string + default: glance description: Glance database name. api-config-flags: type: string @@ -84,19 +94,19 @@ options: glance-registry.conf where 'value' may itself be a comma-separated list of values to be assigned to the 'key'. region: - default: RegionOne type: string + default: RegionOne description: OpenStack Region use-internal-endpoints: - default: False type: boolean + default: False description: | 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. ceph-osd-replication-count: - default: 3 type: int + default: 3 description: | This value dictates the number of replicas ceph must make of any object it stores within the images rbd pool. Of course, this only @@ -120,17 +130,41 @@ options: only be increased, never decreased - so it is important to identify the percent of data that will likely reside in the pool. restrict-ceph-pools: - default: False type: boolean + default: False description: | Optionally restrict Ceph key permissions to access pools as required. + worker-multiplier: + type: float + default: + description: | + The CPU core multiplier to use when configuring worker processes for + Glance. 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. + expose-image-locations: + type: boolean + default: True + description: | + Expose underlying image locations via the API when using Ceph for image + storage. Only disable this option if you do not wish to use + copy-on-write clones of RAW format images with Ceph in Cinder and Nova. + rabbit-user: + type: string + default: glance + description: Username to request access on rabbitmq-server. + rabbit-vhost: + type: string + default: openstack + description: RabbitMQ virtual host to request access on rabbitmq-server. # HA configuration settings dns-ha: type: boolean default: False description: | - Use DNS HA with MAAS 2.0. Note if this is set do not set vip - settings below. + Use DNS HA with MAAS 2.0. Note if this is set do not set vip + settings below. vip: type: string default: @@ -167,33 +201,33 @@ 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. haproxy-queue-timeout: type: int default: description: | - Queue timeout configuration in ms for haproxy, used in HA - configurations. If not provided, default value of 5000ms is used. + Queue timeout configuration in ms for haproxy, used in HA + configurations. If not provided, default value of 5000ms is used. haproxy-connect-timeout: type: int default: description: | - Connect timeout configuration in ms for haproxy, used in HA - configurations. If not provided, default value of 5000ms is used. + Connect timeout configuration in ms for haproxy, used in HA + configurations. If not provided, default value of 5000ms is used. ssl_cert: type: string default: description: | - SSL certificate to install and use for API ports. Setting this value + SSL certificate to install and use for API ports. Setting this value and ssl_key will enable reverse proxying, point Glance's entry in the - Keystone catalog to use https, and override any certficiate and key + Keystone catalog to use https, and override any certificate and key issued by Keystone (if it is configured to do so). ssl_key: type: string @@ -205,21 +239,12 @@ 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. - rabbit-user: - default: glance - type: string - description: Username to request access on rabbitmq-server. - rabbit-vhost: - default: openstack - type: string - description: RabbitMQ virtual host to request access on rabbitmq-server. - # Network configuration options - # by default all access is over 'private-address' + # Network config (by default all access is over 'private-address') os-admin-network: 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. @@ -227,7 +252,7 @@ options: 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. @@ -235,7 +260,7 @@ options: 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. @@ -259,8 +284,8 @@ options: in the keystone identity provider. . This value will be used for internal endpoints. For example, an - os-internal-hostname set to 'glance.internal.example.com' with ssl enabled will - create a internal endpoint for glance of: + os-internal-hostname set to 'glance.internal.example.com' with ssl + enabled will create a internal endpoint for glance of: . https://glance.internal.example.com:9292/ os-admin-hostname: @@ -287,51 +312,19 @@ options: 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. - worker-multiplier: - type: float - default: - description: | - The CPU core multiplier to use when configuring worker processes for - Glance. 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. + # Monitoring config nagios_context: - default: "juju" type: string + default: "juju" description: | - 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 + 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 are running multiple environments with the same services in them this allows you to differentiate between them. nagios_servicegroups: + type: string default: "" - type: string description: | - A comma-separated list of nagios servicegroups. - If left empty, the nagios_context will be used as the servicegroup - action-managed-upgrade: - type: boolean - default: False - description: | - 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. - expose-image-locations: - type: boolean - default: True - description: | - Expose underlying image locations via the API when using Ceph for image - storage. Only disable this option if you do not wish to use copy-on-write - clones of RAW format images with Ceph in Cinder and Nova. - harden: - default: - type: string - description: | - Apply system hardening. Supports a space-delimited list of modules - to run. Supported modules currently include os, ssh, apache and mysql. + A comma-separated list of nagios service groups. + If left empty, the nagios_context will be used as the servicegroup