Skip to content

Prerequisites are missing from Update log6x-about.adoc #87991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Prerequisites are missing from Update log6x-about.adoc #87991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions observability/logging/logging-6.0/log6x-about.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ The Cluster Logging Operator manages the deployment and configuration of the col
== Validation
Logging includes extensive validation rules and default values to ensure a smooth and error-free configuration experience. The `ClusterLogForwarder` resource enforces validation checks on required fields, dependencies between fields, and the format of input values. Default values are provided for certain fields, reducing the need for explicit configuration in common scenarios.

=== Quick Start
== Quick Start

.Prerequisites
* Cluster administrator permissions
* You have administrator permissions.
* You installed the {oc-first}.
* You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.

.Procedure

Expand Down Expand Up @@ -95,7 +97,7 @@ $ oc create sa collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
----

. Install the Cluster Observability Operator.
. Install the link:https://docs.openshift.com/container-platform/4.16/observability/cluster_observability_operator/installing-the-cluster-observability-operator.html#installing-the-cluster-observability-operator-in-the-web-console-_installing_the_cluster_observability_operator[Cluster Observability Operator].
Comment on lines -98 to +100
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand why you use link here instead of xref (to avoid xrefs in a module), however, I am not sure if this is the best practice, even more with the decommisioning of docs.openshift (which will probably break these links).

I would consider leaving this as it was and instead adding an additional resources section after the module in an assembly, where you would link this correctly with xref

[role="_additional-resources"]
.Additional resources
* xref:../

Copy link
Contributor

@eromanova97 eromanova97 Feb 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the Cluster Observability Operator has an attribute you can use here: {coo-full}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, @eromanova97 . Excellent review!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @eromanova97 ,
Thanks for your attention here in peer review.

I apologize for the inconvenience caused.
I understand the suggested changes.

Thank you again,

Regard,
Prithviraj Patil


. Create a `UIPlugin` to enable the Log section in the Observe tab:
+
Expand Down