Skip to content

Commit 8009be2

Browse files
abrennan89abrennan89
committed
OBSDOCS-204: Bug fix for configurable parameter and doc editing
1 parent fa2df24 commit 8009be2

10 files changed

+119
-176
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2610,7 +2610,7 @@ Topics:
26102610
File: cluster-logging-systemd
26112611
- Name: Maintenance and support
26122612
File: cluster-logging-maintenance-support
2613-
- Name: Logging with the LokiStack
2613+
- Name: Logging using LokiStack
26142614
File: cluster-logging-loki
26152615
- Name: Viewing logs for a specific resource
26162616
File: viewing-resource-logs

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ Topics:
390390
# File: cluster-logging-systemd
391391
- Name: Maintenance and support
392392
File: cluster-logging-maintenance-support
393-
- Name: Logging with the LokiStack
393+
- Name: Logging using LokiStack
394394
File: cluster-logging-loki
395395
- Name: Viewing logs for a specific resource
396396
File: viewing-resource-logs

‎_topic_maps/_topic_map_rosa.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ Topics:
509509
# File: cluster-logging-systemd
510510
- Name: Maintenance and support
511511
File: cluster-logging-maintenance-support
512-
- Name: Logging with the LokiStack
512+
- Name: Logging using LokiStack
513513
File: cluster-logging-loki
514514
- Name: Viewing logs for a specific resource
515515
File: viewing-resource-logs

‎logging/cluster-logging-external.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ include::modules/cluster-logging-collector-log-forward-secret-cloudwatch.adoc[le
183183

184184
include::modules/cluster-logging-collector-log-forward-loki.adoc[leveloffset=+1]
185185

186-
include::modules/cluster-logging-troubleshooting-loki-entry-out-of-order-errors.adoc[leveloffset=+2]
186+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
187187

188188
[role="_additional-resources"]
189189
.Additional resources

‎logging/cluster-logging-loki.adoc‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
:_content-type: ASSEMBLY
22
:context: cluster-logging-loki
33
[id="cluster-logging-loki"]
4-
= Loki
4+
= Logging using LokiStack
55
include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::modules/cluster-logging-loki-about.adoc[leveloffset=+1]
9+
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.
10+
11+
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].
12+
13+
include::modules/loki-deployment-sizing.adoc[leveloffset=+1]
1014

1115
include::modules/cluster-logging-loki-deploy.adoc[leveloffset=+1]
1216

1317
include::modules/logging-loki-retention.adoc[leveloffset=+1]
1418

1519
include::modules/cluster-logging-forwarding-lokistack.adoc[leveloffset=+1]
1620

17-
include::modules/cluster-logging-troubleshooting-loki-entry-out-of-order-errors.adoc[leveloffset=+2]
21+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
1822

23+
[role="_additional-resources"]
24+
[id="additional-resources_cluster-logging-loki"]
1925
== Additional Resources
2026
* link:https://grafana.com/docs/loki/latest/logql/[Loki Query Language (LogQL) Documentation]
2127
* link:https://loki-operator.dev/docs/howto_connect_grafana.md/[Grafana Dashboard Documentation]
2228
* link:https://loki-operator.dev/docs/object_storage.md/[Loki Object Storage Documentation]
29+
* link:https://loki-operator.dev/docs/api.md/#loki-grafana-com-v1-IngestionLimitSpec[Loki Operator `IngestionLimitSpec` Documentation]
2330
* link:https://grafana.com/docs/loki/latest/operations/storage/schema/#changing-the-schema[Loki Storage Schema Documentation]

‎modules/cluster-logging-forwarding-lokistack.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
[id="cluster-logging-forwarding-lokistack_{context}"]
55
= Forwarding logs to LokiStack
66

7-
To configure log forwarding to the LokiStack gateway, you must create a ClusterLogging custom resource (CR).
7+
To configure log forwarding to the LokiStack gateway, you must create a `ClusterLogging` custom resource (CR).
88

99
.Prerequisites
1010

11-
* {logging-title-uc}: 5.5 and later
12-
* `Loki Operator` Operator
11+
* The {logging-title-uc} version 5.5 or newer is installed on your cluster.
12+
* The Loki Operator is installed on your cluster.
1313
1414
.Procedure
1515

16-
. Create or edit a YAML file that defines the `ClusterLogging` custom resource (CR):
17-
16+
* Create a `ClusterLogging` custom resource (CR):
17+
+
1818
[source,yaml]
1919
----
2020
apiVersion: logging.openshift.io/v1

‎modules/cluster-logging-loki-deploy.adoc‎

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ stringData:
7474
region: eu-central-1
7575
----
7676
+
77-
. Create the `LokiStack` custom resource:
77+
. Create the `LokiStack` custom resource (CR):
7878
+
7979
[source,yaml]
8080
----
@@ -96,16 +96,16 @@ spec:
9696
tenants:
9797
mode: openshift-logging
9898
----
99-
<1> Or `gp2-csi`.
100-
+
101-
.. Apply the configuration:
99+
<1> Or `gp2-csi`.
100+
101+
. Apply the `LokiStack` CR:
102102
+
103103
[source,terminal]
104104
----
105-
oc apply -f logging-loki.yaml
105+
$ oc apply -f logging-loki.yaml
106106
----
107-
+
108-
. Create or edit a `ClusterLogging` CR:
107+
108+
. Create a `ClusterLogging` custom resource (CR):
109109
+
110110
[source,yaml]
111111
----
@@ -123,14 +123,14 @@ spec:
123123
collection:
124124
type: vector
125125
----
126-
+
127-
.. Apply the configuration:
126+
127+
. Apply the `ClusterLogging` CR:
128128
+
129129
[source,terminal]
130130
----
131-
oc apply -f cr-lokistack.yaml
131+
$ oc apply -f cr-lokistack.yaml
132132
----
133-
+
133+
134134
. Enable the RedHat OpenShift Logging Console Plugin:
135135
ifndef::openshift-rosa,openshift-dedicated[]
136136
.. In the {product-title} web console, click *Operators* -> *Installed Operators*.
@@ -140,11 +140,6 @@ ifdef::openshift-rosa,openshift-dedicated[]
140140
endif::[]
141141
.. Select the *RedHat OpenShift Logging* Operator.
142142
.. Under Console plugin, click *Disabled*.
143-
.. Select *Enable* and then *Save*. This change will restart the 'openshift-console' pods.
143+
.. Select *Enable* and then *Save*. This change restarts the `openshift-console` pods.
144144
.. After the pods restart, you will receive a notification that a web console update is available, prompting you to refresh.
145-
.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* will be available to you.
146-
147-
[NOTE]
148-
====
149-
This plugin is only available on {product-title} 4.10 and later.
150-
====
145+
.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* is available.

‎modules/cluster-logging-troubleshooting-loki-entry-out-of-order-errors.adoc‎

Lines changed: 0 additions & 137 deletions
This file was deleted.

modules/cluster-logging-loki-about.adoc renamed to modules/loki-deployment-sizing.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
// Module is included in the following assemblies:
22
//cluster-logging-loki.adoc
3-
:_content-type: CONCEPT
4-
[id="about-logging-loki_{context}"]
5-
= About the LokiStack
6-
7-
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.
83

9-
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].
4+
:_content-type: CONCEPT
5+
[id="loki-deployment-sizing_{context}"]
6+
= Deployment Sizing
107

11-
[id="deployment-sizing_{context}"]
12-
== Deployment Sizing
138
Sizing for Loki follows the format of `N<x>._<size>_` where the value `<N>` is number of instances and `<size>` specifies performance capabilities.
149

1510
[NOTE]
1611
====
17-
1x.extra-small is for demo purposes only, and is not supported.
12+
1x.extra-small is for demo purposes only, and is not supported.
1813
====
1914

2015
.Loki Sizing

0 commit comments

Comments
 (0)