docs(helm): annotate global values

Author: roderik

charts/network/README.md

@@ -21,8 +21,10 @@ A Helm chart for a blockchain network on Kubernetes
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| global.networkNodes.faucetArtifactPrefix | string | `"besu-faucet"` |  |
-| global.networkNodes.genesisConfigMapName | string | `"besu-genesis"` |  |
-| global.networkNodes.podPrefix | string | `"besu-node-validator"` |  |
-| global.networkNodes.serviceName | string | `"besu-node"` |  |
-| global.networkNodes.staticNodesConfigMapName | string | `"besu-static-nodes"` |  |
+| global | object | `{"networkNodes":{"faucetArtifactPrefix":"besu-faucet","genesisConfigMapName":"besu-genesis","podPrefix":"besu-node-validator","serviceName":"besu-node","staticNodesConfigMapName":"besu-static-nodes"}}` | Global configuration shared across subcharts. |
+| global.networkNodes | object | `{"faucetArtifactPrefix":"besu-faucet","genesisConfigMapName":"besu-genesis","podPrefix":"besu-node-validator","serviceName":"besu-node","staticNodesConfigMapName":"besu-static-nodes"}` | Defaults consumed by Besu network node workloads. |
+| global.networkNodes.faucetArtifactPrefix | string | `"besu-faucet"` | Prefix used for faucet ConfigMaps and Secrets. |
+| global.networkNodes.genesisConfigMapName | string | `"besu-genesis"` | ConfigMap name storing the generated genesis.json artifact. |
+| global.networkNodes.podPrefix | string | `"besu-node-validator"` | StatefulSet prefix used for validator pod hostnames. |
+| global.networkNodes.serviceName | string | `"besu-node"` | Kubernetes Service name fronting validator pods to align bootstrapper static-nodes output. |
+| global.networkNodes.staticNodesConfigMapName | string | `"besu-static-nodes"` | ConfigMap name storing static-nodes.json entries. |

charts/network/values.yaml

@@ -1,14 +1,16 @@
 # This parent chart does not define additional values; override subchart defaults here when packaging composite releases.
 
+# -- (object) Global configuration shared across subcharts.
 global:
+  # -- (object) Defaults consumed by Besu network node workloads.
   networkNodes:
-    # Default Kubernetes Service name fronting validator pods; customise to keep bootstrapper outputs in sync with node manifests.
+    # -- (string) Kubernetes Service name fronting validator pods to align bootstrapper static-nodes output.
     serviceName: besu-node
-    # Default StatefulSet prefix used for validator pod hostnames.
+    # -- (string) StatefulSet prefix used for validator pod hostnames.
     podPrefix: besu-node-validator
-    # Default ConfigMap name storing the generated genesis.json artifact.
+    # -- (string) ConfigMap name storing the generated genesis.json artifact.
     genesisConfigMapName: besu-genesis
-    # Default ConfigMap name storing static-nodes.json entries.
+    # -- (string) ConfigMap name storing static-nodes.json entries.
     staticNodesConfigMapName: besu-static-nodes
-    # Default prefix used for faucet ConfigMaps and Secrets.
+    # -- (string) Prefix used for faucet ConfigMaps and Secrets.
     faucetArtifactPrefix: besu-faucet