OBSDOCS-204: Bug fix for configurable parameter and doc editing

_topic_maps/_topic_map.yml

@@ -2610,7 +2610,7 @@ Topics:
     File: cluster-logging-systemd
   - Name: Maintenance and support
     File: cluster-logging-maintenance-support
-- Name: Logging with the LokiStack
+- Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
   File: viewing-resource-logs

_topic_maps/_topic_map_osd.yml

@@ -390,7 +390,7 @@ Topics:
   #  File: cluster-logging-systemd
   - Name: Maintenance and support
     File: cluster-logging-maintenance-support
-- Name: Logging with the LokiStack
+- Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
   File: viewing-resource-logs

_topic_maps/_topic_map_rosa.yml

@@ -509,7 +509,7 @@ Topics:
   #  File: cluster-logging-systemd
   - Name: Maintenance and support
     File: cluster-logging-maintenance-support
-- Name: Logging with the LokiStack
+- Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
   File: viewing-resource-logs

logging/cluster-logging-external.adoc

@@ -183,7 +183,7 @@ include::modules/cluster-logging-collector-log-forward-secret-cloudwatch.adoc[le
 
 include::modules/cluster-logging-collector-log-forward-loki.adoc[leveloffset=+1]
 
-include::modules/cluster-logging-troubleshooting-loki-entry-out-of-order-errors.adoc[leveloffset=+2]
+include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources

logging/cluster-logging-loki.adoc

@@ -1,23 +1,30 @@
 :_content-type: ASSEMBLY
 :context: cluster-logging-loki
 [id="cluster-logging-loki"]
-= Loki
+= Logging using LokiStack
 include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-include::modules/cluster-logging-loki-about.adoc[leveloffset=+1]
+In {logging} documentation, _LokiStack_ refers to the {logging} supported combination of Loki and web proxy with {product-title} authentication integration. LokiStack's proxy uses {product-title} authentication to enforce multi-tenancy. _Loki_ refers to the log store as either the individual component or an external store.
+
+Loki is a horizontally scalable, highly available, multi-tenant log aggregation system currently offered as an alternative to Elasticsearch as a log store for the {logging}. Elasticsearch indexes incoming log records completely during ingestion. Loki only indexes a few fixed labels during ingestion and defers more complex parsing until after the logs have been stored. This means Loki can collect logs more quickly. You can query Loki by using the link:https://grafana.com/docs/loki/latest/logql/[LogQL log query language].
+
+include::modules/loki-deployment-sizing.adoc[leveloffset=+1]
 
 include::modules/cluster-logging-loki-deploy.adoc[leveloffset=+1]
 
 include::modules/logging-loki-retention.adoc[leveloffset=+1]
 
 include::modules/cluster-logging-forwarding-lokistack.adoc[leveloffset=+1]
 
-include::modules/cluster-logging-troubleshooting-loki-entry-out-of-order-errors.adoc[leveloffset=+2]
+include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
 
+[role="_additional-resources"]
+[id="additional-resources_cluster-logging-loki"]
 == Additional Resources
 * link:https://grafana.com/docs/loki/latest/logql/[Loki Query Language (LogQL) Documentation]
 * link:https://loki-operator.dev/docs/howto_connect_grafana.md/[Grafana Dashboard Documentation]
 * link:https://loki-operator.dev/docs/object_storage.md/[Loki Object Storage Documentation]
+* link:https://loki-operator.dev/docs/api.md/#loki-grafana-com-v1-IngestionLimitSpec[Loki Operator `IngestionLimitSpec` Documentation]
 * link:https://grafana.com/docs/loki/latest/operations/storage/schema/#changing-the-schema[Loki Storage Schema Documentation]

modules/cluster-logging-forwarding-lokistack.adoc

@@ -4,17 +4,17 @@
 [id="cluster-logging-forwarding-lokistack_{context}"]
 = Forwarding logs to LokiStack
 
-To configure log forwarding to the LokiStack gateway, you must create a ClusterLogging custom resource (CR).
+To configure log forwarding to the LokiStack gateway, you must create a `ClusterLogging` custom resource (CR).
 
 .Prerequisites
 
-* {logging-title-uc}: 5.5 and later
-* `Loki Operator` Operator
+* The {logging-title-uc} version 5.5 or newer is installed on your cluster.
+* The Loki Operator is installed on your cluster.
 
 .Procedure
 
-. Create or edit a YAML file that defines the `ClusterLogging` custom resource (CR):
-
+* Create a `ClusterLogging` custom resource (CR):
++
 [source,yaml]
 ----
 apiVersion: logging.openshift.io/v1

modules/cluster-logging-loki-deploy.adoc

@@ -74,7 +74,7 @@ stringData:
   region: eu-central-1
 ----
 +
-. Create the `LokiStack` custom resource:
+. Create the `LokiStack` custom resource (CR):
 +
 [source,yaml]
 ----
@@ -96,16 +96,16 @@ spec:
   tenants:
     mode: openshift-logging
 ----
-<1> Or `gp2-csi`. 
-+
-.. Apply the configuration:
+<1> Or `gp2-csi`.
+
+. Apply the `LokiStack` CR:
 +
 [source,terminal]
 ----
-oc apply -f logging-loki.yaml
+$ oc apply -f logging-loki.yaml
 ----
-+
-. Create or edit a `ClusterLogging` CR:
+
+. Create a `ClusterLogging` custom resource (CR):
 +
 [source,yaml]
 ----
@@ -123,14 +123,14 @@ spec:
   collection:
     type: vector
 ----
-+
-.. Apply the configuration:
+
+. Apply the `ClusterLogging` CR:
 +
 [source,terminal]
 ----
-oc apply -f cr-lokistack.yaml
+$ oc apply -f cr-lokistack.yaml
 ----
-+
+
 . Enable the RedHat OpenShift Logging Console Plugin:
 ifndef::openshift-rosa,openshift-dedicated[]
 .. In the {product-title} web console, click *Operators* -> *Installed Operators*.
@@ -140,11 +140,6 @@ ifdef::openshift-rosa,openshift-dedicated[]
 endif::[]
 .. Select the *RedHat OpenShift Logging* Operator.
 .. Under Console plugin, click *Disabled*.
-.. Select *Enable* and then *Save*. This change will restart the 'openshift-console' pods.
+.. Select *Enable* and then *Save*. This change restarts the `openshift-console` pods.
 .. After the pods restart, you will receive a notification that a web console update is available, prompting you to refresh.
-.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* will be available to you.
-
-[NOTE]
-====
-This plugin is only available on {product-title} 4.10 and later.
-====
+.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* is available.

modules/cluster-logging-loki-about.adoc → modules/loki-deployment-sizing.adoc

@@ -1,20 +1,15 @@
 // Module is included in the following assemblies:
 //cluster-logging-loki.adoc
-:_content-type: CONCEPT
-[id="about-logging-loki_{context}"]
-= About the LokiStack
-
-In {logging} documentation, *LokiStack* refers to the {logging} supported combination of Loki, and web proxy with {product-title} authentication integration. LokiStack's proxy uses {product-title} authentication to enforce multi-tenancy. *Loki* refers to the log store as either the individual component or an external store.
 
-Loki is a horizontally scalable, highly available, multi-tenant log aggregation system currently offered as an alternative to Elasticsearch as a log store for the {logging}. Elasticsearch indexes incoming log records completely during ingestion. Loki only indexes a few fixed labels during ingestion, and defers more complex parsing until after the logs have been stored. This means Loki can collect logs more quickly. As with Elasticsearch, you can query Loki link:https://grafana.com/docs/loki/latest/[using JSON paths or regular expressions].
+:_content-type: CONCEPT
+[id="loki-deployment-sizing_{context}"]
+= Deployment Sizing
 
-[id="deployment-sizing_{context}"]
-== Deployment Sizing
 Sizing for Loki follows the format of `N<x>._<size>_` where the value `<N>` is number of instances and `<size>` specifies performance capabilities.
 
 [NOTE]
 ====
-1x.extra-small is for demo purposes only, and is not supported. 
+1x.extra-small is for demo purposes only, and is not supported.
 ====
 
 .Loki Sizing