Skip to content

Commit

Permalink
OBSDOCS-93: Clean up logging installation CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abrennan89 committed Dec 18, 2023
1 parent 258a0d2 commit 72d20da
Show file tree
Hide file tree
Showing 12 changed files with 367 additions and 643 deletions.
2 changes: 1 addition & 1 deletion _attributes/attributes-openshift-dedicated.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
:logging-uc: Logging
:clo: Red Hat OpenShift Logging Operator
:loki-op: Loki Operator
:es-op: Elasticsearch Operator
:es-op: OpenShift Elasticsearch Operator
:logging-sd: Red Hat OpenShift Logging
:log-plug: logging Console Plugin
//
Expand Down
2 changes: 1 addition & 1 deletion _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ endif::[]
:logging-uc: Logging subsystem
:clo: Red Hat OpenShift Logging Operator
:loki-op: Loki Operator
:es-op: Elasticsearch Operator
:es-op: OpenShift Elasticsearch Operator
:log-plug: logging subsystem Console plugin
//serverless
:ServerlessProductName: OpenShift Serverless
Expand Down
29 changes: 12 additions & 17 deletions logging/cluster-logging-deploying.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

You can install the {logging-title} by deploying the {clo}. The {clo} creates and manages the components of the logging stack.
You can deploy the {logging-title} by installing the {clo}. The {clo} creates and manages the components of the logging stack.

include::snippets/logging-compatibility-snip.adoc[]

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

ifdef::openshift-origin[]
Expand All @@ -22,31 +24,24 @@ ifdef::openshift-origin[]
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_.
endif::[]

include::snippets/logging-fluentd-dep-snip.adoc[]

//Installing the Red Hat OpenShift Logging Operator via webconsole
include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
include::modules/create-cluster-logging-cr-console.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../logging/log_collection_forwarding/cluster-logging-collector.adoc#cluster-logging-collector[Configuring the logging collector]
include::modules/logging-clo-gui-install.adoc[leveloffset=+1]

include::modules/logging-clo-cli-install.adoc[leveloffset=+1]

// Install using CLI
include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* 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]
* 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]
include::modules/create-cluster-logging-cli.adoc[leveloffset=+1]

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

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

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

include::modules/cluster-logging-about-crd.adoc[leveloffset=+2]
include::modules/configuring-log-storage-cr.adoc[leveloffset=+2]
include::modules/configuring-logging-collector.adoc[leveloffset=+2]
Expand Down
2 changes: 1 addition & 1 deletion logging/log_storage/installing-log-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You can use the {es-op} to deploy an internal Elasticsearch log store on your {p
include::snippets/logging-elastic-dep-snip.adoc[]
include::modules/logging-es-storage-considerations.adoc[leveloffset=+2]
include::modules/logging-install-es-operator.adoc[leveloffset=+2]
include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+2]
include::modules/cluster-logging-deploy-es-cli.adoc[leveloffset=+2]

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

0 comments on commit 72d20da

Please sign in to comment.