Align monitoring values and description as per our documentation

hivemq · Dec 5, 2024 · 693620e · 693620e
1 parent 07404ec
commit 693620e
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 43 deletions.
diff --git a/charts/hivemq-platform-operator/values.schema.json b/charts/hivemq-platform-operator/values.schema.json
@@ -150,21 +150,21 @@
       "type" : "string"
     },
     "monitoring" : {
-      "description" : "Monitoring configuration options.",
+      "description" : "Enables the ServiceMonitor resource and Grafana dashboard creation for the operator.",
       "properties" : {
         "enabled" : {
-          "description" : "When enabled, deploys a ServiceMonitor resource for the Operator along with a Configmap for a Grafana dashboard.",
+          "description" : "Defines whether the monitoring configuration for the HiveMQ Platform Operator is enabled. The default setting is `false`.",
           "type": "boolean"
         },
         "dashboard" : {
           "description" : "Dashboard configuration options.",
           "properties" : {
             "create" : {
-              "description" : "Creates a default HiveMQ Platform Operator Grafana dashboard ConfigMap.",
+              "description" : "Boolean value that configures whether to use the default HiveMQ Platform Operator Grafana dashboard ConfigMap. The default setting is `true`.",
               "type": "boolean"
             },
             "namespace" : {
-              "description" : "Namespace where the Grafana dashboard ConfigMap will be deployed to. Defaults to use the same namespace where the HiveMQ Platform chart is deployed to.",
+              "description" : "Namespace where to deploy the Grafana dashboard ConfigMap. Defaults to the namespace of the HiveMQ Platform Operator.",
               "maxLength": 63,
               "type": "string"
             },
@@ -176,24 +176,24 @@
           "type": "object"
         },
         "serviceMonitor" : {
-          "description" : "ServiceMonitor configuration options.",
+          "description" : "Prometheus ServiceMonitor configuration options.",
           "properties" : {
             "interval" : {
-              "description" : "Defines how often Prometheus should scrape metrics from the endpoints defined in the ServiceMonitor resource.",
+              "description" : "Defines how often Prometheus scrapes metrics from the operator endpoints. Example of a valid format are `1d`, `1h30m`, `5m`, `10s`. Defaults to 15 seconds.",
               "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
               "type": "string"
             },
             "namespace" : {
-              "description" : "Namespace where the ServiceMonitor will be deployed to. Defaults to use the same namespace where the HiveMQ Platform Operator chart is deployed to.",
+              "description" : "Namespace where to deploy the ServiceMonitor. Defaults to the namespace of the HiveMQ Platform Operator.",
               "maxLength": 63,
               "type": "string"
             },
             "releaseName" : {
-              "description" : "Release name of the Prometheus Monitoring stack available in the Kubernetes cluster. Defaults to the HiveMQ Platform Operator release name.",
+              "description" : "Helm chart release name of the Prometheus Monitoring stack installed. Defaults to the HiveMQ Platform Operator Helm chart release name.",
               "type": "string"
             },
             "scrapeTimeout" : {
-              "description" : "Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource.",
+              "description" : "Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource. Example of a valid format are `1d`, `1h30m`, `5m`, `10s`. Defaults to 10 seconds.",
               "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
               "type": "string"
             }

diff --git a/charts/hivemq-platform-operator/values.yaml b/charts/hivemq-platform-operator/values.yaml
@@ -165,27 +165,27 @@ crd:
   # Format is based on the ISO-8601 Duration format.
   waitTimeout: PT10S
 
-# Monitoring configuration options
+# Enables the ServiceMonitor resource and Grafana dashboard creation for the operator.
 monitoring:
-  # When enabled, deploys a ServiceMonitor resource for the Operator along with a Configmap for a Grafana dashboard.
+  # Defines whether the monitoring configuration for the HiveMQ Platform Operator is enabled. The default setting is `false`.
   enabled: false
   # Dashboard configuration options.
   dashboard:
-    # Creates a default HiveMQ Platform Operator Grafana dashboard ConfigMap.
+    # Boolean value that configures whether to use the default HiveMQ Platform Operator Grafana dashboard ConfigMap. The default setting is `true`.
     create: true
     # Namespace where to deploy the Grafana dashboard ConfigMap. Defaults to the namespace of the HiveMQ Platform Operator.
     # namespace: monitoring
-    # Overrides the default HiveMQ Platform Grafana Operator dashboard content via file using --set-file grafana-dashboard.json.
+    # Sets the Grafana dashboard content for the HiveMQ Platform Operator Grafana dashboard ConfigMap with your own JSON file from a specified path.
     overrideDashboard: ""
+  # Prometheus ServiceMonitor configuration options.
   serviceMonitor:
     # Namespace where to deploy the ServiceMonitor. Defaults to the namespace of the HiveMQ Platform Operator.
     # namespace: monitoring
-    # Helm chart release name of the Prometheus Monitoring stack available in the Kubernetes cluster.
-    # The release name allows the Prometheus operator to discover the HiveMQ Platform Operator ServiceMonitor. Defaults to the HiveMQ Platform Operator Helm chart release name.
+    # Helm chart release name of the Prometheus Monitoring stack installed. Defaults to the HiveMQ Platform Operator Helm chart release name.
     # releaseName: monitoring-stack
-    # Defines how often Prometheus should scrape metrics from the endpoints defined in the ServiceMonitor resource.
-    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`.
+    # Defines how often Prometheus scrapes metrics from the operator endpoints.
+    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`. Defaults to 15 seconds.
     interval: 15s
     # Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource.
-    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`.
+    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`. Defaults to 10 seconds.
     scrapeTimeout: 10s
diff --git a/charts/hivemq-platform/values.schema.json b/charts/hivemq-platform/values.schema.json
@@ -497,50 +497,50 @@
       "type" : "object"
     },
     "monitoring" : {
-      "description" : "Monitoring configuration options.",
+      "description" : "Enables the ServiceMonitor resource and Grafana dashboard creation for the platform.",
       "properties" : {
         "enabled" : {
-          "description" : "When enabled, deploys a ServiceMonitor resource for the HiveMQ Platform along with a Configmap for a Grafana dashboard.",
+          "description" : "Defines whether the monitoring configuration for the HiveMQ Platform is enabled. The default setting is `false`.",
           "type": "boolean"
         },
         "dashboard" : {
-          "description" : "Dashboard configuration options.",
+          "description" : "Grafana dashboard configuration options.",
           "properties" : {
             "create" : {
-              "description" : "Creates a default HiveMQ Platform Grafana dashboard ConfigMap.",
+              "description" : "Boolean value that configures whether to use the default HiveMQ Platform Grafana dashboard ConfigMap. The default setting is `true`.",
               "type": "boolean"
             },
             "namespace" : {
-              "description" : "Namespace where the Grafana dashboard ConfigMap will be deployed to. Defaults to use the same namespace where the HiveMQ Platform chart is deployed to.",
+              "description" : "Namespace where to deploy the Grafana dashboard ConfigMap. Defaults to the namespace of the HiveMQ Platform.",
               "maxLength": 63,
               "type": "string"
             },
             "overrideDashboard" : {
-              "description" : "Overrides the default HiveMQ Platform Grafana dashboard content via file using --set-file grafana-dashboard.json.",
+              "description" : "Sets the Grafana dashboard content for the HiveMQ Platform Grafana dashboard ConfigMap with your own JSON file from a specified path.",
               "type": "string"
             }
           },
           "type": "object"
         },
         "serviceMonitor" : {
-          "description" : "ServiceMonitor configuration options.",
+          "description" : "Prometheus ServiceMonitor configuration options.",
           "properties" : {
             "interval" : {
-              "description" : "Defines how often Prometheus should scrape metrics from the endpoints defined in the ServiceMonitor resource.",
+              "description" : "Defines how often Prometheus scrapes metrics from the operator endpoints. Valid formats include `1d`, `1h30m`, `5m`, and `10s`. Defaults to 15 seconds.",
               "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
               "type": "string"
             },
             "namespace" : {
-              "description" : "Namespace where the ServiceMonitor will be deployed to. Defaults to use the same namespace where the HiveMQ Platform chart is deployed to.",
+              "description" : "Namespace where to deploy the ServiceMonitor. Defaults to the namespace of the HiveMQ Platform.",
               "maxLength": 63,
               "type": "string"
             },
             "releaseName" : {
-              "description" : "Release name of the Prometheus Monitoring stack available in the Kubernetes cluster. Defaults to the HiveMQ Platform release name.",
+              "description" : "Helm chart release name of the Prometheus Monitoring stack available in the Kubernetes cluster. Defaults to the HiveMQ Platform Helm chart release name.",
               "type": "string"
             },
             "scrapeTimeout" : {
-              "description" : "Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource.",
+              "description" : "Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource. Valid formats include `1d`, `1h30m`, `5m`, and `10s`. Defaults to 10 seconds.",
               "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$",
               "type": "string"
             }

diff --git a/charts/hivemq-platform/values.yaml b/charts/hivemq-platform/values.yaml
@@ -267,9 +267,8 @@ services:
     #  # Session affinity type. Must be `ClientIP` or `None`.
     #  # Defaults to `ClientIP` for the `control-center` service type.
     #  type: None
-    # Configures whether this Service routes external traffic to node-local or cluster-wide endpoints.
-    # Affects the network traffic routing behavior, client source IP preservation, and load balancing across Kubernetes nodes.
-    # Only applicable to LoadBalancer or NodePort service types. Possible values are `Cluster` or `Local`.
+    # Configures whether the service routes incoming external traffic to node-local or cluster-wide endpoints.
+    # This setting applies only to `NodePort` and `LoadBalancer` service types. Possible values are: `Cluster` or `Local`.
     # See: https://kubernetes.io/docs/reference/networking/virtual-ips/#external-traffic-policy
     # externalTrafficPolicy: Cluster
 
@@ -637,28 +636,27 @@ volumeClaimTemplates: []
 #         storage: 100Gi
 #     volumeMode: Filesystem
 
-# Monitoring configuration options
+# Enables the ServiceMonitor resource and Grafana dashboard creation for the platform.
 monitoring:
-  # When enabled, deploys a ServiceMonitor resource for the HiveMQ Platform along with a Configmap for a Grafana dashboard.
+  # Defines whether the monitoring configuration for the HiveMQ Platform is enabled. The default setting is `false`.
   enabled: false
-  # Dashboard configuration options.
+  # Grafana dashboard configuration options.
   dashboard:
-    # Creates a default HiveMQ Platform Grafana dashboard ConfigMap.
+    # Boolean value that configures whether to use the default HiveMQ Platform Grafana dashboard ConfigMap. The default setting is `true`.
     create: true
     # Namespace where to deploy the Grafana dashboard ConfigMap. Defaults to the namespace of the HiveMQ Platform.
     # namespace: monitoring
-    # Overrides the default HiveMQ Platform Grafana dashboard content via file using --set-file grafana-dashboard.json.
+    # Sets the Grafana dashboard content for the HiveMQ Platform Grafana dashboard ConfigMap with your own JSON file from a specified path.
     overrideDashboard: ""
-  # ServiceMonitor configuration options.
+  # Prometheus ServiceMonitor configuration options.
   serviceMonitor:
     # Namespace where to deploy the ServiceMonitor. Defaults to the namespace of the HiveMQ Platform.
     # namespace: monitoring
-    # Helm chart release name of the Prometheus Monitoring stack available in the Kubernetes cluster.
-    # The release name allows the Prometheus operator to discover the HiveMQ Platform ServiceMonitor. Defaults to the HiveMQ Platform Helm chart release name.
+    # Helm chart release name of the Prometheus Monitoring stack available in the Kubernetes cluster. Defaults to the HiveMQ Platform Helm chart release name.
     # releaseName: monitoring-stack
-    # Defines how often Prometheus should scrape metrics from the endpoints defined in the ServiceMonitor resource.
-    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`.
+    # Defines how often Prometheus scrapes metrics from the operator endpoints.
+    # Valid formats include `1d`, `1h30m`, `5m`, and `10s`. Defaults to 15 seconds.
     interval: 15s
     # Defines the maximum duration allowed for scraping metrics from the endpoints defined in the ServiceMonitor resource.
-    # Example of a valid format are `1d`, `1h30m`, `5m`, `10s`.
+    # Valid formats include `1d`, `1h30m`, `5m`, and `10s`. Defaults to 10 seconds.
     scrapeTimeout: 10s