Skip to content

Commit bc365df

Browse files
Merge pull request #83592 from libander/OBSDOCS-1374
OBSCDOCS-1374 - Loki Statement of Purpose addition to Logging 6.0 docs.
2 parents d1141bf + af45bd3 commit bc365df

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

modules/log6x-loki-retention.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,3 @@ spec:
112112
$ oc apply -f <filename>.yaml
113113
----
114114
+
115-
[NOTE]
116-
====
117-
This is not for managing the retention for stored logs. Global retention periods for stored logs to a supported maximum of 30 days is configured with your object storage.
118-
====

modules/logging-loki-retention.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Module included in the following assemblies:
2-
//
2+
//
33
// * observability/logging/log_storage/cluster-logging-loki.adoc
44

55
:_mod-docs-content-type: PROCEDURE
@@ -26,7 +26,7 @@ metadata:
2626
name: logging-loki
2727
namespace: openshift-logging
2828
spec:
29-
limits:
29+
limits:
3030
global: <1>
3131
retention: <2>
3232
days: 20
@@ -105,8 +105,3 @@ spec:
105105
----
106106
$ oc apply -f <filename>.yaml
107107
----
108-
109-
[NOTE]
110-
====
111-
This is not for managing the retention for stored logs. Global retention periods for stored logs to a supported maximum of 30 days is configured with your object storage.
112-
====

observability/logging/cluster-logging-support.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ toc::[]
88

99
include::snippets/logging-supported-config-snip.adoc[]
1010
include::snippets/logging-compatibility-snip.adoc[]
11+
include::snippets/log6x-loki-statement-snip.adoc[]
1112

1213
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
1314

observability/logging/logging-6.0/log6x-loki.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="log6x-loki"]
33
= Storing logs with LokiStack
4-
include::_attributes/common-attributes.adoc[]
4+
include::_attributes/common-attributes.adoc[leveloffset=+1]
55
:context: logging-6x
66

77
toc::[]
88

99
You can configure a `LokiStack` CR to store application, audit, and infrastructure-related logs.
1010

11+
include::snippets/log6x-loki-statement-snip.adoc[leveloffset=+1]
12+
1113
[id="prerequisites_{context}"]
1214
== Prerequisites
1315

1416
* You have installed the {loki-op} by using the CLI or web console.
1517
* You have a `serviceAccount` in the same namespace in which you create the `ClusterLogForwarder`.
1618
* The `serviceAccount` is assigned `collect-audit-logs`, `collect-application-logs`, and `collect-infrastructure-logs` cluster roles.
1719

18-
=== Core Setup and Configuration
20+
[id="setup_{context}"]
21+
== Core Setup and Configuration
1922
*Role-based access controls, basic monitoring, and pod placement to deploy Loki.*
2023

2124
include::modules/log6x-loki-rbac-rules-perms.adoc[leveloffset=+1]
@@ -24,14 +27,16 @@ include::modules/log6x-loki-memberlist-ip.adoc[leveloffset=+1]
2427
include::modules/log6x-loki-retention.adoc[leveloffset=+1]
2528
include::modules/log6x-loki-pod-placement.adoc[leveloffset=+1]
2629

27-
=== Enhanced Reliability and Performance
30+
[id="performance_{context}"]
31+
== Enhanced Reliability and Performance
2832
*Configurations to ensure Loki’s reliability and efficiency in production.*
2933

3034
include::modules/log6x-identity-federation.adoc[leveloffset=+1]
3135
include::modules/log6x-loki-reliability-hardening.adoc[leveloffset=+1]
3236
include::modules/log6x-loki-restart-hardening.adoc[leveloffset=+1]
3337

34-
=== Advanced Deployment and Scalability
38+
[id="advanced_{context}"]
39+
== Advanced Deployment and Scalability
3540
*Specialized configurations for high availability, scalability, and error handling.*
3641

3742
include::modules/log6x-loki-zone-aware-rep.adoc[leveloffset=+1]
Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
// Text snippet included in the following assemblies:
2-
// * observability/logging/log_storage/about-log-storage.adoc
3-
//
2+
// * observability/logging/logging-6.0/log6x-loki.adoc
43
// Text snippet included in the following modules:
54
//
65
//
76
:_mod-docs-content-type: SNIPPET
87

9-
Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a GA log store for {logging} {for} that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by OpenShift {logging-uc} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the {logging} {for} configuration of Loki has short-term storage, and is optimized for very recent queries. For long-term storage or queries over a long time period, users should look to log stores external to their cluster.
8+
Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a GA log store for {logging} {for} that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by OpenShift {logging-uc} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the {logging} {for} configuration of Loki has short-term storage, and is optimized for very recent queries.
9+
10+
[IMPORTANT]
11+
====
12+
For long-term storage or queries over a long time period, users should look to log stores external to their cluster. Loki sizing is only tested and supported for short term storage, for a maximum of 30 days.
13+
====

0 commit comments

Comments
 (0)