Incorrect structure of command in Configuring replication policy for the log store

[prithvipatil97]

• The structure of the command is incorrect in Configuring the replication policy for the log store documentation.
• Here is the documentation Link:
  https://docs.openshift.com/container-platform/4.16/observability/logging/log_storage/logging-config-es-store.html#cluster-logging-elasticsearch-ha_logging-config-es-store
• Here in Step1 under the procedure section, we could see the below command is mentioned:

$ oc edit clusterlogging instance 

• But this is not the correct way.
• The correct way to mention clusterlogging in the Red Hat Standard Documentation is ClusterLogging.
• We can verify this in the other part of our documentation.
• In addition, Step1 is noted with "Edit the ClusterLogging custom resource (CR) in the openshift-logging project:"
• However, the project name is not mentioned in the command.
• It is necessary to mention the project name while executing that command.

Reason:

1. Suppose the user is not a part of openshift-logging project, and he tries to run this command then this command will not work.
2. If the credentials are shared, and two people are using the same cluster at the same time, then, the second person could change to work in a different namespace.

• Hence it will be always beneficial to run the above command with the project name.
• We need to perform these changes in our documentation.
• Here is the correct structure of this command.

---

1. Edit the ClusterLogging custom resource (CR) in the openshift-logging project:

$ oc edit -n openshift-logging ClusterLogging instance 

---

Version(s):

RHOCP-4.18, RHOCP-4.17, RHOCP-4.16, RHOCP-4.15, RHOCP-4.14, RHOCP-4.13, RHOCP-4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-1598

Link to docs preview:

https://86740--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/log_storage/logging-config-es-store.html

https://86740--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_storage/logging-config-es-store.html

https://86740--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_storage/logging-config-es-store.html

QE review:

• QE has approved this change.

Additional information:

[ocpdocs-previewbot]

🤖 Mon Jan 06 20:53:57 - Prow CI generated the docs preview:

https://86740--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/log_storage/logging-config-es-store.html
https://86740--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_storage/logging-config-es-store.html
https://86740--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_storage/logging-config-es-store.html

[openshift-ci]

@prithvipatil97: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[prithvipatil97]

/label peer-review-needed

[mburke5678]

@prithvipatil97 The user is told to use the openshift-logging project in the step text:

Edit the ClusterLogging custom resource (CR) in the openshift-logging project:

I think having the project in both places would be redundant. If you strongly believe that the command should have the namespace, we should change the step text.

. Edit the `ClusterLogging` custom resource (CR):
+
[source,terminal]
----
$ oc edit -n openshift-logging ClusterLogging instance
----

Also, if we make the change to include the namespace in the command, the change should be made in all places:

@briandooley WDYT?

[briandooley]

@mburke5678 Going to need some clarification. When you say "both" places, where do you mean?

I agree that the change in one place should be replicated in the other places as well, assuming that the commands pass QE.

[prithvipatil97]

Hello @mburke5678 ,
Thank you very much for your attention here.

With this PR we are performing 2 changes. Here is the current command:

$ oc edit clusterlogging instance 

-The correct way to mention clusterlogging in documentation is ClusterLogging
-And Yes, I strongly believe that the command should have the namespace.
-I have mentioned the reason for this in the PR description.

Additionally, If you think of changing the step text, that would also be acceptable.
However, I believe it is unnecessary to change the step text, as it will not cause confusion for users.

Also, if we check this doc path [1] and [2]
[1] modules/cluster-logging-cpu-memory.adoc
[2] modules/cluster-logging-collector-limits.adoc

Here it is mentioned:

. Edit the `ClusterLogging` custom resource (CR) in the `openshift-logging` project:
+
[source,terminal]
----
$ oc -n openshift-logging edit ClusterLogging instance
----

So I think we should be good to proceed with this change.
Kindly share your thoughts on it.

Regards,
Prithviraj Patil