Skip to content
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

OBSDOCS-152: Additional logging docs cleanup #65906

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2523,8 +2523,6 @@ Topics:
File: logging-5-5-administration
# - Name: Configuring Logging
# File: logging-5-5-configuration
# - Name: Logging Reference
# File: logging-5-5-reference
- Name: About Logging
File: cluster-logging
- Name: Installing Logging
Expand Down
8 changes: 2 additions & 6 deletions logging/v5_5/logging-5-5-configuration.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
:_content-type: ASSEMBLY
[id="logging-configuration-5-5"]
[id="logging-5-5-configuration"]
= Configuring your logging deployment
include::_attributes/common-attributes.adoc[]
:context: logging-5.5-configuration
:context: logging-5-5-configuration

toc::[]

include::snippets/logging-crs-by-operator-snip.adoc[]

include::snippets/logging-supported-config-snip.adoc[]

include::modules/logging-multiline-except.adoc[leveloffset=+1]
7 changes: 0 additions & 7 deletions logging/v5_5/logging-5-5-reference.adoc

This file was deleted.

6 changes: 0 additions & 6 deletions logging/v5_6/logging-5-6-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,4 @@ include::_attributes/common-attributes.adoc[]

toc::[]

include::snippets/logging-crs-by-operator-snip.adoc[]

include::snippets/logging-supported-config-snip.adoc[]

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

include::modules/logging-multiline-except.adoc[leveloffset=+1]
6 changes: 0 additions & 6 deletions logging/v5_7/logging-5-7-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ include::_attributes/common-attributes.adoc[]

toc::[]

include::snippets/logging-crs-by-operator-snip.adoc[]

include::snippets/logging-supported-config-snip.adoc[]

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

include::modules/logging-multiline-except.adoc[leveloffset=+1]

include::modules/logging-loki-alerts.adoc[leveloffset=+1]
32 changes: 27 additions & 5 deletions modules/cluster-logging-about.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,32 @@
[id="cluster-logging-about_{context}"]
= About deploying the {logging-title}

ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
{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}.
endif::openshift-enterprise,openshift-webscale,openshift-origin[]

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.
Administrators can deploy the {logging} by using the {product-title} web console or CLI to install the {logging} Operators. The Operators are responsible for deploying, upgrading, and maintaining the {logging}.
abrennan89 marked this conversation as resolved.
Show resolved Hide resolved

Administrators and application developers can view the logs of the projects for which they have view access.

[id="cluster-logging-about-custom-resources_{context}"]
== Logging custom resources

You can configure your {logging} deployment with custom resource (CR) YAML files implemented by each Operator.

*Red Hat Openshift Logging Operator*:

* `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.

* `ClusterLogForwarder` (CLF) - Generates collector configuration to forward logs per user configuration.

*Loki Operator*:

* `LokiStack` - Controls the Loki cluster as log store and the web proxy with OpenShift Container Platform authentication integration to enforce multi-tenancy.

*OpenShift Elasticsearch Operator*:

[NOTE]
====
These CRs are generated and managed by the Red Hat OpenShift Elasticsearch Operator. Manual changes cannot be made without being overwritten by the Operator.
====

* `ElasticSearch` - Configure and deploy an Elasticsearch instance as the default log store.

* `Kibana` - Configure and deploy Kibana instance to search, query and view logs.
247 changes: 0 additions & 247 deletions modules/cluster-logging-release-notes-5.3.z.adoc

This file was deleted.

31 changes: 0 additions & 31 deletions modules/cluster-logging-rn-5.3.10.adoc

This file was deleted.

20 changes: 0 additions & 20 deletions modules/cluster-logging-rn-5.3.11.adoc

This file was deleted.

21 changes: 0 additions & 21 deletions modules/cluster-logging-rn-5.3.12.adoc

This file was deleted.

36 changes: 0 additions & 36 deletions modules/cluster-logging-rn-5.3.13.adoc

This file was deleted.

84 changes: 0 additions & 84 deletions modules/cluster-logging-rn-5.3.14.adoc

This file was deleted.