Skip to content

Commit 0e0651b

Browse files
committed
OBSDOCS-152: Additional logging docs cleanup
1 parent 293708d commit 0e0651b

17 files changed

+30
-598
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2526,8 +2526,6 @@ Topics:
25262526
File: logging-5-5-administration
25272527
# - Name: Configuring Logging
25282528
# File: logging-5-5-configuration
2529-
# - Name: Logging Reference
2530-
# File: logging-5-5-reference
25312529
- Name: About Logging
25322530
File: cluster-logging
25332531
- Name: Installing Logging
Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
:_content-type: ASSEMBLY
2-
[id="logging-configuration-5-5"]
2+
[id="logging-5-5-configuration"]
33
= Configuring your logging deployment
44
include::_attributes/common-attributes.adoc[]
5-
:context: logging-5.5-configuration
5+
:context: logging-5-5-configuration
66

77
toc::[]
88

9-
include::snippets/logging-crs-by-operator-snip.adoc[]
10-
11-
include::snippets/logging-supported-config-snip.adoc[]
12-
139
include::modules/logging-multiline-except.adoc[leveloffset=+1]

logging/v5_5/logging-5-5-reference.adoc

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

logging/v5_6/logging-5-6-configuration.adoc

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,4 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::snippets/logging-crs-by-operator-snip.adoc[]
10-
11-
include::snippets/logging-supported-config-snip.adoc[]
12-
13-
include::modules/logging-loki-retention.adoc[leveloffset=+1]
14-
159
include::modules/logging-multiline-except.adoc[leveloffset=+1]

logging/v5_7/logging-5-7-configuration.adoc

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::snippets/logging-crs-by-operator-snip.adoc[]
10-
11-
include::snippets/logging-supported-config-snip.adoc[]
12-
13-
include::modules/logging-loki-retention.adoc[leveloffset=+1]
14-
159
include::modules/logging-multiline-except.adoc[leveloffset=+1]
1610

1711
include::modules/logging-loki-alerts.adoc[leveloffset=+1]

modules/cluster-logging-about.adoc

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,32 @@
1111
[id="cluster-logging-about_{context}"]
1212
= About deploying the {logging-title}
1313

14-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
15-
{product-title} cluster administrators can deploy the {logging} using the {product-title} web console or CLI to install the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator. When the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The Operators are responsible for deploying, upgrading, and maintaining the {logging}.
16-
endif::openshift-enterprise,openshift-webscale,openshift-origin[]
17-
18-
The `ClusterLogging` CR defines a complete {logging} environment that includes all the components of the logging stack to collect, store and visualize logs. The Red Hat OpenShift Logging Operator watches the {logging} CR and adjusts the logging deployment accordingly.
14+
Administrators can deploy the {logging} by using the {product-title} web console or the {oc-first} to install the {logging} Operators. The Operators are responsible for deploying, upgrading, and maintaining the {logging}.
1915

2016
Administrators and application developers can view the logs of the projects for which they have view access.
17+
18+
[id="cluster-logging-about-custom-resources_{context}"]
19+
== Logging custom resources
20+
21+
You can configure your {logging} deployment with custom resource (CR) YAML files implemented by each Operator.
22+
23+
*Red Hat Openshift Logging Operator*:
24+
25+
* `ClusterLogging` (CL) - After the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The `ClusterLogging` CR deploys the collector and forwarder, which currently are both implemented by a daemonset running on each node. The Red Hat OpenShift Logging Operator watches the `ClusterLogging` CR and adjusts the logging deployment accordingly.
26+
27+
* `ClusterLogForwarder` (CLF) - Generates collector configuration to forward logs per user configuration.
28+
29+
*Loki Operator*:
30+
31+
* `LokiStack` - Controls the Loki cluster as log store and the web proxy with OpenShift Container Platform authentication integration to enforce multi-tenancy.
32+
33+
*OpenShift Elasticsearch Operator*:
34+
35+
[NOTE]
36+
====
37+
These CRs are generated and managed by the Red Hat OpenShift Elasticsearch Operator. Manual changes cannot be made without being overwritten by the Operator.
38+
====
39+
40+
* `ElasticSearch` - Configure and deploy an Elasticsearch instance as the default log store.
41+
42+
* `Kibana` - Configure and deploy Kibana instance to search, query and view logs.

modules/cluster-logging-release-notes-5.3.z.adoc

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

modules/cluster-logging-rn-5.3.10.adoc

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

modules/cluster-logging-rn-5.3.11.adoc

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

modules/cluster-logging-rn-5.3.12.adoc

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

0 commit comments

Comments
 (0)