Update cluster-logging-kibana-scaling.adoc by prithvipatil97 · Pull Request #89957 · openshift/openshift-docs

prithvipatil97 · 2025-03-10T13:28:21Z

Incorrect configuration under scaling redundancy for the log visualizer nodes documentation
Here is the documentation link: https://docs.openshift.com/container-platform/4.16/observability/logging/log_visualization/logging-kibana.html#cluster-logging-kibana-scaling_logging-kibana

=======================================

namespace name is missing from the command.
same command is mentioned twice in the second block. Which is not required and hence needs to be removed.
"namespace: openshift-logging" field is missing under metadata section.
2 extra spaces under spec.visulization, it will not cause any effect. But it needs to be with correct indentation.

=======================================

=======================================
Reason:

Suppose the user is not a part of openshift-logging project, and he tries to run this command then this command will not work.
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.

=======================================

Updated documentation will look like the following:

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

$ oc -n openshift-logging edit ClusterLogging instance

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance"
  namespace: openshift-logging
....

spec:
  visualization:
    type: "kibana"
    kibana:
      replicas: 1

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-1756

Link to docs preview:

https://89957--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_visualization/logging-kibana.html

QE review:

QE has approved this change.

Additional information:

- Incorrect configuration under scaling redundancy for the log visualizer nodes documentation - Here is the documentation link: https://docs.openshift.com/container-platform/4.16/observability/logging/log_visualization/logging-kibana.html#cluster-logging-kibana-scaling_logging-kibana ============= - namespace name is missing from the command. - same command is mentioned twice in the second block. Which is not required and hence needs to be removed. - "namespace: openshift-logging" field is missing under `metadata` section. - 2 extra spaces under `spec.visulization`, it will not cause any effect. But it needs to be with correct indentation. =========== =========== 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. =============== Updated documentation will look like the following: 1. Edit the ClusterLogging custom resource (CR) in the openshift-logging project: ~~~ $ oc -n openshift-logging edit ClusterLogging instance ~~~ ~~~ apiVersion: "logging.openshift.io/v1" kind: "ClusterLogging" metadata: name: "instance" namespace: openshift-logging .... spec: visualization: type: "kibana" kibana: replicas: 1 ~~~

ocpdocs-previewbot · 2025-03-10T16:14:47Z

🤖 Mon Mar 10 16:14:47 - Prow CI generated the docs preview:

https://89957--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_visualization/logging-kibana.html

openshift-ci · 2025-03-10T16:17:01Z

@prithvipatil97: all tests passed!

Full PR test history. Your PR dashboard.

Details

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 · 2025-03-10T21:38:05Z

/label peer-review-needed

mburke5678 · 2025-03-11T00:36:00Z

/lgtm

prithvipatil97 · 2025-03-11T00:44:15Z

Hello @mburke5678 ,
Thank you very much for reviewing this PR and providing approval.

Yes, these changes needs to be merged from RHCOP 4.12 and +

Regards,
Prithviraj Patil

prithvipatil97 · 2025-03-11T00:44:37Z

Hello Team,
I need QE approval for this change.

All checks have passed and Peer review is also done.

@anpingli , @kabirbhartiRH , @QiaolingTang , It would be really helpful if someone could please take a look and provide QE approval for this change.

Thanks in advance.

Regards,
Prithviraj Patil

QiaolingTang · 2025-03-11T01:07:02Z

LGTM.

prithvipatil97 · 2025-03-11T01:10:04Z

Hello @QiaolingTang ,
Thank you very much for providing the QE approval for this change.

Regards,
Prithviraj Patil

prithvipatil97 · 2025-03-11T01:10:20Z

/label merge-review-needed

xenolinux

LGTM merging

xenolinux · 2025-03-11T07:06:30Z

/cherrypick enterprise-4.19

xenolinux · 2025-03-11T07:06:36Z

/cherrypick enterprise-4.18

xenolinux · 2025-03-11T07:06:40Z

/cherrypick enterprise-4.17

xenolinux · 2025-03-11T07:06:44Z

/cherrypick enterprise-4.16

xenolinux · 2025-03-11T07:06:47Z

/cherrypick enterprise-4.15

xenolinux · 2025-03-11T07:06:51Z

/cherrypick enterprise-4.14

xenolinux · 2025-03-11T07:06:55Z

/cherrypick enterprise-4.13

xenolinux · 2025-03-11T07:06:58Z

/cherrypick enterprise-4.12

openshift-cherrypick-robot · 2025-03-11T07:09:18Z

@xenolinux: new pull request created: #90029

Details

In response to this:

/cherrypick enterprise-4.19