Skip to content

Commit 67889fe

Browse files
theashiottheashiot
committed
OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs
1 parent 42fc898 commit 67889fe

26 files changed

+140
-76
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Distros: openshift-logging
2525
Topics:
2626
- Name: Configuring log forwarding
2727
File: configuring-log-forwarding
28-
- Name: Configuring LokiStack storage
29-
File: configuring-lokistack-storage
28+
- Name: Configuring the log store
29+
File: configuring-the-log-store
3030
- Name: Configuring LokiStack for OTLP
3131
File: configuring-lokistack-otlp
3232
- Name: OpenTelemetry data model

‎configuring/configuring-lokistack-storage.adoc

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

‎configuring/configuring-the-log-store.adoc

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="configuring-lokistack-storage"]
4+
= Configuring the log store
5+
:context: configuring-the-log-store
6+
7+
toc::[]
8+
9+
You can configure a `LokiStack` custom resource (CR) to store application, audit, and infrastructure-related logs.
10+
11+
include::snippets/loki-statement-snip.adoc[leveloffset=+1]
12+
13+
// Loki sizing
14+
include::modules/loki-sizing.adoc[leveloffset=+1]
15+
16+
// Loki object storage
17+
include::modules/logging-loki-storage.adoc[leveloffset=+1]
18+
19+
// create object storage
20+
include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
21+
include::modules/logging-loki-storage-azure.adoc[leveloffset=+2]
22+
include::modules/logging-loki-storage-gcp.adoc[leveloffset=+2]
23+
include::modules/logging-loki-storage-minio.adoc[leveloffset=+2]
24+
include::modules/logging-loki-storage-odf.adoc[leveloffset=+2]
25+
include::modules/logging-loki-storage-swift.adoc[leveloffset=+2]
26+
27+
//Loki stirage STS
28+
[id="installing-log-storage-loki-sts"]
29+
=== Deploying a Loki log store on a cluster that uses short-term credentials
30+
31+
For some storage providers, you can use the Cloud Credential Operator utility (`ccoctl`) during installation to implement short-term credentials. These credentials are created and managed outside the {ocp-product-title} cluster. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/authentication_and_authorization/managing-cloud-provider-credentials#cco-short-term-creds[Manual mode with short-term credentials for components].
32+
33+
[NOTE]
34+
====
35+
Short-term credential authentication must be configured during a new installation of {loki-op}, on a cluster that uses this credentials strategy. You cannot configure an existing cluster that uses a different credentials strategy to use this feature.
36+
====
37+
38+
include::modules/logging-identity-federation.adoc[leveloffset=+3]
39+
40+
include::modules/logging-create-loki-cr-console.adoc[leveloffset=+3,tag=!pre-5.9]
41+
42+
include::modules/loki-create-object-storage-secret-cli.adoc[leveloffset=+3]
43+
44+
include::modules/logging-loki-log-access.adoc[leveloffset=+2,tag=!NetObservMode]
45+
46+
47+
include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+2]
48+
49+
//Enhanced reliability and performance
50+
[id="performance_{context}"]
51+
== Enhanced reliability and performance
52+
53+
Use the following configurations to ensure reliability and efficiency of Loki in production.
54+
55+
include::modules/loki-pod-placement.adoc[leveloffset=+2]
56+
57+
include::modules/logging-loki-reliability-hardening.adoc[leveloffset=+2]
58+
59+
include::modules/loki-retention.adoc[leveloffset=+2]
60+
61+
62+
include::modules/loki-memberlist-ip.adoc[leveloffset=+2]
63+
64+
include::modules/loki-restart-hardening.adoc[leveloffset=+2]
65+
66+
//Advanced deployment and scalability
67+
[id="advanced_{context}"]
68+
== Advanced deployment and scalability
69+
70+
To configure high availability, scalability, and error handling, use the following information.
71+
72+
include::modules/loki-zone-aware-replication.adoc[leveloffset=+2]
73+
include::modules/loki-zone-fail-recovery.adoc[leveloffset=+2]
74+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
75+
76+
//log based alerts
77+
[id="log-based-alerts_{context}"]
78+
== Log-based alerts
79+
80+
include::modules/loki-rbac-rules-permissions.adoc[leveloffset=+2]
81+
include::modules/enabling-loki-alerts.adoc[leveloffset=+2]

‎modules/enabling-loki-alerts.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: PROCEDURE
25
[id="logging-enabling-loki-alerts_{context}"]
36
= Creating a log-based alerting rule with Loki

‎modules/logging-create-loki-cr-console.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
// Module included in the following assemblies:
1+
// Module is included in the following assemblies:
22
//
3-
// * logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-create-loki-cr-console_{context}"]

‎modules/logging-creating-new-group-cluster-admin-user-role.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
// Module included in the following assemblies:
2-
3-
// * cluster-logging-loki.adoc
4-
// * network_observability/installing-operators.adoc
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
54

65
:_mod-docs-content-type: PROCEDURE
76
[id="logging-creating-new-group-cluster-admin-user-role_{context}"]

‎modules/logging-identity-federation.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
// Module included in the following assemblies:
2-
// * logging/log_storage/installing-log-storage.adoc
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
34

45
:_mod-docs-content-type: PROCEDURE
56
[id="logging-identity-federation_{context}"]

‎modules/logging-loki-log-access.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
// Module included in the following assemblies:
1+
// Module is included in the following assemblies:
22
//
3-
// * observability/network_observability/installing-operators.adoc
4-
// * logging/cluster-logging-loki.adoc
3+
// * configuring/configuring-the-log-storage.adoc
54

65
:_mod-docs-content-type: CONCEPT
76
[id="logging-loki-log-access_{context}"]
87
= Fine grained access for Loki logs
98

10-
In {logging} 5.8 and later, the {clo} does not grant all users access to logs by default. As an administrator, you must configure your users' access unless the Operator was upgraded and prior configurations are in place. Depending on your configuration and need, you can configure fine grain access to logs using the following:
9+
The {clo} does not grant all users access to logs by default. As an administrator, you must configure your users' access unless the Operator was upgraded and prior configurations are in place. Depending on your configuration and need, you can configure fine grain access to logs using the following:
1110

1211
* Cluster wide policies
1312
* Namespace scoped policies
@@ -120,4 +119,4 @@ spec:
120119
<1> Custom admin groups are only available in this mode.
121120
<2> Entering an empty list `[]` value for this field disables admin groups.
122121
<3> Overrides the default groups (`system:cluster-admins`, `cluster-admin`, `dedicated-admin`)
123-
// end::CustomAdmin[]
122+
// end::CustomAdmin[]

‎modules/logging-loki-reliability-hardening.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
// Module included in the following assemblies:
1+
// Module is included in the following assemblies:
22
//
3-
// * logging/cluster-logging-loki.adoc
4-
3+
// * configuring/configuring-the-log-storage.adoc
54
:_mod-docs-content-type: CONCEPT
65
[id="logging-loki-reliability-hardening_{context}"]
76
= Configuring Loki to tolerate node failure

‎modules/logging-loki-storage-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-loki-storage-aws_{context}"]

‎modules/logging-loki-storage-azure.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-loki-storage-azure_{context}"]

‎modules/logging-loki-storage-gcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-loki-storage-gcp_{context}"]

‎modules/logging-loki-storage-minio.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-loki-storage-minio_{context}"]

‎modules/logging-loki-storage-odf.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module is included in the following assemblies:
2-
// logging/cluster-logging-loki.adoc
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
34

45
:_mod-docs-content-type: PROCEDURE
56
[id="logging-loki-storage-odf_{context}"]

‎modules/logging-loki-storage-swift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-loki-storage-swift_{context}"]

‎modules/logging-loki-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module is included in the following assemblies:
22
//
3-
// * observability/logging/log_storage/installing-log-storage.adoc
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: CONCEPT
66
[id="logging-loki-storage_{context}"]

‎modules/loki-create-object-storage-secret-cli.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
// Module included in the following assemblies:
1+
// Module is included in the following assemblies:
22
//
3-
// * list assemblies
3+
// * configuring/configuring-the-log-storage.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="loki-create-object-storage-secret-cli_{context}"]

‎modules/loki-memberlist-ip.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: CONCEPT
25
[id="loki-memberlist-ip_{context}"]
36
= Configuring Loki to tolerate memberlist creation failure

‎modules/loki-pod-placement.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
4+
15
:_mod-docs-content-type: CONCEPT
26
[id="loki-pod-placement_{context}"]
37
= Loki pod placement

‎modules/loki-rate-limit-errors.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: PROCEDURE
25
[id="loki-rate-limit-errors_{context}"]
36
= Troubleshooting Loki rate limit errors

‎modules/loki-rbac-rules-permissions.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: REFERENCE
25
[id="loki-rbac-rules-permissions_{context}"]
36
= Authorizing LokiStack rules RBAC permissions

‎modules/loki-restart-hardening.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
4+
15
:_mod-docs-content-type: CONCEPT
26
[id="loki-restart-hardening_{context}"]
37
= LokiStack behavior during cluster restarts

‎modules/loki-retention.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: PROCEDURE
25
[id="loki-retention_{context}"]
36
= Enabling stream-based retention with Loki

‎modules/loki-sizing.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
4+
15
:_mod-docs-content-type: CONCEPT
26
[id="loki-sizing_{context}"]
37
= Loki deployment sizing

‎modules/loki-zone-aware-replication.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: CONCEPT
25
[id="loki-zone-aware-replication_{context}"]
36
= Zone aware data replication

‎modules/loki-zone-fail-recovery.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring/configuring-the-log-storage.adoc
14
:_mod-docs-content-type: PROCEDURE
25
[id="loki-zone-fail-recovery_{context}"]
36
= Recovering Loki pods from failed zones

0 commit comments

Comments
 (0)