From ee74d07bbcdfbef3a33b91af5d4121ef08a90536 Mon Sep 17 00:00:00 2001 From: Prithviraj Patil <116709298+prithvipatil97@users.noreply.github.com> Date: Wed, 19 Mar 2025 20:34:48 +0530 Subject: [PATCH] Need to add colon and remove bold object names from documentation - Need to add colon and remove bold object names from documentation - Here is the documentation link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/logging/logging-6-0#log-storage-3 - colon is missing from Step1, Step2, Step3, Step4 - Also, some object names are bold instead they should be in backticks. - These changes are suggested by a peer reviewer. - Here is the old PR link where these changes are suggested: https://github.com/openshift/openshift-docs/pull/89931 - So we need to add a colon in all the steps and change the bold object name to backticks. New-Update log6x-upgrading-to-6.adoc Committing the suggestions New-Update-july10th-Update log6x-upgrading-to-6.adoc Committing the suggestions --- .../logging-6.0/log6x-upgrading-to-6.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/observability/logging/logging-6.0/log6x-upgrading-to-6.adoc b/observability/logging/logging-6.0/log6x-upgrading-to-6.adoc index 468a3849ea..c403df7bc5 100644 --- a/observability/logging/logging-6.0/log6x-upgrading-to-6.adoc +++ b/observability/logging/logging-6.0/log6x-upgrading-to-6.adoc @@ -24,40 +24,40 @@ include::modules/log6x-oc-explain.adoc[leveloffset=+1] == Log Storage -The only managed log storage solution available in this release is a Lokistack, managed by the *loki-operator*. This solution, previously available as the preferred alternative to the managed Elasticsearch offering, remains unchanged in its deployment process. +The only managed log storage solution available in this release is a Lokistack, managed by the Loki Operator. This solution, previously available as the preferred alternative to the managed Elasticsearch offering, remains unchanged in its deployment process. [IMPORTANT] ==== -To continue using an existing Red Hat managed Elasticsearch or Kibana deployment provided by the *elasticsearch-operator*, remove the owner references from the `Elasticsearch` resource named `elasticsearch`, and the `Kibana` resource named `kibana` in the `openshift-logging` namespace before removing the `ClusterLogging` resource named `instance` in the same namespace. +To continue using an existing Red Hat managed Elasticsearch or Kibana deployment provided by the Elasticsearch Operator, remove the owner references from the Elasticsearch resource named `elasticsearch`, and the Kibana resource named `kibana` in the `openshift-logging` namespace before removing the `ClusterLogging` resource named `instance` in the same namespace. ==== -. Temporarily set *ClusterLogging* to state `Unmanaged` +. Temporarily set `ClusterLogging` resource to the `Unmanaged` state by running the following command: + [source,terminal] ---- $ oc -n openshift-logging patch clusterlogging/instance -p '{"spec":{"managementState": "Unmanaged"}}' --type=merge ---- -. Remove *ClusterLogging* `ownerReferences` from the *Elasticsearch* resource +. Remove the `ownerReferences` parameter from the `Elasticsearch` resource by running the following command: + -The following command ensures that *ClusterLogging* no longer owns the *Elasticsearch* resource. Updates to the *ClusterLogging* resource's `logStore` field will no longer affect the *Elasticsearch* resource. +The following command ensures that `ClusterLogging` no longer owns the `Elasticsearch` resource. Updates to the `ClusterLogging` resource's `logStore` field will no longer affect the `Elasticsearch` resource. + [source,terminal] ---- $ oc -n openshift-logging patch elasticsearch/elasticsearch -p '{"metadata":{"ownerReferences": []}}' --type=merge ---- -. Remove *ClusterLogging* `ownerReferences` from the *Kibana* resource +. Remove the `ownerReferences` parameter from the `Kibana` resource. + -The following command ensures that *ClusterLogging* no longer owns the *Kibana* resource. Updates to the *ClusterLogging* resource's `visualization` field will no longer affect the *Kibana* resource. +The following command ensures that Cluster Logging no longer owns the `Kibana` resource. Updates to the `ClusterLogging` resource's `visualization` field will no longer affect the `Kibana` resource. + [source,terminal] ---- $ oc -n openshift-logging patch kibana/kibana -p '{"metadata":{"ownerReferences": []}}' --type=merge ---- -. Set *ClusterLogging* to state `Managed` +. Set the `ClusterLogging` resource to the `Managed` state by running the following command: + [source,terminal] ----