[trivial] more config cleanup

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,97 +13,77 @@ 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:
-      distro (default), ppa:somecustom/ppa, a deb url sources entry,
+      distro (default), ppa:somecustom/ppa, a deb url sources entry or a
-      or a supported Cloud Archive release pocket.
+      supported Ubuntu Cloud Archive (UCA) release pocket.
-
+      .
-      Supported Cloud Archive sources include:
+      Supported UCA 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:
+      For series=Precise we support UCA for openstack-release=
          * icehouse
-
+      .
-      For series=Trusty we support cloud archives for openstack-release:
+      For series=Trusty we support UCA 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
+    default:
     description: |
-      Specifies a YAML-formatted dictionary listing the git
+      Specifies a YAML-formatted dictionary listing the git repositories and
-      repositories and branches from which to install OpenStack and
+      branches from which to install OpenStack and its dependencies.
-      its dependencies.
+      .
-
       Note that the installed config files will be determined based on
       the OpenStack release of the openstack-origin option.
-
+      .
       For more details see README.md.
   nova-config:
+    type: string
     default: /etc/nova/nova.conf
-    type: string
+    description: Full path to Nova configuration file.
-    description: Full path to nova.conf
   rabbit-user:
-    default: nova
     type: string
-    description: Username used to access rabbitmq queue
+    default: nova
+    description: Username used to access rabbitmq queue.
   rabbit-vhost:
+    type: string
     default: openstack
-    type: string
+    description: Rabbitmq vhost.
-    description: Rabbitmq vhost
-  database-user:
-    default: nova
-    type: string
-    description: Username for database access
-  database:
-    default: nova
-    type: string
-    description: Database name
-  neutron-database-user:
-    default: neutron
-    type: string
-    description: Username for Neutron database access (if enabled)
-  neutron-database:
-    default: neutron
-    type: string
-    description: Database name for Neutron (if enabled)
   virt-type:
+    type: string
     default: kvm
-    type: string
     description: |
-      Virtualization flavor. Supported types are: kvm, xen, uml, lxc, qemu, lxd
+      Virtualization flavor. Supported flavors are: kvm, xen, uml, lxc, qemu,
-  multi-host:
+      lxd.
-    default: "yes"
-    type: string
-    description: Whether to run nova-api and nova-network on the compute nodes.
   disk-cachemodes:
-    default:
     type: string
+    default:
     description: |
       Specific cachemodes to use for different disk types e.g:
       file=directsync,block=none
   enable-resize:
-    default: False
     type: boolean
+    default: False
     description: Enable instance resizing, which requires that passwordless SSH
       access be setup between compute hosts.
   enable-live-migration:
-    default: False
     type: boolean
+    default: False
     description: Configure libvirt for live migration.
   migration-auth-type:
     type: string
@@ -112,63 +92,95 @@ options:
       TCP authentication scheme for libvirt live migration.  Available options
       include ssh.
   authorized-keys-path:
-    default: '{homedir}/.ssh/authorized_keys'
     type: string
+    default: '{homedir}/.ssh/authorized_keys'
     description: |
       Only used when migration-auth-type is set to ssh.
-
+      .
       Full path to authorized_keys file, can be useful for systems with
       non-default AuthorizedKeysFile location. It will be formatted using the
       following variables:
-
+      .
         homedir - user's home directory
         username - username
-
+      .
-  # needed if using flatmanager
-  bridge-interface:
-    default: br100
-    type: string
-    description: Bridge interface to be configured
-  bridge-ip:
-    default: 11.0.0.1
-    type: string
-    description: IP to be assigned to bridge interface
-  bridge-netmask:
-    default: 255.255.255.0
-    type: string
-    description: Netmask to be assigned to bridge interface
-  # needed if using flatdhcpmanager
-  flat-interface:
-    default: eth1
-    type: string
-    description: Network interface on which to build bridge
   instances-path:
     type: string
     default:
     description: |
-      Instance path to use - empty means default of /var/lib/nova/instances
+      Path used for storing Nova instances data - empty means default of
+      /var/lib/nova/instances.
   config-flags:
     type: string
     default:
     description: |
       Comma-separated list of key=value config flags. These values will be
       placed in the nova.conf [DEFAULT] section.
-  nagios_context:
+  database-user:
-    default: "juju"
     type: string
+    default: nova
+    description: Username for database access.
+  database:
+    type: string
+    default: nova
+    description: Nova database name.
+  neutron-database-user:
+    type: string
+    default: neutron
+    description: Username for Neutron database access (if enabled).
+  neutron-database:
+    type: string
+    default: neutron
+    description: Database name for Neutron (if enabled).
+  multi-host:
+    type: string
+    default: 'yes'
+    description: Whether to run nova-api and nova-network on the compute nodes.
+  # Required if using FlatManager (nova-network)
+  bridge-interface:
+    type: string
+    default: br100
+    description: Bridge interface to be configured
+  bridge-ip:
+    type: string
+    default: 11.0.0.1
+    description: IP to be assigned to bridge interface
+  bridge-netmask:
+    type: string
+    default: 255.255.255.0
+    description: Netmask to be assigned to bridge interface
+  # Required if using FlatDHCPManager (nova-network)
+  flat-interface:
+    type: string
+    default: eth1
+    description: Network interface on which to build bridge
+  # Nagios configuration options
+  nagios_context:
+    type: string
+    default: 'juju'
     description: |
-      Used by the nrpe-external-master subordinate charm.
+      Used by the nrpe-external-master subordinate charm. A string that will be
-      A string that will be prepended to instance name to set the host name
+      prepended to instance name to set the host name in nagios. So for
-      in nagios. So for instance the hostname would be something like:
+      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
+    default:
     description: |
-      A comma-separated list of nagios servicegroups.
+      A comma-separated list of nagios servicegroups. If left empty, the
-      If left empty, the nagios_context will be used as the servicegroup
+      nagios_context will be used as the servicegroup.
+  # Network configuration options
+  # NOTE: by default all access is over 'private-address'
+  network-device-mtu:
+    type: int
+    default:
+    description: |
+      The MTU size for the interfaces managed by neutron. If unset or set to
+      0, no mtu will be applied.
   disable-neutron-security-groups:
     type: boolean
     default: False
@@ -177,9 +189,7 @@ options:
       will override any settings configured via the nova-cloud-controller charm.
       .
       BE CAREFUL - this option allows you to disable all port level security
-      within and OpenStack cloud.
+      within an OpenStack cloud.
-  # Network configuration options
-  # by default all access is over 'private-address'
   os-data-network:
     type: string
     default:
@@ -201,29 +211,23 @@ 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.
-  network-device-mtu:
-    type: int
-    default:
-    description: |
-      The MTU size for the interfaces managed by neutron. If unset or set to
-      0, no value will be applied.
   # Storage configuration options
   libvirt-image-backend:
-    default:
     type: string
+    default:
     description: |
       Tell Nova which libvirt image backend to use. Supported backends are rbd,
       lvm and qcow2. If no backend is specified, the Nova default (qcow2) is
       used. Note that rbd imagebackend is only supported with >= Juno.
   rbd-pool:
-    default: "nova"
     type: string
+    default: 'nova'
     description: |
-      RBD pool to use with Nova RBD image backend. Required when
+      RBD pool to use with Nova libvirt RBDImageBackend. Only required when you
-      libvirt_image_backend is rbd.
+      have libvirt-image-backend set to 'rbd'.
   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 withing the nova rbd pool. Of course, this only