diff --git a/modules/rosa-creating-node-tuning.adoc b/modules/rosa-creating-node-tuning.adoc index f80e17f6d8e8..c4a7a1f7665b 100644 --- a/modules/rosa-creating-node-tuning.adoc +++ b/modules/rosa-creating-node-tuning.adoc @@ -4,10 +4,10 @@ :_mod-docs-content-type: PROCEDURE [id="rosa-creating-node-tuning_{context}"] -= Creating node tuning configurations += Create node tuning configurations [role="_abstract"] -You can create tuning configurations by using the {rosa-cli-first}. +Create node tuning configurations to optimize node-level performance for your workloads by using the {rosa-cli-first}. .Prerequisites @@ -17,14 +17,14 @@ You can create tuning configurations by using the {rosa-cli-first}. .Procedure -. Run the following command to create your tuning configuration: +* Run the following command to create your tuning configuration: + [source,terminal] ---- $ rosa create tuning-config -c --name --spec-path ---- + -You must supply the path to the `spec.json` file or the command returns an error. +You must supply the path to the `spec.json` file, or the command returns an error. + [source,terminal] ---- @@ -38,7 +38,7 @@ $ I: To view all tuning configs, run 'rosa list tuning-configs -c cluster-exampl .Verification -* You can verify the existing tuning configurations that are applied by your account with the following command: +* You can verify the existing tuning configurations by running the following command: + [source,terminal] ---- @@ -49,7 +49,8 @@ You can specify the type of output you want for the configuration list. ** Without specifying the output type, you see the ID and name of the tuning configuration: + -.Example output without specifying output type +*Example output without specifying output type* ++ [source,terminal] ---- ID NAME @@ -63,7 +64,8 @@ ID NAME The following JSON output has hard line-returns for the sake of reading clarity. This JSON output is invalid unless you remove the newlines in the JSON strings. ==== + -.Example output specifying JSON output +*Example output specifying JSON output* ++ [source,terminal] ---- [ diff --git a/modules/rosa-deleting-node-tuning.adoc b/modules/rosa-deleting-node-tuning.adoc index f60d86d5b876..2d432b2d9b35 100644 --- a/modules/rosa-deleting-node-tuning.adoc +++ b/modules/rosa-deleting-node-tuning.adoc @@ -4,25 +4,25 @@ :_mod-docs-content-type: PROCEDURE [id="rosa-deleting-node-tuning_{context}"] -= Deleting node tuning configurations += Delete node tuning configurations [role="_abstract"] -You can delete tuning configurations if you no longer need them by using the {rosa-cli-first}. +Remove unused node tuning configurations from your cluster to simplify management by using the {rosa-cli-first}. [NOTE] ==== -You cannot delete a tuning configuration referenced in a machine pool. You must first remove the tuning configuration from all machine pools before you can delete it. +You cannot delete a tuning configuration referenced in a machine pool. You must remove the tuning configuration from all machine pools before you can delete it. ==== .Prerequisites * You have downloaded the latest version of the {rosa-cli}. * You have a cluster on the latest version. -* Your cluster has a node tuning configuration that you want delete. +* Your cluster has a node tuning configuration that you want to delete. .Procedure -* To delete the tuning configurations, run the following command: +* To delete a tuning configuration, run the following command: + [source,terminal] ---- @@ -31,7 +31,8 @@ $ rosa delete tuning-config -c + The tuning configuration on the cluster is deleted. + -.Example output +*Example output* ++ [source,terminal] ---- ? Are you sure you want to delete tuning config sample-tuning on cluster sample-cluster? Yes diff --git a/modules/rosa-modifying-node-tuning.adoc b/modules/rosa-modifying-node-tuning.adoc index 8ab8e2265360..e00eb73902ea 100644 --- a/modules/rosa-modifying-node-tuning.adoc +++ b/modules/rosa-modifying-node-tuning.adoc @@ -4,10 +4,10 @@ :_mod-docs-content-type: PROCEDURE [id="rosa-modifying-node-tuning_{context}"] -= Modifying your node tuning configurations += Modify node tuning configurations [role="_abstract"] -You can view and update the node tuning configurations by using the {rosa-cli-first}. +View and update node tuning configurations to adjust performance settings for your cluster by using the {rosa-cli-first}. .Prerequisites @@ -17,7 +17,7 @@ You can view and update the node tuning configurations by using the {rosa-cli-fi .Procedure -. You view the tuning configurations with the `rosa describe` command: +. View the tuning configurations with the `rosa describe` command: + [source,terminal] ---- @@ -33,7 +33,8 @@ where: `-o json`:: Specifies the output type. This parameter is optional. If you do not specify any outputs, you see only the ID and name of the tuning configuration. -- + -.Example output without specifying output type +*Example output without specifying output type* ++ [source,terminal] ---- Name: sample-tuning @@ -55,7 +56,8 @@ Spec: { ---- + -.Example output specifying JSON output +*Example output specifying JSON output* ++ [source,terminal] ---- { @@ -80,8 +82,9 @@ Spec: { } ---- -. After verifying the tuning configuration, you edit the existing configurations with the `rosa edit` command: +. After verifying the tuning configuration, edit the existing configuration with the `rosa edit` command: + +[source,terminal] ---- $ rosa edit tuning-config -c --name --spec-path ---- @@ -90,14 +93,15 @@ In this command, you use the `spec.json` file to edit your configurations. .Verification -* Run the `rosa describe` command again, to see that the changes you made to the `spec.json` file are updated in the tuning configurations: +* Run the `rosa describe` command again to see that the changes you made to the `spec.json` file are updated in the tuning configurations: + [source,terminal] ---- $ rosa describe tuning-config -c --name ---- + -.Example output +*Example output* ++ [source,terminal] ---- Name: sample-tuning diff --git a/modules/sd-nodes-cma-autoscaling-custom-install.adoc b/modules/sd-nodes-cma-autoscaling-custom-install.adoc index e479986b9cc9..50e1f202d35e 100644 --- a/modules/sd-nodes-cma-autoscaling-custom-install.adoc +++ b/modules/sd-nodes-cma-autoscaling-custom-install.adoc @@ -4,43 +4,44 @@ :_mod-docs-content-type: PROCEDURE [id="sd-nodes-cma-autoscaling-custom-install_{context}"] -= Installing the custom metrics autoscaler += Install the custom metrics autoscaler [role="_abstract"] -You can use the following procedure to install the Custom Metrics Autoscaler Operator. +Install the Custom Metrics Autoscaler Operator to enable autoscaling of your workloads based on custom metrics from external sources such as Kafka or Prometheus. .Prerequisites * You have access to the cluster as a user with the `cluster-admin` role. ifdef::openshift-dedicated[] + -If your {product-title} cluster is in a cloud account that is owned by Red Hat (non-CCS), you must request `cluster-admin` privileges. +If your {product-title} cluster is in a cloud account that is owned by Red{nbsp}Hat (non-CCS), you must request `cluster-admin` privileges. endif::openshift-dedicated[] -* Remove any previously-installed Technology Preview versions of the Cluster Metrics Autoscaler Operator. +* Any previously installed Technology Preview versions of the Cluster Metrics Autoscaler Operator are removed. -* Remove any versions of the community-based KEDA. -+ -Also, remove the KEDA 1.x custom resource definitions by running the following commands: -+ -[source,terminal] ----- -$ oc delete crd scaledobjects.keda.k8s.io ----- -+ -[source,terminal] ----- -$ oc delete crd triggerauthentications.keda.k8s.io ----- - -* Ensure that the `keda` namespace exists. If not, you must manually create the `keda` namespace. - -* Optional: If you need the Custom Metrics Autoscaler Operator to connect to off-cluster services, such as an external Kafka cluster or an external Prometheus service, put any required service CA certificates into a config map. The config map must exist in the same namespace where the Operator is installed. For example: -+ -[source,terminal] ----- -$ oc create configmap -n openshift-keda thanos-cert --from-file=ca-cert.pem ----- +* Any versions of the community-based KEDA are removed, including the KEDA 1.x custom resource definitions (CRDs). To learn how to delete CRDs, see step 5 in +ifdef::openshift-rosa-hcp[] +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/nodes/index#nodes-cma-autoscaling-custom-uninstalling_nodes-cma-autoscaling-custom-removing[Uninstalling the Custom Metrics Autoscaler Operator]. +endif::[] +ifdef::openshift-rosa[] +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws_classic_architecture/4/html-single/nodes/index#nodes-cma-autoscaling-custom-uninstalling_nodes-cma-autoscaling-custom-removing[Uninstalling the Custom Metrics Autoscaler Operator]. +endif::[] +ifdef::openshift-dedicated[] +link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/nodes/index#nodes-cma-autoscaling-custom-uninstalling_nodes-cma-autoscaling-custom-removing[Uninstalling the Custom Metrics Autoscaler Operator]. +endif::[] + +* The `keda` namespace exists. If the namespace does not exist, you must create it manually. + +* Optional: If you need the Custom Metrics Autoscaler Operator to connect to off-cluster services, such as an external Kafka cluster or an external Prometheus service, put any required service CA certificates into a config map. The config map must exist in the same namespace where the Operator is installed. For more information, see +ifdef::openshift-rosa-hcp[] +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/nodes/index#nodes-pods-configmap-creating-from-files_configmaps[Creating a config map from a file]. +endif::[] +ifdef::openshift-rosa[] +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws_classic_architecture/4/html-single/nodes/index#nodes-pods-configmap-creating-from-files_configmaps[Creating a config map from a file]. +endif::[] +ifdef::openshift-dedicated[] +link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/nodes/index#nodes-pods-configmap-creating-from-files_configmaps[Creating a config map from a file]. +endif::[] .Procedure @@ -80,7 +81,8 @@ $ oc create configmap -n openshift-keda thanos-cert --from-file=ca-cert.pem $ oc get all -n keda ---- + -.Example output +*Example output* ++ [source,text] ---- NAME READY STATUS RESTARTS AGE diff --git a/snippets/rosa-node-lifecycle.adoc b/snippets/rosa-node-lifecycle.adoc index 420b077f6d35..01a05de903c5 100644 --- a/snippets/rosa-node-lifecycle.adoc +++ b/snippets/rosa-node-lifecycle.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * nodes/index.adoc +// * nodes/nodes-nodes-viewing.adoc :_mod-docs-content-type: SNIPPET [IMPORTANT] ==== -Worker nodes are not guaranteed longevity, and may be replaced at any time as part of the normal operation and management of OpenShift. For more details about the node lifecycle, refer to _additional resources_. +Worker node longevity is not guaranteed, and nodes may be replaced at any time as part of the normal operation and management of {OCP-short}. For more details about the node lifecycle, refer to _Additional resources_. ====