Skip to content

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #95028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: standalone-logging-docs-6.1
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Distros: openshift-logging
Topics:
- Name: Configuring log forwarding
File: configuring-log-forwarding
- Name: Configuring LokiStack storage
File: configuring-lokistack-storage
- Name: Configuring the log store
File: configuring-the-log-store
- Name: Configuring LokiStack for OTLP
File: configuring-lokistack-otlp
- Name: OpenTelemetry data model
Expand Down
46 changes: 0 additions & 46 deletions configuring/configuring-lokistack-storage.adoc

This file was deleted.

83 changes: 83 additions & 0 deletions configuring/configuring-the-log-store.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/common-attributes.adoc[]
[id="configuring-lokistack-storage"]
= Configuring the log store
:context: configuring-the-log-store

toc::[]

You can configure a `LokiStack` custom resource (CR) to store application, audit, and infrastructure-related logs.

include::snippets/loki-statement-snip.adoc[leveloffset=+1]


// Loki sizing
include::modules/loki-sizing.adoc[leveloffset=+1]


// Loki object storage
include::modules/logging-loki-storage.adoc[leveloffset=+1]

// create object storage
include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
include::modules/logging-loki-storage-azure.adoc[leveloffset=+2]
include::modules/logging-loki-storage-gcp.adoc[leveloffset=+2]
include::modules/logging-loki-storage-minio.adoc[leveloffset=+2]
include::modules/logging-loki-storage-odf.adoc[leveloffset=+2]
include::modules/logging-loki-storage-swift.adoc[leveloffset=+2]

//Loki stirage STS
[id="installing-log-storage-loki-sts"]
=== Deploying a Loki log store on a cluster that uses short-term credentials

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].

[NOTE]
====
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.
====

include::modules/logging-identity-federation.adoc[leveloffset=+3]

include::modules/logging-create-loki-cr-console.adoc[leveloffset=+3,tag=!pre-5.9]

include::modules/loki-create-object-storage-secret-cli.adoc[leveloffset=+3]

include::modules/logging-loki-log-access.adoc[leveloffset=+2,tag=!NetObservMode]


include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+2]

//Enhanced reliability and performance
[id="performance_{context}"]
== Enhanced reliability and performance

Use the following configurations to ensure reliability and efficiency of Loki in production.

include::modules/loki-pod-placement.adoc[leveloffset=+2]

include::modules/logging-loki-reliability-hardening.adoc[leveloffset=+2]

include::modules/loki-retention.adoc[leveloffset=+2]


include::modules/loki-memberlist-ip.adoc[leveloffset=+2]

include::modules/loki-restart-hardening.adoc[leveloffset=+2]

//Advanced deployment and scalability
[id="advanced_{context}"]
== Advanced deployment and scalability

To configure high availability, scalability, and error handling, use the following information.

include::modules/loki-zone-aware-replication.adoc[leveloffset=+2]
include::modules/loki-zone-fail-recovery.adoc[leveloffset=+2]
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]

//log based alerts
[id="log-based-alerts_{context}"]
== Log-based alerts

include::modules/loki-rbac-rules-permissions.adoc[leveloffset=+2]
include::modules/enabling-loki-alerts.adoc[leveloffset=+2]
4 changes: 4 additions & 0 deletions modules/enabling-loki-alerts.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-enabling-loki-alerts_{context}"]
= Creating a log-based alerting rule with Loki
Expand Down
4 changes: 2 additions & 2 deletions modules/logging-create-loki-cr-console.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
// Module is included in the following assemblies:
//
// * logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-create-loki-cr-console_{context}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Module included in the following assemblies:

// * cluster-logging-loki.adoc
// * network_observability/installing-operators.adoc
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-creating-new-group-cluster-admin-user-role_{context}"]
Expand Down
5 changes: 3 additions & 2 deletions modules/logging-identity-federation.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Module included in the following assemblies:
// * logging/log_storage/installing-log-storage.adoc
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-identity-federation_{context}"]
Expand Down
9 changes: 4 additions & 5 deletions modules/logging-loki-log-access.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
// Module included in the following assemblies:
// Module is included in the following assemblies:
//
// * observability/network_observability/installing-operators.adoc
// * logging/cluster-logging-loki.adoc
// * configuring/configuring-the-log-store.adoc

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

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:
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:

* Cluster wide policies
* Namespace scoped policies
Expand Down Expand Up @@ -120,4 +119,4 @@ spec:
<1> Custom admin groups are only available in this mode.
<2> Entering an empty list `[]` value for this field disables admin groups.
<3> Overrides the default groups (`system:cluster-admins`, `cluster-admin`, `dedicated-admin`)
// end::CustomAdmin[]
// end::CustomAdmin[]
4 changes: 2 additions & 2 deletions modules/logging-loki-reliability-hardening.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
// Module is included in the following assemblies:
//
// * logging/cluster-logging-loki.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="logging-loki-reliability-hardening_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage-aws.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-aws_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage-azure.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-azure_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage-gcp.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-gcp_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage-minio.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-minio_{context}"]
Expand Down
3 changes: 2 additions & 1 deletion modules/logging-loki-storage-odf.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Module is included in the following assemblies:
// logging/cluster-logging-loki.adoc
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-odf_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage-swift.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-loki-storage-swift_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/logging-loki-storage.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module is included in the following assemblies:
//
// * observability/logging/log_storage/installing-log-storage.adoc
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="logging-loki-storage_{context}"]
Expand Down
4 changes: 2 additions & 2 deletions modules/loki-create-object-storage-secret-cli.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
// Module is included in the following assemblies:
//
// * list assemblies
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="loki-create-object-storage-secret-cli_{context}"]
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-memberlist-ip.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="loki-memberlist-ip_{context}"]
= Configuring Loki to tolerate memberlist creation failure
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-pod-placement.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="loki-pod-placement_{context}"]
= Loki pod placement
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-rate-limit-errors.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="loki-rate-limit-errors_{context}"]
= Troubleshooting Loki rate limit errors
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-rbac-rules-permissions.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: REFERENCE
[id="loki-rbac-rules-permissions_{context}"]
= Authorizing LokiStack rules RBAC permissions
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-restart-hardening.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="loki-restart-hardening_{context}"]
= LokiStack behavior during cluster restarts
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-retention.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="loki-retention_{context}"]
= Enabling stream-based retention with Loki
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-sizing.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-storage.adoc

:_mod-docs-content-type: CONCEPT
[id="loki-sizing_{context}"]
= Loki deployment sizing
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-zone-aware-replication.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: CONCEPT
[id="loki-zone-aware-replication_{context}"]
= Zone aware data replication
Expand Down
4 changes: 4 additions & 0 deletions modules/loki-zone-fail-recovery.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Module is included in the following assemblies:
//
// * configuring/configuring-the-log-store.adoc

:_mod-docs-content-type: PROCEDURE
[id="loki-zone-fail-recovery_{context}"]
= Recovering Loki pods from failed zones
Expand Down