Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,20 @@ Name: Installing logging
Dir: installing
Distros: openshift-logging
Topics:
- Name: Installing logging
File: installing-logging
- Name: Installation overview
Dir: overview
Distros: openshift-logging
Topics:
- Name: Overview of OpenShift Logging installation
File: overview-of-openshift-logging-installation
- Name: Installing the Operators
Dir: clo
Distros: openshift-logging
Topics:
- Name: Installing the Loki Operator
File: installing-the-loki-operator
- Name: Installing Red Hat OpenShift Logging Operator
File: installing-the-red-hat-openshift-logging-operator
---
Name: Configuring logging
Dir: configuring
Expand Down
1 change: 1 addition & 0 deletions installing/clo/_attributes
23 changes: 23 additions & 0 deletions installing/clo/installing-the-loki-operator.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-02-07
:_mod-docs-content-type: ASSEMBLY

include::_attributes/common-attributes.adoc[]

:toc:

[id="installing-the-loki-operator"]
= Installing the Loki operator

:context: intsalling-the-loki-operator

The {loki-op} manages temporary storage of logs.
You can use either {oc-first} or the web console to install the {loki-op}.

include::modules/about-loki-object-storage.adoc[leveloffset=+1]

include::modules/loki-deployment-sizing.adoc[leveloffset=+1]

include::modules/installing-the-loki-operator-by-using-the-openshift-web-console.adoc[leveloffset=+1]

include::modules/installing-the-loki-operator-by-using-the-cli.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-01-19
:_mod-docs-content-type: ASSEMBLY

include::_attributes/common-attributes.adoc[]

:toc:

[id="installing-the-red-hat-openshift-logging-operator"]
= Installing the {clo}

:context: installing-the-red-hat-openshift-logging-operator

The {clo} manages collection and forwarding of logs. You can use either {oc-first} or the web console to install the {clo}.

include::modules/installing-the-clo-by-using-the-openshift-web-console.adoc[leveloffset=+1]


include::modules/installing-the-clo-by-using-the-cli.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions installing/clo/modules
1 change: 1 addition & 0 deletions installing/overview/_attributes
1 change: 1 addition & 0 deletions installing/overview/modules
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-01-19
:_mod-docs-content-type: ASSEMBLY

include::_attributes/common-attributes.adoc[]

[id="overview-of-openshift-logging-installation"]
= Overview of {LoggingProductName} installation

:context: overview-of-openshift-logging-installation

toc::[]

Red{nbsp}Hat provides three operators to manage {logging-title}.
The Operators are responsible for deploying, upgrading, and maintaining {logging}.

You can use the following Operators to to manage {logging-title}:

* {clo}
* {loki-op}
* {coo-first}

The {clo} manages collection and forwarding of logs.
Therefore, it is the only operator that is absolutely required for {logging}.
The following list describes the use cases and the Operators that you need for each use case and the order of steps for installation:

* For collecting logs and forwarding them to third-party storage, you only need the {clo}. See, Installing {clo}.

* For log storage, in addition to log collection and forwarding, you need to install the {loki-op}, and the {clo}.
You can use a third-party tool like Grafana to visualize the logs.
Install the operators in the following order:
** Install {loki-op}
** Install {clo}

* For visualizing logs by using a Red{nbsp}Hat-provided visualization tool in addition to storing, collecting and forwarding logs, you must install the {loki-op}, the {clo}, and the {coo-full}.
Install the operators in the following order:
** Install {loki-op}
** Install {clo}
** Install {coo-full}

You can install the required Operators by using by using the {ocp-product-title} web console or the {oc-first}.
39 changes: 39 additions & 0 deletions modules/about-loki-object-storage.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-02-07
:_mod-docs-content-type: CONCEPT

[id="about-loki-object-storage_{context}"]
= About Loki object storage

The {loki-op} supports link:https://aws.amazon.com/[AWS S3], as well as other S3 compatible object stores such as the following object stores:

* link:https://azure.microsoft.com[Azure]
* link:https://cloud.google.com/[GCS]
* link:https://min.io/[Minio]
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[{rh-storage}]

Additionally, link:https://docs.openstack.org/swift/latest/[Swift] is also supported.

The recommended nomenclature for Loki storage is `logging-loki-_<your_storage_provider>_`.

The following table shows the `type` values within the `LokiStack` custom resource (CR) for each storage provider.
For more information, see the section on your storage provider.

[options="header"]
.Secret type quick reference
|===
| Storage provider | Secret `type` value
| AWS | s3
| Azure | azure
| Google Cloud | gcs
| Minio | s3
| OpenShift Data Foundation | s3
| Swift | swift
|===

////
[role="_additional-resources"]
.Additional resources
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
* xref:some-module_{context}[]
////
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-01-19
:_mod-docs-content-type: PROCEDURE

[id="installing-red-hat-openshift-logging-operator-by-using-the-cli_{context}"]
= Installing Red Hat OpenShift Logging Operator by using the CLI

Install {clo} on your {ocp-product-title} cluster to collect and forward logs to a log store by using the {oc-first}.

.Prerequisites

* You have administrator permissions.
* You installed the {oc-first}.
* You have created the `openshift-logging` namespace.
+
[source,terminal]
----
$ oc create ns openshift-logging
----

* If you choose to use Loki, install the {lok-op}.

.Procedure

. Create an `OperatorGroup` object:
+
.Example `OperatorGroup` object
[source,yaml]
----
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
name: cluster-logging
namespace: openshift-logging
spec:
upgradeStrategy: Default
----
+
[NOTE]
====
You must specify `openshift-logging` as the namespace.
====

. Apply the `OperatorGroup` object by running the following command:
+
[source,terminal]
----
$ oc apply -f <filename>.yaml
----

. Create a `Subscription` object for {clo}:
+
.Example `Subscription` object
[source,yaml]
----
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: cluster-logging
namespace: openshift-logging # <1>
spec:
channel: stable-{logging-major-version} # <2>
installPlanApproval: Automatic # <3>
name: cluster-logging
source: redhat-operators # <4>
sourceNamespace: openshift-marketplace
----
+
Where:
* You must specify `openshift-logging` as the namespace.
* Specify `stable-{logging-major-version}` as the channel.
* If the approval strategy in the subscription is set to `Automatic`, the update process initiates as soon as a new operator version is available in the selected channel. If the approval strategy is set to `Manual`, you must manually approve pending updates.
* Specify `redhat-operators` as the value. If your {ocp-product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object that you created when you configured Operator Lifecycle Manager (OLM).

.Verification
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.

* Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
* List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
* Make each step an instruction.
* Use an unnumbered bullet (*) if the verification includes only one step.

.Troubleshooting
Delete this section if it does not apply to your module. Provide the user with troubleshooting steps.

* Make each step an instruction.
* Use an unnumbered bullet (*) if the troubleshooting includes only one step.

.Next steps
* Delete this section if it does not apply to your module.
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
* Use an unnumbered bullet (*) if the list includes only one step.

NOTE: Do not use *Next steps* to provide a second list of instructions.

[role="_additional-resources"]
.Additional resources
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
* xref:some-module_{context}[]

Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
:_newdoc-version: 2.18.4
:_template-generated: 2026-01-19
:_mod-docs-content-type: PROCEDURE

[id="installing-red-hat-openshift-logging-operator-by-using-the-web-console_{context}"]
= Installing {CLO} by using the web console

Install the {clo} on your {ocp-product-title} cluster to collect and forward logs to a log store by using the {ocp-product-title} web console.


.Prerequisites
* You have administrator permissions.
* You have access to the {ocp-product-title} web console.
* If you choose to use Loki, install the {lok-op}.

.Procedure
. Navigate to the software catalog.
** {ocp-product-title} 4.20: In the {ocp-product-title} web console, click *Ecosystem* -> *Software Catalog*.
** {ocp-product-title} 4.19: In the {ocp-product-title} web console, click *Operators* -> *OperatorHub*.

. Type `{clo}` in the *Filter by keyword* field. Click *{clo}* in the list of available Operators, and then click *Install*.

. Select *{major-version}.{minor-version}* as the *Update channel*. The latest version is already selected in the *Version* field.
+
The {clo} must be deployed to the {logging} namespace `openshift-logging`, so the *Installation mode* and *Installed Namespace* are already selected. If this namespace does not already exist, it will be created for you.

. Select *Enable Operator-recommended cluster monitoring on this namespace.*
+
This option sets the `openshift.io/cluster-monitoring: "true"` label in the `Namespace` object. You must select this option to ensure that cluster monitoring scrapes the `openshift-logging` namespace.

. For *Update approval* select *Automatic*, then click *Install*.
+
If the approval strategy in the subscription is set to *Automatic*, the update process initiates as soon as a new Operator version is available in the selected channel.
If the approval strategy is set to *Manual*, you must manually approve pending updates.
+
[NOTE]
====
An Operator might display a `Failed` status before the installation completes.
====

////
.Verification
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.

* Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
* List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
* Make each step an instruction.
* Use an unnumbered bullet (*) if the verification includes only one step.

.Troubleshooting
Delete this section if it does not apply to your module. Provide the user with troubleshooting steps.

* Make each step an instruction.
* Use an unnumbered bullet (*) if the troubleshooting includes only one step.
////

.Next steps
* Create a `ClusterLogForwarder` custom resource (CR) to collect and forward logs.
* Create a `LogFileMetricExporter` CR to generate metrics from the logs produced by running containers.

////
[role="_additional-resources"]
.Additional resources
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
* xref:some-module_{context}[]
////
Loading