MON-3543: Update API docs for Metrics Server

Signed-off-by: Jayapriya Pai <janantha@redhat.com>
openshift · Dec 5, 2023 · e6f245d · e6f245d
1 parent 099ff33
commit e6f245d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/Documentation/api.md b/Documentation/api.md
@@ -200,7 +200,7 @@ The `KubeStateMetricsConfig` resource defines settings for the `kube-state-metri
 
 #### Description
 
-The `MetricsServerConfig` resource defines settings for the MetricsServer component.
+The `MetricsServerConfig` resource defines settings for the MetricsServer component. This resource is only considered valid in a TechPreview cluster with TechPreviewNoUpgrade FeatureSet enabled; otherwise, it is ignored.
 
 
 <em>appears in: [ClusterMonitoringConfiguration](#clustermonitoringconfiguration)</em>

diff --git a/Documentation/openshiftdocs/modules/metricsserverconfig.adoc b/Documentation/openshiftdocs/modules/metricsserverconfig.adoc
@@ -9,7 +9,7 @@
 
 === Description
 
-The `MetricsServerConfig` resource defines settings for the MetricsServer component.
+The `MetricsServerConfig` resource defines settings for the MetricsServer component. This resource is only considered valid in a TechPreview cluster with TechPreviewNoUpgrade FeatureSet enabled; otherwise, it is ignored.
 
 
 

diff --git a/pkg/manifests/types.go b/pkg/manifests/types.go
@@ -122,6 +122,8 @@ type K8sPrometheusAdapter struct {
 }
 
 // The `MetricsServerConfig` resource defines settings for the MetricsServer component.
+// This resource is only considered valid in a TechPreview cluster
+// with TechPreviewNoUpgrade FeatureSet enabled; otherwise, it is ignored.
 type MetricsServerConfig struct {
 	// Defines the nodes on which the pods are scheduled.
 	NodeSelector map[string]string `json:"nodeSelector,omitempty"`