Skip to content

Commit f588e10

Browse files
Incorrect structure of command in Edit the ClusterLogging custom resource (CR) step under multiple docs.
- The structure of the command is incorrect in Edit the ClusterLogging custom resource (CR) step under multiple documents. - Here is the one of 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 -n openshift-logging edit ClusterLogging instance ~~~ -------------------- - We need to perform this changes in the following modules/section:
1 parent fd64995 commit f588e10

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

modules/cluster-logging-elasticsearch-ha.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can define how Elasticsearch shards are replicated across data nodes in the
1818
+
1919
[source,terminal]
2020
----
21-
$ oc edit clusterlogging instance
21+
$ oc -n openshift-logging edit ClusterLogging instance
2222
----
2323
+
2424
[source,yaml]

0 commit comments

Comments
 (0)