Skip to content

Logging 6.1 Prerequisites missing log6x-quickstart-viaq.adoc #87992

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

Logging 6.1 Prerequisites missing log6x-quickstart-viaq.adoc #87992

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 modules/log6x-quickstart-viaq.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@
To use the default ViaQ data model, follow these steps:

.Prerequisites
* Cluster administrator permissions
Copy link
Contributor

Choose a reason for hiding this comment

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

One out of scope comment: I noticed that another chapter in this assembly, "Quick start with OpenTelemetry", has the same prerequisite: "Cluster administrator permissions" so it would be great to also change that to: "You have administrator permissions." for consistency, plus check if any prerequisites are missing there too.

However, I saw that there is more than one PR similar to this, so this might already be addressed elsewere, I just wanted to point that out just in case 👍

* You have administrator permissions.
* You installed the OpenShift CLI (oc).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* You installed the OpenShift CLI (oc).
* You installed the {oc-first}.

We can use an attribute here.

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 understand your point.

I apologize for the inconvenience caused.
I understand the suggested changes; I will try to commit these changes.

Thank you again,

Regard,
Prithviraj Patil

* You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or OpenShift Data Foundation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-storage}' rather than the plain text product term 'OpenShift Data Foundation', unless your use case is an exception.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or OpenShift Data Foundation.
* You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.

We can use attributes here.

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 understand your point.
But I have taken this point from our standard RedHat Documentation.

https://docs.openshift.com/container-platform/4.16/observability/logging/cluster-logging-deploying.html#logging-loki-cli-install_cluster-logging-deploying

I apologize for the inconvenience caused.
I understand the suggested changes; I will try to commit these changes.

Thank you again,

Regard,
Prithviraj Patil


.Procedure

. Install the {clo}, {loki-op}, and {coo-first} from OperatorHub.
. Install the `{clo}`, `{loki-op}`, and `{coo-first}` from OperatorHub.

. Create a `LokiStack` custom resource (CR) in the `openshift-logging` namespace:
+
Expand Down Expand Up @@ -146,4 +148,4 @@ The `dataModel` field is optional and left unset (`dataModel: ""`) by default. T
====

.Verification
* Verify that logs are visible in the *Log* section of the *Observe* tab in the OpenShift web console.
* Verify that logs are visible in the *Log* section of the *Observe* tab in the OpenShift web console.