Merge pull request #65703 from mburke5678/cma-2112

OSDOCS_8148: Support CMA on OSD/ROSA

Author: mburke5678

_topic_maps/_topic_map_osd.yml

@@ -607,6 +607,37 @@ Topics:
     - Name: Custom domains for applications
       File: osd-config-custom-domains-applications
 ---
+Name: Nodes
+Dir: nodes
+Distros: openshift-dedicated
+Topics:
+- Name: Automatically scaling pods with the Custom Metrics Autoscaler Operator
+  Dir: cma
+  Distros: openshift-dedicated
+  Topics:
+  - Name: Custom Metrics Autoscaler Operator overview
+    File: nodes-cma-autoscaling-custom
+  - Name: Custom Metrics Autoscaler Operator release notes
+    File: nodes-cma-autoscaling-custom-rn
+  - Name: Installing the custom metrics autoscaler
+    File: nodes-cma-autoscaling-custom-install
+  - Name: Understanding the custom metrics autoscaler triggers
+    File: nodes-cma-autoscaling-custom-trigger
+  - Name: Understanding the custom metrics autoscaler trigger authentications
+    File: nodes-cma-autoscaling-custom-trigger-auth
+  - Name: Pausing the custom metrics autoscaler
+    File: nodes-cma-autoscaling-custom-pausing
+  - Name: Gathering audit logs
+    File: nodes-cma-autoscaling-custom-audit-log
+  - Name: Gathering debugging data
+    File: nodes-cma-autoscaling-custom-debugging
+  - Name: Viewing Operator metrics
+    File: nodes-cma-autoscaling-custom-metrics
+  - Name: Understanding how to add custom metrics autoscalers
+    File: nodes-cma-autoscaling-custom-adding
+  - Name: Removing the Custom Metrics Autoscaler Operator
+    File: nodes-cma-autoscaling-custom-removing
+---
 Name: Logging
 Dir: logging
 Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

@@ -775,6 +775,37 @@ Topics:
 - Name: Installing OADP on ROSA with STS
   File: backing-up-applications
 ---
+Name: Nodes
+Dir: nodes
+Distros: openshift-rosa
+Topics:
+- Name: Automatically scaling pods with the Custom Metrics Autoscaler Operator
+  Dir: cma
+  Distros: openshift-rosa
+  Topics:
+  - Name: Custom Metrics Autoscaler Operator overview
+    File: nodes-cma-autoscaling-custom
+  - Name: Custom Metrics Autoscaler Operator release notes
+    File: nodes-cma-autoscaling-custom-rn
+  - Name: Installing the custom metrics autoscaler
+    File: nodes-cma-autoscaling-custom-install
+  - Name: Understanding the custom metrics autoscaler triggers
+    File: nodes-cma-autoscaling-custom-trigger
+  - Name: Understanding the custom metrics autoscaler trigger authentications
+    File: nodes-cma-autoscaling-custom-trigger-auth
+  - Name: Pausing the custom metrics autoscaler
+    File: nodes-cma-autoscaling-custom-pausing
+  - Name: Gathering audit logs
+    File: nodes-cma-autoscaling-custom-audit-log
+  - Name: Gathering debugging data
+    File: nodes-cma-autoscaling-custom-debugging
+  - Name: Viewing Operator metrics
+    File: nodes-cma-autoscaling-custom-metrics
+  - Name: Understanding how to add custom metrics autoscalers
+    File: nodes-cma-autoscaling-custom-adding
+  - Name: Removing the Custom Metrics Autoscaler Operator
+    File: nodes-cma-autoscaling-custom-removing
+---
 Name: Logging
 Dir: logging
 Distros: openshift-rosa

modules/nodes-cma-autoscaling-custom-audit.adoc

@@ -18,6 +18,7 @@ You can configure auditing for the Custom Metrics Autoscaler Operator by editing
 
 . Edit the `KedaController` custom resource to add the `auditConfig` stanza:
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [source,yaml]
 ----
 kind: KedaController
@@ -42,6 +43,33 @@ spec:
         maxBackup: "1"
         maxSize: "50"
 ----
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[source,yaml]
+----
+kind: KedaController
+apiVersion: keda.sh/v1alpha1
+metadata:
+  name: keda
+  namespace: keda
+spec:
+# ...
+  metricsServer:
+# ...
+    auditConfig:
+      logFormat: "json" <1>
+      logOutputVolumeClaim: "pvc-audit-log" <2>
+      policy:
+        rules: <3>
+        - level: Metadata
+        omitStages: "RequestReceived" <4>
+        omitManagedFields: false <5>
+      lifetime: <6>
+        maxAge: "2"
+        maxBackup: "1"
+        maxSize: "50"
+----
+endif::openshift-rosa,openshift-dedicated[]
 <1> Specifies the output format of the audit log, either `legacy` or `json`.
 <2> Specifies an existing persistent volume claim for storing the log data. All requests coming to the API server are logged to this persistent volume claim. If you leave this field empty, the log data is sent to stdout.
 <3> Specifies which events should be recorded and what data they should include:
@@ -74,10 +102,18 @@ oc adm must-gather -- /usr/bin/gather_audit_logs
 
 .. Obtain the name of the `keda-metrics-apiserver-*` pod:
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [source,terminal]
 ----
 oc get pod -n openshift-keda
 ----
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[source,terminal]
+----
+oc get pod -n keda
+----
+endif::openshift-rosa,openshift-dedicated[]
 +
 .Example output
 +
@@ -117,6 +153,7 @@ $ oc logs keda-metrics-apiserver-65c7cc44fd-rrl4r|grep -i metadata
 +
 .. Use a command similar to the following to log into the `keda-metrics-apiserver-*` pod:
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [source,terminal]
 ----
 $ oc rsh pod/keda-metrics-apiserver-<hash> -n openshift-keda
@@ -128,6 +165,20 @@ For example:
 ----
 $ oc rsh pod/keda-metrics-apiserver-65c7cc44fd-rrl4r -n openshift-keda
 ----
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[source,terminal]
+----
+$ oc rsh pod/keda-metrics-apiserver-<hash> -n keda
+----
++
+For example:
++
+[source,terminal]
+----
+$ oc rsh pod/keda-metrics-apiserver-65c7cc44fd-rrl4r -n keda
+----
+endif::openshift-rosa,openshift-dedicated[]
 
 .. Change to the `/var/audit-policy/` directory:
 +

modules/nodes-cma-autoscaling-custom-gather.adoc

@@ -28,7 +28,9 @@ The standard {product-title} `must-gather` command, `oc adm must-gather`, does n
 
 .Procedure
 
+// Hide note from ROSA/OSD, as restricted is not supported.
 . Navigate to the directory where you want to store the `must-gather` data.
+ifndef::openshift-rosa,openshift-dedicated[]
 +
 [NOTE]
 ====
@@ -39,6 +41,7 @@ If your cluster is using a restricted network, you must take additional steps. I
 $ oc import-image is/must-gather -n openshift
 ----
 ====
+endif::openshift-rosa,openshift-dedicated[]
 
 . Perform one of the following:
 +
@@ -74,6 +77,7 @@ $ oc adm must-gather --image-stream=openshift/must-gather --image=${IMAGE}
 --
 +
 .Example must-gather output for the Custom Metric Autoscaler:
+ifndef::openshift-rosa,openshift-dedicated[]
 [%collapsible]
 ====
 [source,terminal]
@@ -157,6 +161,92 @@ $ oc adm must-gather --image-stream=openshift/must-gather --image=${IMAGE}
         └── routes.yaml
 ----
 ====
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[%collapsible]
+====
+[source,terminal]
+----
+└── keda
+    ├── apps
+    │   ├── daemonsets.yaml
+    │   ├── deployments.yaml
+    │   ├── replicasets.yaml
+    │   └── statefulsets.yaml
+    ├── apps.openshift.io
+    │   └── deploymentconfigs.yaml
+    ├── autoscaling
+    │   └── horizontalpodautoscalers.yaml
+    ├── batch
+    │   ├── cronjobs.yaml
+    │   └── jobs.yaml
+    ├── build.openshift.io
+    │   ├── buildconfigs.yaml
+    │   └── builds.yaml
+    ├── core
+    │   ├── configmaps.yaml
+    │   ├── endpoints.yaml
+    │   ├── events.yaml
+    │   ├── persistentvolumeclaims.yaml
+    │   ├── pods.yaml
+    │   ├── replicationcontrollers.yaml
+    │   ├── secrets.yaml
+    │   └── services.yaml
+    ├── discovery.k8s.io
+    │   └── endpointslices.yaml
+    ├── image.openshift.io
+    │   └── imagestreams.yaml
+    ├── k8s.ovn.org
+    │   ├── egressfirewalls.yaml
+    │   └── egressqoses.yaml
+    ├── keda.sh
+    │   ├── kedacontrollers
+    │   │   └── keda.yaml
+    │   ├── scaledobjects
+    │   │   └── example-scaledobject.yaml
+    │   └── triggerauthentications
+    │       └── example-triggerauthentication.yaml
+    ├── monitoring.coreos.com
+    │   └── servicemonitors.yaml
+    ├── networking.k8s.io
+    │   └── networkpolicies.yaml
+    ├── keda.yaml
+    ├── pods
+    │   ├── custom-metrics-autoscaler-operator-58bd9f458-ptgwx
+    │   │   ├── custom-metrics-autoscaler-operator
+    │   │   │   └── custom-metrics-autoscaler-operator
+    │   │   │       └── logs
+    │   │   │           ├── current.log
+    │   │   │           ├── previous.insecure.log
+    │   │   │           └── previous.log
+    │   │   └── custom-metrics-autoscaler-operator-58bd9f458-ptgwx.yaml
+    │   ├── custom-metrics-autoscaler-operator-58bd9f458-thbsh
+    │   │   └── custom-metrics-autoscaler-operator
+    │   │       └── custom-metrics-autoscaler-operator
+    │   │           └── logs
+    │   ├── keda-metrics-apiserver-65c7cc44fd-6wq4g
+    │   │   ├── keda-metrics-apiserver
+    │   │   │   └── keda-metrics-apiserver
+    │   │   │       └── logs
+    │   │   │           ├── current.log
+    │   │   │           ├── previous.insecure.log
+    │   │   │           └── previous.log
+    │   │   └── keda-metrics-apiserver-65c7cc44fd-6wq4g.yaml
+    │   └── keda-operator-776cbb6768-fb6m5
+    │       ├── keda-operator
+    │       │   └── keda-operator
+    │       │       └── logs
+    │       │           ├── current.log
+    │       │           ├── previous.insecure.log
+    │       │           └── previous.log
+    │       └── keda-operator-776cbb6768-fb6m5.yaml
+    ├── policy
+    │   └── poddisruptionbudgets.yaml
+    └── route.openshift.io
+        └── routes.yaml
+----
+====
+endif::openshift-rosa,openshift-dedicated[]
 
 ifndef::openshift-origin[]
 . Create a compressed file from the `must-gather` directory that was created in your working directory. For example, on a computer that uses a Linux

modules/nodes-cma-autoscaling-custom-install.adoc

@@ -118,4 +118,4 @@ spec:
 <4> Specifies the logging level for the Custom Metrics Autoscaler Metrics Server. The allowed values are `0` for `info` and `4` or `debug`. The default is `0`.
 <5> Activates audit logging for the Custom Metrics Autoscaler Operator and specifies the audit policy to use, as described in the "Configuring audit logging" section. 
 
-.. Click *Create* to create the KEDAController.
+.. Click *Create* to create the KEDA controller.

modules/nodes-cma-autoscaling-custom-uninstalling.adoc

@@ -16,7 +16,12 @@ Use the following procedure to remove the custom metrics autoscaler from your {p
 
 . In the {product-title} web console, click *Operators* -> *Installed Operators*.
 
+ifndef::openshift-rosa,openshift-dedicated[]
 . Switch to the *openshift-keda* project.
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+. Switch to the *keda* project.
+endif::openshift-rosa,openshift-dedicated[]
 
 . Remove the `KedaController` custom resource.
 
@@ -83,14 +88,30 @@ $ oc delete clusterrolebinding.keda.sh-v1alpha1-admin
 
 . Delete the custom metrics autoscaler project:
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [source,terminal]
 ----
 $ oc delete project openshift-keda
 ----
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[source,terminal]
+----
+$ oc delete project keda
+----
+endif::openshift-rosa,openshift-dedicated[]
 
 . Delete the Cluster Metric Autoscaler Operator:
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [source,terminal]
 ----
 $ oc delete operator/openshift-custom-metrics-autoscaler-operator.openshift-keda 
 ----
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+[source,terminal]
+----
+$ oc delete operator/openshift-custom-metrics-autoscaler-operator.keda 
+----
+endif::openshift-rosa,openshift-dedicated[]