You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// Module is included in the following assemblies:
2
+
// logging/cluster-logging-loki.adoc
3
+
:_mod-docs-content-type: PROCEDURE
4
+
[id="logging-clo-cli-install_{context}"]
5
+
= Installing {clo} using the {product-title} CLI
6
+
7
+
To install and configure logging on your {product-title} cluster, additional Operators must be installed. This can be done from the {product-title} CLI.
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 {clo} by creating the following objects:
18
+
19
+
.. Create an `Operator Group` object YAML file (for example, `olo-og.yaml`) using the template below:
20
+
+
21
+
[source,terminal]
22
+
----
23
+
$ oc create -f <file-name>.yaml
24
+
----
25
+
+
26
+
[source,yaml]
27
+
----
28
+
apiVersion: operators.coreos.com/v1
29
+
kind: OperatorGroup
30
+
metadata:
31
+
name: cluster-logging
32
+
namespace: openshift-logging # <1>
33
+
spec:
34
+
targetNamespaces:
35
+
- openshift-logging
36
+
----
37
+
<1> You must specify the `openshift-logging` namespace.
38
+
39
+
.. Create a `Subscription` object YAML file (for example, `olo-sub.yaml`) to subscribe a namespace to the {clo} using the template below:
40
+
+
41
+
[source,terminal]
42
+
----
43
+
$ oc create -f <file-name>.yaml
44
+
----
45
+
+
46
+
[source,yaml]
47
+
----
48
+
apiVersion: operators.coreos.com/v1alpha1
49
+
kind: Subscription
50
+
metadata:
51
+
name: cluster-logging
52
+
namespace: openshift-logging # <1>
53
+
spec:
54
+
channel: stable # <2>
55
+
name: cluster-logging
56
+
source: redhat-operators # <3>
57
+
sourceNamespace: openshift-marketplace
58
+
----
59
+
<1> You must specify the `openshift-logging` namespace.
60
+
<2> Specify `stable`, or `stable-5.<y>` as the channel.
61
+
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object you created when you configured the Operator Lifecycle Manager (OLM).
62
+
63
+
64
+
.. Verify the Operator installation.
65
+
+
66
+
There should be a {clo} in the `openshift-logging` namespace. The version number might be different than what is shown.
67
+
+
68
+
[source,terminal]
69
+
----
70
+
$ oc get csv -n openshift-logging
71
+
----
72
+
+
73
+
.Example output
74
+
[source,terminal]
75
+
----
76
+
NAME DISPLAY VERSION REPLACES PHASE
77
+
cluster-logging.v5.7.4 Red Hat OpenShift Logging 5.7.4 cluster-logging.v5.7.3 Succeeded
78
+
----
79
+
80
+
. Create a {clo} instance:
81
+
82
+
.. Create an `instance` object YAML file (for example, `olo-instance.yaml`) using the template below:
83
+
+
84
+
[source,terminal]
85
+
----
86
+
$ oc create -f <file-name>.yaml
87
+
----
88
+
+
89
+
[source,yaml]
90
+
----
91
+
apiVersion: logging.openshift.io/v1
92
+
kind: ClusterLogging
93
+
metadata:
94
+
name: instance
95
+
namespace: openshift-logging
96
+
spec:
97
+
logStore:
98
+
type: lokistack
99
+
lokistack:
100
+
name: logging-loki
101
+
collection:
102
+
type: vector
103
+
----
104
+
105
+
.Verification
106
+
107
+
Verify the installation by listing the pods in the *openshift-logging* project by running the following command:
108
+
109
+
[source,terminal]
110
+
----
111
+
$ oc get pods -n openshift-logging
112
+
----
113
+
114
+
You should see several pods for components of the Logging subsystem, similar to the following list:
// Module is included in the following assemblies:
2
+
//
3
+
:_mod-docs-content-type: PROCEDURE
4
+
[id="logging-clo-gui-install_{context}"]
5
+
= Installing the {clo} using the {product-title} web console
6
+
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.
7
+
8
+
{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.
9
+
10
+
.Prerequisites
11
+
12
+
* Supported object store (AWS S3, Google Cloud Storage, Azure, Swift, Minio, OpenShift Data Foundation)
13
+
14
+
.Procedure
15
+
16
+
. To install the {clo} in the {product-title} web console, click *Operators*->*OperatorHub*.
17
+
18
+
.. Type `OpenShift Logging` in the filter by keyword box. Choose *Red Hat OpenShift Logging* from the list of available Operators and click *Install*.
19
+
20
+
.. On the *Install Operator* page, under *Update channel* select *stable*.
21
+
+
22
+
[NOTE]
23
+
====
24
+
The `stable` channel only provides updates to the most recent release of logging. To continue receiving updates for prior releases, you must change your subscription channel to `stable-X` where `X` is the version of logging you have installed.
25
+
====
26
+
+
27
+
As the {clo} 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.
28
+
29
+
.. If you are creating the `openshift-logging` namespace, select the option to *Enable Operator recommended cluster monitoring on this Namespace*.
30
+
+
31
+
[NOTE]
32
+
====
33
+
If the `openshift-logging` namespace already exists, you must add the namespace label, `openshift.io/cluster-monitoring: "true"`, to enable metrics service discovery.
34
+
====
35
+
36
+
.. Under *Update approval* select *Automatic*.
37
+
+
38
+
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.
39
+
40
+
.. For *Console plugin* select *Enable*, then click *Install*.
41
+
42
+
The Operators should now be available to all users and projects that use this cluster.
43
+
44
+
.Verification
45
+
46
+
. Navigate to *Operators*->*Installed Operators*.
47
+
. Make sure the *openshift-logging* project is selected.
48
+
. In the *Status* column, verify that you see green checkmarks with *InstallSucceeded* and the text *Up to date*.
49
+
50
+
[NOTE]
51
+
====
52
+
An Operator might display a `Failed` status before the installation finishes. If the Operator install completes with an `InstallSucceeded` message, refresh the page.
Copy file name to clipboardExpand all lines: modules/logging-loki-cli-install.adoc
+11-98Lines changed: 11 additions & 98 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
// logging/cluster-logging-loki.adoc
3
3
:_mod-docs-content-type: PROCEDURE
4
4
[id="logging-loki-cli-install_{context}"]
5
-
= Installing logging Operators using the {product-title} CLI
5
+
= Installing {loki-op} using the {product-title} CLI
6
6
7
7
To install and configure logging on your {product-title} cluster, additional Operators must be installed. This can be done from the {product-title} CLI.
8
8
@@ -14,16 +14,16 @@ To install and configure logging on your {product-title} cluster, additional Ope
14
14
15
15
.Procedure
16
16
17
-
. Install the `Loki Operator` by creating the following objects:
17
+
. Install the {loki-op} by creating the following objects:
18
18
19
-
.. Create a Subscription object YAML file (for example, `olo-sub.yaml`) to
19
+
.. Create a `Subscription` object YAML file (for example, `olo-sub.yaml`) to
20
20
subscribe a namespace to the Loki Operator using the template below:
21
21
+
22
22
[source,terminal]
23
23
----
24
24
$ oc create -f <file-name>.yaml
25
25
----
26
-
26
+
+
27
27
[source,yaml]
28
28
----
29
29
apiVersion: operators.coreos.com/v1alpha1
@@ -45,17 +45,17 @@ spec:
45
45
----
46
46
<1> You must specify the `openshift-operators-redhat` namespace.
47
47
<2> Specify `stable`, or `stable-5.<y>` as the channel.
48
-
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the CatalogSource object you created when you configured the Operator Lifecycle Manager (OLM).
48
+
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object you created when you configured the Operator Lifecycle Manager (OLM).
49
49
50
50
. Create a LokiStack instance:
51
51
52
-
.. Create an instance object YAML file (for example, `logging-loki.yaml`) using the template below:
52
+
.. Create an `instance` object YAML file (for example, `logging-loki.yaml`) using the template below:
53
53
+
54
54
[source,terminal]
55
55
----
56
56
$ oc create -f <file-name>.yaml
57
57
----
58
-
58
+
+
59
59
[source,yaml]
60
60
----
61
61
apiVersion: loki.grafana.com/v1
@@ -81,104 +81,17 @@ spec:
81
81
<3> Enter the type of your log store secret.
82
82
<4> Enter the name of an existing storage class for temporary storage. For best performance, specify a storage class that allocates block storage. Available storage classes for your cluster can be listed using `oc get storageclasses`.
83
83
84
-
. Install the `Red Hat OpenShift Logging` Operator by creating the following objects:
85
-
86
-
.. Create an Operator Group object YAML file (for example, `olo-og.yaml`) using the template below:
87
-
+
88
-
[source,terminal]
89
-
----
90
-
$ oc create -f <file-name>.yaml
91
-
----
92
-
93
-
[source,yaml]
94
-
----
95
-
apiVersion: operators.coreos.com/v1
96
-
kind: OperatorGroup
97
-
metadata:
98
-
name: cluster-logging
99
-
namespace: openshift-logging # <1>
100
-
spec:
101
-
targetNamespaces:
102
-
- openshift-logging
103
-
----
104
-
<1> You must specify the `openshift-logging` namespace.
105
-
106
-
.. Create a Subscription object YAML file (for example, `olo-sub.yaml`) to
107
-
subscribe a namespace to the Red Hat OpenShift Logging Operator using the template below:
108
-
+
109
-
[source,terminal]
110
-
----
111
-
$ oc create -f <file-name>.yaml
112
-
----
113
-
114
-
[source,yaml]
115
-
----
116
-
apiVersion: operators.coreos.com/v1alpha1
117
-
kind: Subscription
118
-
metadata:
119
-
name: cluster-logging
120
-
namespace: openshift-logging # <1>
121
-
spec:
122
-
channel: stable # <2>
123
-
name: cluster-logging
124
-
source: redhat-operators # <3>
125
-
sourceNamespace: openshift-marketplace
126
-
----
127
-
<1> You must specify the `openshift-logging` namespace.
128
-
<2> Specify `stable`, or `stable-5.<y>` as the channel.
129
-
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the CatalogSource object you created when you configured the Operator Lifecycle Manager (OLM).
130
-
131
-
132
-
.. Verify the Operator installation.
133
-
+
134
-
There should be a Red Hat OpenShift Logging Operator in the `openshift-logging` namespace. The Version number might be different than what is shown.
135
-
+
136
-
[source,terminal]
137
-
----
138
-
$ oc get csv -n openshift-logging
139
-
----
140
-
+
141
-
.Example output
142
-
[source,terminal]
143
-
----
144
-
NAME DISPLAY VERSION REPLACES PHASE
145
-
cluster-logging.v5.7.4 Red Hat OpenShift Logging 5.7.4 cluster-logging.v5.7.3 Succeeded
146
-
----
84
+
.Verification
147
85
148
-
. Create an OpenShift Logging instance:
86
+
Verify the installation by listing the pods in the *openshift-logging* project by running the following command:
149
87
150
-
.. Create an instance object YAML file (for example, `olo-instance.yaml`) using the template below:
151
-
+
152
88
[source,terminal]
153
89
----
154
-
$ oc create -f <file-name>.yaml
155
-
----
156
-
157
-
[source,yaml]
158
-
----
159
-
apiVersion: logging.openshift.io/v1
160
-
kind: ClusterLogging
161
-
metadata:
162
-
name: instance
163
-
namespace: openshift-logging
164
-
spec:
165
-
logStore:
166
-
type: lokistack
167
-
lokistack:
168
-
name: logging-loki
169
-
collection:
170
-
type: vector
90
+
$ oc get pods -n openshift-logging
171
91
----
172
92
173
-
. Verify the installation by listing the pods in the *openshift-logging* project.
174
-
+
175
93
You should see several pods for components of the Logging subsystem, similar to the following list:
0 commit comments