Skip to content

Commit dae433a

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

File tree

4 files changed

+85
-53
lines changed

4 files changed

+85
-53
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.
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 CCO utility (`ccoctl`) during installation to implement short-term credentials. These credentials are created and managed outside the {ocp-product-title} cluster. link:https://docs.openshift.com/container-platform/latest/authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#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/logging-loki-log-access.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="logging-loki-log-access_{context}"]
88
= Fine grained access for Loki logs
99

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:
10+
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:
1111

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

0 commit comments

Comments
 (0)