Skip to content
Closed
Changes from all commits
Commits
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
29 changes: 9 additions & 20 deletions modules/log6x-quickstart-viaq.adoc
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
* You have access to an {product-title} cluster with `cluster-admin` 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

. 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 @@ -55,7 +57,7 @@ $ oc create sa collector -n openshift-logging
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
----
+
[NOTE]
Expand All @@ -67,22 +69,9 @@ The `ClusterRole` resource is created automatically during the Cluster Logging O
+
Copy link
Contributor

Choose a reason for hiding this comment

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

Allow the collector's service account to collect logs: --> can be updated to something like --> To collect logs, use the service account of the collector by running the following command:

I know this PR doesn't touch this line, but FYI:

Avoid using "allow": https://www.ibm.com/docs/en/ibm-style?topic=word-usage#a

Avoid stating that inanimate objects grant abilities to people, as in “the product allows you to…”. Whenever possible, use a direct, user-focused alternative such as “you can use the product to…” or “with this product, users can…”.

https://www.ibm.com/docs/en/ibm-style?topic=grammar-possessives

Do not use possessive ’s with inanimate objects.

[source,terminal]
----
$ oc project openshift-logging
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging
Comment on lines +72 to +74
Copy link
Contributor

Choose a reason for hiding this comment

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

The old version (commands in a separate code blocks) is correct.

Do not use more than one command per code block.

----
+
[NOTE]
Expand Down Expand Up @@ -146,4 +135,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 {product-title} web console.