Skip to content

Commit 1c2dbb8

Browse files
briandooleybriandooley
authored
Merge pull request #95027 from theashiot/OBSDOCS-1726-60
OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6…
2 parents 8a9468c + 8cc530c commit 1c2dbb8

25 files changed

+350
-29
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,12 @@ Distros: openshift-logging
2727
Topics:
2828
- Name: Configuring log forwarding
2929
File: configuring-log-forwarding
30-
- Name: Configuring LokiStack storage
31-
File: configuring-lokistack-storage
30+
- Name: Configuring the log store
31+
File: configuring-the-log-store
32+
#- Name: Configuring LokiStack for OTLP
33+
# File: configuring-lokistack-otlp
34+
#- Name: OpenTelemetry data model
35+
# File: opentelemetry-data-model
3236
---
3337
Name: Upgrading logging
3438
Dir: upgrading

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

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
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+
14+
// Loki sizing
15+
include::modules/loki-sizing.adoc[leveloffset=+1]
16+
17+
18+
// Loki object storage
19+
include::modules/logging-loki-storage.adoc[leveloffset=+1]
20+
21+
// create object storage
22+
include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
23+
include::modules/logging-loki-storage-azure.adoc[leveloffset=+2]
24+
include::modules/logging-loki-storage-gcp.adoc[leveloffset=+2]
25+
include::modules/logging-loki-storage-minio.adoc[leveloffset=+2]
26+
include::modules/logging-loki-storage-odf.adoc[leveloffset=+2]
27+
include::modules/logging-loki-storage-swift.adoc[leveloffset=+2]
28+
29+
//Loki stirage STS
30+
[id="installing-log-storage-loki-sts"]
31+
=== Deploying a Loki log store on a cluster that uses short-term credentials
32+
33+
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].
34+
35+
[NOTE]
36+
====
37+
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.
38+
====
39+
40+
include::modules/logging-identity-federation.adoc[leveloffset=+3]
41+
42+
include::modules/logging-create-loki-cr-console.adoc[leveloffset=+3,tag=!pre-5.9]
43+
44+
include::modules/loki-create-object-storage-secret-cli.adoc[leveloffset=+3]
45+
46+
include::modules/logging-loki-log-access.adoc[leveloffset=+2,tag=!NetObservMode]
47+
48+
49+
include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+2]
50+
51+
//Enhanced reliability and performance
52+
[id="performance_{context}"]
53+
== Enhanced reliability and performance
54+
55+
Use the following configurations to ensure reliability and efficiency of Loki in production.
56+
57+
include::modules/loki-pod-placement.adoc[leveloffset=+2]
58+
59+
include::modules/logging-loki-reliability-hardening.adoc[leveloffset=+2]
60+
61+
include::modules/loki-retention.adoc[leveloffset=+2]
62+
63+
64+
include::modules/loki-memberlist-ip.adoc[leveloffset=+2]
65+
66+
include::modules/loki-restart-hardening.adoc[leveloffset=+2]
67+
68+
//Advanced deployment and scalability
69+
[id="advanced_{context}"]
70+
== Advanced deployment and scalability
71+
72+
To configure high availability, scalability, and error handling, use the following information.
73+
74+
include::modules/loki-zone-aware-replication.adoc[leveloffset=+2]
75+
include::modules/loki-zone-fail-recovery.adoc[leveloffset=+2]
76+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
77+
78+
//log based alerts
79+
[id="log-based-alerts_{context}"]
80+
== Log-based alerts
81+
82+
include::modules/loki-rbac-rules-permissions.adoc[leveloffset=+2]
83+
include::modules/enabling-loki-alerts.adoc[leveloffset=+2]

‎modules/enabling-loki-alerts.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-store.adoc
4+
15
:_mod-docs-content-type: PROCEDURE
26
[id="logging-enabling-loki-alerts_{context}"]
37
= 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-store.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-store.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-store.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-store.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 & 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/cluster-logging-loki.adoc
3+
// * configuring/configuring-the-log-store.adoc
44

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

‎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-store.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-store.adoc
44

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

0 commit comments

Comments
 (0)