Skip to content

Commit 7dbeff1

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #94056 from gabriel-rh/migrate-old-content-log-storage
OBSDOCS-1972 migrate old content - add in log_storage folder
2 parents c53fb2f + 761173a commit 7dbeff1

File tree

9 files changed

+223
-0
lines changed

9 files changed

+223
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,15 @@ Topics:
6666
File: cluster-logging-collector
6767
- Name: Collecting and storing Kubernetes events
6868
File: cluster-logging-eventrouter
69+
---
70+
Name: Log storage
71+
Dir: log_storage
72+
Topics:
73+
- Name: About log storage
74+
File: about-log-storage
75+
- Name: Installing log storage
76+
File: installing-log-storage
77+
- Name: Configuring the LokiStack log store
78+
File: cluster-logging-loki
79+
- Name: Configuring the Elasticsearch log store
80+
File: logging-config-es-store

‎log_storage/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

‎log_storage/about-log-storage.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="about-log-storage"]
4+
= About log storage
5+
:context: about-log-storage
6+
7+
toc::[]
8+
9+
You can use an internal Loki or Elasticsearch log store on your cluster for storing logs, or you can use a xref:../log_collection_forwarding/configuring-log-forwarding.adoc#logging-create-clf_configuring-log-forwarding[`ClusterLogForwarder` custom resource (CR)] to forward logs to an external store.
10+
11+
[id="log-storage-overview-types"]
12+
== Log storage types
13+
14+
Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as an alternative to Elasticsearch as a log store for the {logging}.
15+
16+
Elasticsearch indexes incoming log records completely during ingestion. Loki only indexes a few fixed labels during ingestion and defers more complex parsing until after the logs have been stored. This means Loki can collect logs more quickly.
17+
18+
include::modules/cluster-logging-about-es-logstore.adoc[leveloffset=+2]
19+
20+
[id="log-storage-overview-querying"]
21+
== Querying log stores
22+
23+
You can query Loki by using the link:https://grafana.com/docs/loki/latest/logql/[LogQL log query language].
24+
25+
[role="_additional-resources"]
26+
[id="additional-resources_log-storage-overview"]
27+
== Additional resources
28+
* link:https://grafana.com/docs/loki/latest/get-started/components/[Loki components documentation]
29+
* link:https://loki-operator.dev/docs/object_storage.md/[Loki Object Storage documentation]

‎log_storage/cluster-logging-loki.adoc

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-loki
3+
[id="cluster-logging-loki"]
4+
= Configuring the LokiStack log store
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
In {logging} documentation, _LokiStack_ refers to the {logging} supported combination of Loki and web proxy with {ocp-product-title} authentication integration. LokiStack's proxy uses {ocp-product-title} authentication to enforce multi-tenancy. _Loki_ refers to the log store as either the individual component or an external store.
10+
11+
include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+1]
12+
13+
include::modules/logging-loki-restart-hardening.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
* link:https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#pod-disruption-budgets[Pod disruption budgets Kubernetes documentation]
18+
19+
include::modules/logging-loki-reliability-hardening.adoc[leveloffset=+1]
20+
21+
[role="_additional-resources"]
22+
.Additional resources
23+
* link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#podantiaffinity-v1-core[`PodAntiAffinity` v1 core Kubernetes documentation]
24+
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity[Assigning Pods to Nodes Kubernetes documentation]
25+
* link:https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-pod-affinity.adoc#nodes-scheduler-pod-affinity[Placing pods relative to other pods using affinity and anti-affinity rules]
26+
27+
include::modules/logging-loki-zone-aware-rep.adoc[leveloffset=+1]
28+
29+
include::modules/logging-loki-zone-fail-recovery.adoc[leveloffset=+2]
30+
31+
[role="_additional-resources"]
32+
.Additional resources
33+
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#spread-constraint-definition[Topology spread constraints Kubernetes documentation]
34+
* link:https://kubernetes.io/docs/setup/best-practices/multiple-zones/#storage-access-for-zones[Kubernetes storage documentation].
35+
36+
37+
* xref:link:https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-pod-topology-spread-constraints.adoc#nodes-scheduler-pod-topology-spread-constraints-configuring[Controlling pod placement by using pod topology spread constraints]
38+
39+
40+
include::modules/logging-loki-log-access.adoc[leveloffset=+1,tag=!NetObservMode]
41+
42+
[role="_additional-resources"]
43+
.Additional resources
44+
45+
46+
* link:https://docs.openshift.com/container-platform/latest/authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions]
47+
48+
49+
include::modules/logging-loki-retention.adoc[leveloffset=+1]
50+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+1]
51+
include::modules/logging-loki-memberlist-ip.adoc[leveloffset=+1]
52+
53+
[role="_additional-resources"]
54+
[id="additional-resources_cluster-logging-loki"]
55+
== Additional resources
56+
* link:https://grafana.com/docs/loki/latest/get-started/components/[Loki components documentation]
57+
* link:https://grafana.com/docs/loki/latest/logql/[Loki Query Language (LogQL) documentation]
58+
* link:https://loki-operator.dev/docs/howto_connect_grafana.md/[Grafana Dashboard documentation]
59+
* link:https://loki-operator.dev/docs/object_storage.md/[Loki Object Storage documentation]
60+
* link:https://loki-operator.dev/docs/api.md/#loki-grafana-com-v1-IngestionLimitSpec[{loki-op} `IngestionLimitSpec` documentation]
61+
* link:https://grafana.com/docs/loki/latest/operations/storage/schema/#changing-the-schema[Loki Storage Schema documentation]

‎log_storage/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

‎log_storage/installing-log-storage.adoc

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="installing-log-storage"]
4+
= Installing log storage
5+
:context: installing-log-storage
6+
7+
toc::[]
8+
9+
You can use the {oc-first} or the {ocp-product-title} web console to deploy a log store on your {ocp-product-title} cluster.
10+
11+
include::snippets/logging-elastic-dep-snip.adoc[]
12+
13+
[id="installing-log-storage-loki"]
14+
== Deploying a Loki log store
15+
16+
You can use the {loki-op} to deploy an internal Loki log store on your {ocp-product-title} cluster.
17+
After install the {loki-op}, you must configure Loki object storage by creating a secret, and create a `LokiStack` custom resource (CR).
18+
19+
include::modules/loki-deployment-sizing.adoc[leveloffset=+2]
20+
21+
// Loki console install
22+
include::modules/logging-loki-gui-install.adoc[leveloffset=+2]
23+
include::modules/loki-create-object-storage-secret-console.adoc[leveloffset=+2]
24+
25+
[role="_additional-resources"]
26+
.Additional resources
27+
* xref:../log_storage/installing-log-storage.adoc#logging-loki-storage_installing-log-storage[Loki object storage]
28+
29+
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 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].
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=+2]
41+
42+
include::modules/logging-create-loki-cr-console.adoc[leveloffset=+2,tag=!pre-5.9]
43+
44+
// Loki CLI install
45+
include::modules/logging-loki-cli-install.adoc[leveloffset=+2]
46+
include::modules/loki-create-object-storage-secret-cli.adoc[leveloffset=+2]
47+
48+
[role="_additional-resources"]
49+
.Additional resources
50+
* xref:../log_storage/installing-log-storage.adoc#logging-loki-storage_installing-log-storage[Loki object storage]
51+
52+
include::modules/logging-create-loki-cr-cli.adoc[leveloffset=+2,tag=!pre-5.9]
53+
54+
// Loki object storage
55+
include::modules/logging-loki-storage.adoc[leveloffset=+1]
56+
57+
// create object storage
58+
include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
59+
include::modules/logging-loki-storage-azure.adoc[leveloffset=+2]
60+
include::modules/logging-loki-storage-gcp.adoc[leveloffset=+2]
61+
include::modules/logging-loki-storage-minio.adoc[leveloffset=+2]
62+
include::modules/logging-loki-storage-odf.adoc[leveloffset=+2]
63+
include::modules/logging-loki-storage-swift.adoc[leveloffset=+2]
64+
65+
[id="installing-log-storage-es"]
66+
== Deploying an Elasticsearch log store
67+
68+
You can use the {es-op} to deploy an internal Elasticsearch log store on your {ocp-product-title} cluster.
69+
70+
include::snippets/logging-elastic-dep-snip.adoc[]
71+
include::modules/logging-es-storage-considerations.adoc[leveloffset=+2]
72+
include::modules/logging-install-es-operator.adoc[leveloffset=+2]
73+
include::modules/cluster-logging-deploy-es-cli.adoc[leveloffset=+2]
74+
75+
// configuring log store in the clusterlogging CR
76+
include::modules/configuring-log-storage-cr.adoc[leveloffset=+1]

‎log_storage/logging-config-es-store.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="logging-config-es-store"]
3+
= Configuring the Elasticsearch log store
4+
include::_attributes/common-attributes.adoc[]
5+
:context: logging-config-es-store
6+
7+
toc::[]
8+
9+
You can use Elasticsearch 6 to store and organize log data.
10+
11+
You can make modifications to your log store, including:
12+
13+
* Storage for your Elasticsearch cluster
14+
* Shard replication across data nodes in the cluster, from full replication to no replication
15+
* External access to Elasticsearch data
16+
17+
include::modules/configuring-log-storage-cr.adoc[leveloffset=+1]
18+
19+
include::modules/cluster-logging-elasticsearch-audit.adoc[leveloffset=+1]
20+
21+
[role="_additional-resources"]
22+
.Additional resources
23+
* link:https://docs.openshift.com/container-platform/latest/observability/logging/log_collection_forwarding/log-forwarding.adoc#log-forwarding[About log collection and forwarding]
24+
25+
include::modules/cluster-logging-elasticsearch-retention.adoc[leveloffset=+1]
26+
27+
include::modules/cluster-logging-logstore-limits.adoc[leveloffset=+1]
28+
29+
include::modules/cluster-logging-elasticsearch-ha.adoc[leveloffset=+1]
30+
31+
include::modules/cluster-logging-elasticsearch-scaledown.adoc[leveloffset=+1]
32+
33+
include::modules/cluster-logging-elasticsearch-storage.adoc[leveloffset=+1]
34+
35+
include::modules/cluster-logging-elasticsearch-persistent-storage-empty.adoc[leveloffset=+1]
36+
37+
include::modules/cluster-logging-manual-rollout-rolling.adoc[leveloffset=+1]
38+
39+
include::modules/cluster-logging-elasticsearch-exposing.adoc[leveloffset=+1]
40+
41+
include::modules/cluster-logging-removing-unused-components-if-no-elasticsearch.adoc[leveloffset=+1]

‎log_storage/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎log_storage/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

0 commit comments

Comments
 (0)