|
| 1 | +// Module is included in the following assemblies: |
| 2 | +// |
| 3 | +:_content-type: PROCEDURE |
| 4 | +[id="logging-loki-gui-install_{context}"] |
| 5 | += Installing logging Operators using the {product-title} web console |
| 6 | + |
| 7 | +To install and configure logging on your {product-title} cluster, additional Operators must be installed. This can be done from the Operator Hub within the web console. |
| 8 | + |
| 9 | +{Product-title} Operators use custom resources (CR) to manage applications and their components. High-level configuration and settings are provided by the user within a CR. The Operator translates high-level directives into low-level actions, based on best practices embedded within the Operator’s logic. A custom resource definition (CRD) defines a CR and lists all the configurations available to users of the Operator. Installing an Operator creates the CRDs, which are then used to generate CRs. |
| 10 | + |
| 11 | +.Prerequisites |
| 12 | + |
| 13 | +* Supported object store (AWS S3, Google Cloud Storage, Azure, Swift, Minio, OpenShift Data Foundation) |
| 14 | +
|
| 15 | +.Procedure |
| 16 | + |
| 17 | +. Install the `Loki Operator`: |
| 18 | + |
| 19 | +.. In the {product-title} web console, click *Operators* -> *OperatorHub*. |
| 20 | + |
| 21 | +.. Type `Loki Operator` in the filter by keyword box. Choose *Loki Operator* from the list of available Operators and click *Install*. |
| 22 | ++ |
| 23 | +[NOTE] |
| 24 | +==== |
| 25 | +The Community Loki Operator is not supported by Red Hat. |
| 26 | +==== |
| 27 | + |
| 28 | +.. On the Install Operator page, for *Update Channel* select *stable*. |
| 29 | ++ |
| 30 | +-- |
| 31 | +include::snippets/logging-stable-updates-snip.adoc[] |
| 32 | +-- |
| 33 | + |
| 34 | +As the Loki Operator must be deployed to the global operator group namespace `openshift-operators-redhat`, *Installation mode* and *Installed Namespace* is already be selected. If this namespace does not already exist, it is created for you. |
| 35 | + |
| 36 | +.. Select *Enable operator-recommended cluster monitoring on this namespace.* |
| 37 | + |
| 38 | +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-operators-redhat` namespace. |
| 39 | + |
| 40 | +.. For *Update approval* select *Automatic*, then click *Install*. |
| 41 | ++ |
| 42 | +-- |
| 43 | +include::snippets/logging-approval-strategy-snip.adoc[] |
| 44 | +-- |
| 45 | + |
| 46 | +. Install the `Red Hat OpenShift Logging` Operator: |
| 47 | + |
| 48 | +.. In the {product-title} web console, click *Operators* -> *OperatorHub*. |
| 49 | + |
| 50 | +.. Type `OpenShift Logging` in the filter by keyword box. Choose *Red Hat OpenShift Logging* from the list of available Operators and click *Install*. |
| 51 | + |
| 52 | +.. On the Install Operator page, under *Update channel* select *stable*. |
| 53 | ++ |
| 54 | +-- |
| 55 | +include::snippets/logging-stable-updates-snip.adoc[] |
| 56 | +-- |
| 57 | + |
| 58 | +As the `Red Hat OpenShift Logging` Operator is only deployable to the `openshift-logging` namespace, *Installation mode* and *Installed Namespace* is already selected. If this namespace does not already exist, it is created for you. |
| 59 | + |
| 60 | +.. If you are creating the `openshift-logging` namespace, select the option to *Enable Operator recommended cluster monitoring on this Namespace*. |
| 61 | ++ |
| 62 | +[NOTE] |
| 63 | +==== |
| 64 | +If the `openshift-logging` namespace already exists, you must add the namespace label, `openshift.io/cluster-monitoring: "true"`, to enable metrics service discovery. |
| 65 | +==== |
| 66 | + |
| 67 | +.. Under *Update approval* select *Automatic*. |
| 68 | ++ |
| 69 | +-- |
| 70 | +include::snippets/logging-approval-strategy-snip.adoc[] |
| 71 | +-- |
| 72 | + |
| 73 | +.. For *Console plugin* select *Enable*, then click *Install*. |
| 74 | + |
| 75 | +The Operators should now be available to all users and projects that use this cluster. |
| 76 | + |
| 77 | +. Verify the operator installations: |
| 78 | +.. Navigate to *Operators* -> *Installed Operators*. |
| 79 | +.. Make sure the *openshift-logging* project is selected. |
| 80 | +.. In the *Status* column, verify that you see green checks with *InstallSucceeded* and the text *Up to date*, below. |
| 81 | ++ |
| 82 | +[NOTE] |
| 83 | +==== |
| 84 | +An Operator might display a `Failed` status before the installation finishes. If the Operator install completes with an `InstallSucceeded` message, refresh the page. |
| 85 | +==== |
0 commit comments