helm understackdb docs - reword

Author: skrobul

helm-charts/understackdb/README.md

@@ -26,24 +26,24 @@ Helm chart to deploy MariaDB Database instances for Understack
 | databases[0].instanceName | string | `"mariadb"` | name of the `MariaDB` cluster identifier (`.spec.metadata.name` on MariaDB resource) |
 | databases[0].name | required | `"glance"` | database name |
 | databases[0].namespace | string | openstack | namespace that `Database` record will be created in |
-| databases[0].retryInterval | string | `"5s"` | RetryInterval is the interval used to perform retries. |
+| databases[0].retryInterval | string | `"5s"` | the interval used to perform retries. |
 | grants | list | grants for all Understack components (horizon, ironic, nova, neutron, keystone) | list of databases to create |
 | grants[0].grantOption | bool | `true` | use grant option for this grant |
 | grants[0].name | required | `"glance"` | partial grant name, the `-grant` suffix will be added. |
-| grants[0].namespace | string | openstack | namespace that `Grant` record will be created in |
+| grants[0].namespace | string | `"openstack"` | namespace that `Grant` record will be created in |
 | grants[0].privileges | list | `["ALL"]` | list of privileges that grant allows |
-| grants[0].retryInterval | string | `"5s"` | RetryInterval is the interval used to perform retries. |
+| grants[0].retryInterval | string | `"5s"` | interval used to perform retries. |
 | grants[0].table | string | `"*"` | list of tables that grant is for |
 | image | string | `"mariadb:11.0.3"` |  |
 | imagePullPolicy | string | `"IfNotPresent"` |  |
-| instanceName | string | `"mariadb"` | instanceName is the name of the database instance |
-| instanceNamespace | string | `"openstack"` | instanceNamespace is the namespace where the MariaDB will be created |
-| rootPasswordSecretKeyRef | object | name: mariadb, key: root-password, generate: false | rootPasswordSecretKeyRef is a reference to a Secret containing the root password |
-| rootPasswordSecretKeyRef.generate | bool | false | generate determines whether a password should be generated if it's missing |
-| rootPasswordSecretKeyRef.key | string | root-password | key is the key in the Secret containing the root password |
-| rootPasswordSecretKeyRef.name | string | mariadb | name is the name of the Secret |
-| storage.resizeInUseVolumes | bool | true | resizeInUseVolumes indicates whether the PVCs can be resized. |
-| storage.size | string | 10Gi | size is the size of the Persistent Volume Claim |
+| instanceName | string | `"mariadb"` | name of the database instance |
+| instanceNamespace | string | `"openstack"` | the namespace where the MariaDB will be created |
+| rootPasswordSecretKeyRef | object | `{"generate":false,"key":"root-password","name":"mariadb"}` | reference to a Secret containing the root password |
+| rootPasswordSecretKeyRef.generate | bool | `false` | generate determines whether a password should be generated if it's missing |
+| rootPasswordSecretKeyRef.key | string | `"root-password"` | the key in the Secret containing the root password |
+| rootPasswordSecretKeyRef.name | string | `"mariadb"` | the name of the Secret |
+| storage.resizeInUseVolumes | bool | `true` | resizeInUseVolumes indicates whether the PVCs can be resized. |
+| storage.size | string | `"10Gi"` | the size of the Persistent Volume Claim |
 | storage.storageClassName | string | `nil` | StorageClassName to be used to provision the PVCS. It supersedes the 'StorageClassName' specified in 'VolumeClaimTemplate'. |
 | storage.waitForVolumeResize | bool | `true` |  |
 | users | list | users for all Understack components (horizon, ironic, nova, neutron, keystone) | list of database users |

helm-charts/understackdb/values.yaml

@@ -1,27 +1,21 @@
 # Default values for understackdb.
-# -- instanceName is the name of the database instance
+# -- name of the database instance
 instanceName: mariadb
-# -- instanceNamespace is the namespace where the MariaDB will be created
+# -- the namespace where the MariaDB will be created
 instanceNamespace: openstack
-# -- rootPasswordSecretKeyRef is a reference to a Secret containing the root password
-# @default -- name: mariadb, key: root-password, generate: false
+# -- reference to a Secret containing the root password
 rootPasswordSecretKeyRef:
-  # -- name is the name of the Secret
-  # @default -- mariadb
+  # -- the name of the Secret
   name: mariadb
-  # -- key is the key in the Secret containing the root password
-  # @default -- root-password
+  # -- the key in the Secret containing the root password
   key: root-password
   # -- generate determines whether a password should be generated if it's missing
-  # @default -- false
   generate: false
 
 storage:
-  # -- size is the size of the Persistent Volume Claim
-  # @default -- 10Gi
+  # -- the size of the Persistent Volume Claim
   size: 10Gi
   # -- resizeInUseVolumes indicates whether the PVCs can be resized.
-  # @default -- true
   resizeInUseVolumes: true
   waitForVolumeResize: true
   # -- StorageClassName to be used to provision the PVCS. It supersedes the
@@ -46,7 +40,7 @@ image: mariadb:11.0.3
 imagePullPolicy: IfNotPresent
 
 #
-# -- myCnf is the configuration of my.cnf
+# -- stringified contents of my.cnf
 # @ignored
 myCnf: |
   [mariadb]
@@ -56,18 +50,15 @@ myCnf: |
   innodb_autoinc_lock_mode=2
   max_allowed_packet=256M
 
-# -- metrics is the configuration for the prometheus exporter
+# -- the configuration for the prometheus exporter
 # @ignored
 metrics:
   # -- enabled determines whether the metrics exporter is enabled
-  # @default -- true
   enabled: true
   exporter:
-    # -- image is the Docker image for the metrics exporter
-    # @default -- prom/mysqld-exporter:v0.15.1
+    # -- container image for the metrics exporter
     image: prom/mysqld-exporter:v0.15.1
-    # -- port is the port for the metrics exporter
-    # @default -- 9104
+    # -- port for the metrics exporter
     port: 9104
   passwordSecretKeyRef:
     key: password
@@ -111,7 +102,7 @@ databases:
     characterSet: utf8
     # -- database's collation
     collate: utf8_general_ci
-    # -- RetryInterval is the interval used to perform retries.
+    # -- the interval used to perform retries.
     retryInterval: 5s
     extraConfig: {}            # use to specify any additional params
   - name: horizon
@@ -137,15 +128,14 @@ grants:
   # grants[0].name -- (required) partial grant name, the `-grant` suffix will be added.
   - name: glance
     # -- namespace that `Grant` record will be created in
-    # @default -- openstack
     namespace: openstack
     # -- list of tables that grant is for
     table: "*"
     # -- list of privileges that grant allows
     privileges: [ALL]
     # -- use grant option for this grant
     grantOption: true
-    # -- RetryInterval is the interval used to perform retries.
+    # -- interval used to perform retries.
     retryInterval: 5s
   - name: horizon
   - name: ironic