Add console-plugin config docs

openshift · Feb 21, 2023 · 1be089f · 1be089f
1 parent f0608ae
commit 1be089f
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 0 deletions.
diff --git a/Documentation/api.md b/Documentation/api.md
@@ -22,6 +22,7 @@ Configuring Cluster Monitoring is optional. If the config does not exist or is e
 * [AlertmanagerMainConfig](#alertmanagermainconfig)
 * [AlertmanagerUserWorkloadConfig](#alertmanageruserworkloadconfig)
 * [ClusterMonitoringConfiguration](#clustermonitoringconfiguration)
+* [ConsolePluginConfig](#consolepluginconfig)
 * [DedicatedServiceMonitors](#dedicatedservicemonitors)
 * [K8sPrometheusAdapter](#k8sprometheusadapter)
 * [KubeStateMetricsConfig](#kubestatemetricsconfig)
@@ -124,6 +125,25 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
 | telemeterClient | *[TelemeterClientConfig](#telemeterclientconfig) | `TelemeterClientConfig` defines settings for the Telemeter Client component. |
 | thanosQuerier | *[ThanosQuerierConfig](#thanosquerierconfig) | `ThanosQuerierConfig` defines settings for the Thanos Querier component. |
 | nodeExporter | [NodeExporterConfig](#nodeexporterconfig) | `NodeExporterConfig` defines settings for the `node-exporter` agent. |
+| consolePlugin | *[ConsolePluginConfig](#consolepluginconfig) | `ConsolePluginConfig` defines settings for the monitoring `console-plugin`. |
+
+[Back to TOC](#table-of-contents)
+
+## ConsolePluginConfig
+
+#### Description
+
+The `ConsolePluginConfig` resource defines settings for the Console Plugin component in the `openshift-monitoring` namespace.
+
+
+<em>appears in: [ClusterMonitoringConfiguration](#clustermonitoringconfiguration)</em>
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| nodeSelector | map[string]string | Defines the nodes on which the Pods are scheduled. |
+| resources | *[v1.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) | Defines resource requests and limits for the console-plugin container. |
+| tolerations | [][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) | Defines tolerations for the pods. |
+| topologySpreadConstraints | []v1.TopologySpreadConstraint | Defines a pod's topology spread constraints. |
 
 [Back to TOC](#table-of-contents)
 

diff --git a/Documentation/openshiftdocs/index.adoc b/Documentation/openshiftdocs/index.adoc
@@ -42,6 +42,7 @@ The configuration file itself is always defined under the `config.yaml` key in t
 * link:modules/alertmanagermainconfig.adoc[AlertmanagerMainConfig]
 * link:modules/alertmanageruserworkloadconfig.adoc[AlertmanagerUserWorkloadConfig]
 * link:modules/clustermonitoringconfiguration.adoc[ClusterMonitoringConfiguration]
+* link:modules/consolepluginconfig.adoc[ConsolePluginConfig]
 * link:modules/dedicatedservicemonitors.adoc[DedicatedServiceMonitors]
 * link:modules/k8sprometheusadapter.adoc[K8sPrometheusAdapter]
 * link:modules/kubestatemetricsconfig.adoc[KubeStateMetricsConfig]

diff --git a/Documentation/openshiftdocs/modules/clustermonitoringconfiguration.adoc b/Documentation/openshiftdocs/modules/clustermonitoringconfiguration.adoc
@@ -35,6 +35,8 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
 
 |nodeExporter|link:nodeexporterconfig.adoc[NodeExporterConfig]|`NodeExporterConfig` defines settings for the `node-exporter` agent.
 
+|consolePlugin|*link:consolepluginconfig.adoc[ConsolePluginConfig]|`ConsolePluginConfig` defines settings for the monitoring `console-plugin`.
+
 |===
 
 link:../index.adoc[Back to TOC]
diff --git a/Documentation/openshiftdocs/modules/consolepluginconfig.adoc b/Documentation/openshiftdocs/modules/consolepluginconfig.adoc
@@ -0,0 +1,31 @@
+// DO NOT EDIT THE CONTENT IN THIS FILE. It is automatically generated from the 
+	// source code for the Cluster Monitoring Operator. Any changes made to this 
+	// file will be overwritten when the content is re-generated. If you wish to 
+	// make edits, read the docgen utility instructions in the source code for the 
+	// CMO.
+	:_content-type: ASSEMBLY
+
+== ConsolePluginConfig
+
+=== Description
+
+The `ConsolePluginConfig` resource defines settings for the Console Plugin component in the `openshift-monitoring` namespace.
+
+
+
+Appears in: link:clustermonitoringconfiguration.adoc[ClusterMonitoringConfiguration]
+
+[options="header"]
+|===
+| Property | Type | Description 
+|nodeSelector|map[string]string|Defines the nodes on which the Pods are scheduled.
+
+|resources|*v1.ResourceRequirements|Defines resource requests and limits for the console-plugin container.
+
+|tolerations|[]v1.Toleration|Defines tolerations for the pods.
+
+|topologySpreadConstraints|[]v1.TopologySpreadConstraint|Defines a pod's topology spread constraints.
+
+|===
+
+link:../index.adoc[Back to TOC]