From 05feba48164dd3e43e1e82e224ecc63dd031813a Mon Sep 17 00:00:00 2001 From: Mario Splivalo Date: Mon, 12 Jun 2017 13:42:01 +0200 Subject: [PATCH] Cleanup config.yaml Change-Id: Iff544d471e99400529ff1c98ccce348276e6786b --- config.yaml | 359 ++++++++++++++++++++++++++-------------------------- 1 file changed, 182 insertions(+), 177 deletions(-) diff --git a/config.yaml b/config.yaml index d0f1f9e6..3a8443dd 100644 --- a/config.yaml +++ b/config.yaml @@ -1,21 +1,24 @@ options: loglevel: - default: 1 type: int + default: 1 description: RadosGW debug level. Max is 20. source: type: string default: description: | - Optional configuration to support use of additional sources such as: - - - ppa:myteam/ppa - - cloud:trusty-proposed/kilo - - http://my.archive.com/ubuntu main - - The last option should be used in conjunction with the key configuration - option. - + Optional 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:- + cloud:-/updates + cloud:-/staging + cloud:-/proposed + . + See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which + cloud archives are available and supported. + . Note that a minimum ceph version of 0.48.2 is required for use with this charm which is NOT provided by the packages in the main Ubuntu archive for precise but is provided in the Ubuntu cloud archive. @@ -25,144 +28,63 @@ options: description: | Key ID to import to the apt keyring to support use with arbitary source configuration from outside of Launchpad archives or PPA's. + 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. config-flags: type: string default: description: | - User provided Ceph configuration. Supports a string representation of - a python dictionary where each top-level key represents a section in - the ceph.conf template. You may only use sections supported in the - template. - . - WARNING: this is not the recommended way to configure the underlying - services that this charm installs and is used at the user's own risk. - This option is mainly provided as a stop-gap for users that either - want to test the effect of modifying some config or who have found - a critical bug in the way the charm has configured their services - and need it fixed immediately. We ask that whenever this is used, - that the user consider opening a bug on this charm at - http://bugs.launchpad.net/charms providing an explanation of why the - config was needed so that we may consider it for inclusion as a - natively supported config in the the charm. + User provided Ceph configuration. Supports a string representation of + a python dictionary where each top-level key represents a section in + the ceph.conf template. You may only use sections supported in the + template. + . + WARNING: this is not the recommended way to configure the underlying + services that this charm installs and is used at the user's own risk. + This option is mainly provided as a stop-gap for users that either + want to test the effect of modifying some config or who have found + a critical bug in the way the charm has configured their services + and need it fixed immediately. We ask that whenever this is used, + that the user consider opening a bug on this charm at + http://bugs.launchpad.net/charms providing an explanation of why the + config was needed so that we may consider it for inclusion as a + natively supported config in the the charm. port: type: int default: 80 description: | The port that the RADOS Gateway will listen on. - # Keystone integration - operator-roles: - default: "Member,Admin" - type: string - description: | - Comma-separated list of Swift operator roles; used when integrating with - OpenStack Keystone. - region: - default: RegionOne - type: string - description: | - OpenStack region that the RADOS gateway supports; used when integrating - with OpenStack Keystone. - cache-size: - default: 500 - type: int - description: Number of keystone tokens to hold in local cache. - revocation-check-interval: - default: 600 - type: int - description: Interval between revocation checks to keystone. - use-syslog: + prefer-ipv6: type: boolean default: False description: | - If set to True, supporting services will log to syslog. - dns-ha: + 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. + pool-prefix: + type: string + default: + description: | + The rados gateway stores objects in many different pools. If you would + like to have multiple rados gateways each pointing to a separate set of + pools set this prefix. The charm will then set up a new set of pools. + If your prefix has a dash in it that will be used to split the prefix + into region and zone. Please read the documentation on federated rados + gateways for more information on region and zone. + restrict-ceph-pools: type: boolean default: False description: | - Use DNS HA with MAAS 2.0. Note if this is set do not set vip - settings below. - vip: - type: string - default: - description: | - 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. - ha-bindiface: - type: string - default: eth0 - description: | - Default network interface on which HA cluster will bind to communication - with the other members of the HA Cluster. - ha-mcastport: - type: int - default: 5414 - description: | - Default multicast port number that will be used to communicate between - HA Cluster nodes. - # Network configuration options - # 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., - 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., - 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., - 192.168.0.0/24) - . - This network will be used for public endpoints. - os-public-hostname: - type: string - default: - description: | - The hostname or address of the public endpoints created for ceph-radosgw - in the keystone identity provider. - - This value will be used for public endpoints. For example, an - os-public-hostname set to 'files.example.com' with will create - the following public endpoint for the ceph-radosgw: - - https://files.example.com:80/swift/v1 - os-internal-hostname: - type: string - default: - description: | - The hostname or address of the internal endpoints created for ceph-radosgw - in the keystone identity provider. - - This value will be used for internal endpoints. For example, an - os-internal-hostname set to 'files.internal.example.com' with will create - the following internal endpoint for the ceph-radosgw: - - https://files.internal.example.com:80/swift/v1 - os-admin-hostname: - type: string - default: - description: | - The hostname or address of the admin endpoints created for ceph-radosgw - in the keystone identity provider. - - This value will be used for admin endpoints. For example, an - os-admin-hostname set to 'files.admin.example.com' with will create - the following admin endpoint for the ceph-radosgw: - - https://files.admin.example.com:80/swift/v1 + Optionally restrict Ceph key permissions to access pools as required. ceph-osd-replication-count: type: int default: 3 @@ -196,77 +118,160 @@ options: that once a pool has been created, changes to this setting will be ignored. Setting this value to -1, enables the number of placement groups to be calculated based on the Ceph placement group calculator. + # Keystone integration + operator-roles: + type: string + default: "Member,Admin" + description: | + Comma-separated list of Swift operator roles; used when integrating with + OpenStack Keystone. + region: + type: string + default: RegionOne + description: | + OpenStack region that the RADOS gateway supports; used when integrating + with OpenStack Keystone. + cache-size: + type: int + default: 500 + description: Number of keystone tokens to hold in local cache. + revocation-check-interval: + type: int + default: 600 + description: Interval between revocation checks to keystone. + # HA config + use-syslog: + type: boolean + default: False + description: | + If set to True, supporting services will log to syslog. + 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. + vip: + type: string + default: + description: | + 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. + ha-bindiface: + type: string + default: eth0 + description: | + Default network interface on which HA cluster will bind to communication + with the other members of the HA Cluster. + ha-mcastport: + type: int + default: 5414 + description: | + Default multicast port number that will be used to communicate between + HA Cluster nodes. haproxy-server-timeout: 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. - prefer-ipv6: - type: boolean - default: False - description: | - 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. - pool-prefix: + Connect timeout configuration in ms for haproxy, used in HA + configurations. If not provided, default value of 5000ms is used. + # Network config (by default all access is over 'private-address') + os-admin-network: type: string default: description: | - The rados gateway stores objects in many different pools. If you would - like to have multiple rados gateways each pointing to a separate set of - pools set this prefix. The charm will then set up a new set of pools. - If your prefix has a dash in it that will be used to split the prefix - into region and zone. Please read the documentation on federated rados - gateways for more information on region and zone. - nagios_context: - default: "juju" + 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. + 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. + 192.168.0.0/24) + . + This network will be used for public endpoints. + os-public-hostname: + type: string + default: + description: | + The hostname or address of the public endpoints created for ceph-radosgw + in the keystone identity provider. + . + This value will be used for public endpoints. For example, an + os-public-hostname set to 'files.example.com' with will create + the following public endpoint for the ceph-radosgw: + . + https://files.example.com:80/swift/v1 + os-internal-hostname: + type: string + default: + description: | + The hostname or address of the internal endpoints created for + ceph-radosgw in the keystone identity provider. + . + This value will be used for internal endpoints. For example, an + os-internal-hostname set to 'files.internal.example.com' with will create + the following internal endpoint for the ceph-radosgw: + . + https://files.internal.example.com:80/swift/v1 + os-admin-hostname: + type: string + default: + description: | + The hostname or address of the admin endpoints created for ceph-radosgw + in the keystone identity provider. + . + This value will be used for admin endpoints. For example, an + os-admin-hostname set to 'files.admin.example.com' with will create + the following admin endpoint for the ceph-radosgw: + . + https://files.admin.example.com:80/swift/v1 + # Monitoring config + nagios_context: + 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 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 - 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. - restrict-ceph-pools: - default: False - type: boolean - description: | - Optionally restrict Ceph key permissions to access pools as required. - + A comma-separated list of nagios servicegroups. If left empty, + the nagios_context will be used as the servicegroup