Skip to content

Commit abef6a0

Browse files
authored
Merge pull request #67450 from abrennan89/OBSDOCS-93
OBSDOCS-675: Clean up logging installation CLI docs
2 parents 792db80 + 72d20da commit abef6a0

12 files changed

+367
-643
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
:logging-uc: Logging
2828
:clo: Red Hat OpenShift Logging Operator
2929
:loki-op: Loki Operator
30-
:es-op: Elasticsearch Operator
30+
:es-op: OpenShift Elasticsearch Operator
3131
:logging-sd: Red Hat OpenShift Logging
3232
:log-plug: logging Console Plugin
3333
//

_attributes/common-attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ endif::[]
145145
:logging-uc: Logging subsystem
146146
:clo: Red Hat OpenShift Logging Operator
147147
:loki-op: Loki Operator
148-
:es-op: Elasticsearch Operator
148+
:es-op: OpenShift Elasticsearch Operator
149149
:log-plug: logging subsystem Console plugin
150150
//serverless
151151
:ServerlessProductName: OpenShift Serverless

logging/cluster-logging-deploying.adoc

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
You can install the {logging-title} by deploying the {clo}. The {clo} creates and manages the components of the logging stack.
10+
You can deploy the {logging-title} by installing the {clo}. The {clo} creates and manages the components of the logging stack.
11+
12+
include::snippets/logging-compatibility-snip.adoc[]
1113

1214
[IMPORTANT]
1315
====
14-
For new installations, Vector and LokiStack are recommended. Documentation for logging is in the process of being updated to reflect these underlying component changes.
16+
For new installations, use Vector and LokiStack. Elasticsearch and Fluentd are deprecated and are planned to be removed in a future release.
1517
====
1618

1719
ifdef::openshift-origin[]
@@ -22,31 +24,24 @@ ifdef::openshift-origin[]
2224
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in _Configuring {product-title} to use Red Hat Operators_.
2325
endif::[]
2426

25-
include::snippets/logging-fluentd-dep-snip.adoc[]
26-
2727
//Installing the Red Hat OpenShift Logging Operator via webconsole
2828
include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
29+
include::modules/create-cluster-logging-cr-console.adoc[leveloffset=+1]
2930

30-
[role="_additional-resources"]
31-
.Additional resources
32-
* xref:../logging/log_collection_forwarding/cluster-logging-collector.adoc#cluster-logging-collector[Configuring the logging collector]
33-
34-
include::modules/logging-clo-gui-install.adoc[leveloffset=+1]
35-
36-
include::modules/logging-clo-cli-install.adoc[leveloffset=+1]
37-
31+
// Install using CLI
3832
include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
39-
40-
[role="_additional-resources"]
41-
.Additional resources
42-
* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub]
43-
* xref:../logging/log_storage/logging-config-es-store.adoc#cluster-logging-removing-unused-components-if-no-elasticsearch_logging-config-es-store[Removing unused components if you do not use the default Elasticsearch log store]
33+
include::modules/create-cluster-logging-cli.adoc[leveloffset=+1]
4434

4535
[id="cluster-logging-deploying-postinstallation"]
4636
== Postinstallation tasks
4737

4838
After you have installed the {clo}, you can configure your deployment by creating and modifying a `ClusterLogging` custom resource (CR).
4939

40+
[TIP]
41+
====
42+
If you are not using the Elasticsearch log store, you can remove the internal Elasticsearch `logStore` and Kibana `visualization` components from the `ClusterLogging` custom resource (CR). Removing these components is optional but saves resources. See xref:../logging/log_storage/logging-config-es-store.adoc#cluster-logging-removing-unused-components-if-no-elasticsearch_logging-config-es-store[Removing unused components if you do not use the Elasticsearch log store].
43+
====
44+
5045
include::modules/cluster-logging-about-crd.adoc[leveloffset=+2]
5146
include::modules/configuring-log-storage-cr.adoc[leveloffset=+2]
5247
include::modules/configuring-logging-collector.adoc[leveloffset=+2]

logging/log_storage/installing-log-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ You can use the {es-op} to deploy an internal Elasticsearch log store on your {p
5757
include::snippets/logging-elastic-dep-snip.adoc[]
5858
include::modules/logging-es-storage-considerations.adoc[leveloffset=+2]
5959
include::modules/logging-install-es-operator.adoc[leveloffset=+2]
60-
include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+2]
60+
include::modules/cluster-logging-deploy-es-cli.adoc[leveloffset=+2]
6161

6262
// configuring log store in the clusterlogging CR
6363
include::modules/configuring-log-storage-cr.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)