Skip to content

Commit 4998c85

Browse files
stevsmitstevsmit
authored
Merge pull request #93780 from openshift-cherrypick-robot/cherry-pick-92388-to-enterprise-4.17
[enterprise-4.17] OBSDOCS-1749: Add section about uiplugin in installing logging
2 parents 653925d + 5dbac4d commit 4998c85

File tree

4 files changed

+121
-0
lines changed

4 files changed

+121
-0
lines changed

‎modules/log6x-installing-the-logging-ui-plug-in-cli.adoc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc
4+
5+
:_newdoc-version: 2.18.4
6+
:_template-generated: 2025-04-18
7+
:_mod-docs-content-type: PROCEDURE
8+
9+
[id="installing-the-logging-ui-plugin-cli_{context}"]
10+
= Installing the Logging UI plugin by using the CLI
11+
12+
Install the Logging UI plugin by using the command-line interface (CLI) so that you can visualize logs.
13+
14+
.Prerequisites
15+
* You have administrator permissions.
16+
* You installed the {oc-first}.
17+
* You installed and configured {loki-op}.
18+
19+
.Procedure
20+
. Install the {coo-full}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/cluster_observability_operator/installing-cluster-observability-operators[Installing the Cluster Observability Operator].
21+
22+
. Create a `UIPlugin` custom resource (CR):
23+
+
24+
.Example `UIPlugin` CR
25+
[source,yaml]
26+
----
27+
apiVersion: observability.openshift.io/v1alpha1
28+
kind: UIPlugin
29+
metadata:
30+
name: logging # <1>
31+
spec:
32+
type: Logging # <2>
33+
logging:
34+
lokiStack:
35+
name: logging-loki # <3>
36+
----
37+
<1> Set `name` to `logging`.
38+
<2> Set `type` to `Logging`.
39+
<3> The `name` value must match the name of your LokiStack instance.
40+
+
41+
[NOTE]
42+
====
43+
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration.
44+
====
45+
46+
. Apply the `UIPlugin` CR object by running the following command:
47+
+
48+
[source,terminal]
49+
----
50+
$ oc apply -f <filename>.yaml
51+
----
52+
53+
.Verification
54+
55+
. Access the {product-title} web console, and refresh the page if a pop-up message instructs you to do so.
56+
. Navigate to the *Observe → Logs* panel, where you can run LogQL queries. You can also query logs for individual pods from the *Aggregated Logs* tab of a specific pod.

‎modules/log6x-installing-the-logging-ui-plug-in-gui.adoc

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc
4+
5+
:_newdoc-version: 2.18.4
6+
:_template-generated: 2025-04-18
7+
:_mod-docs-content-type: PROCEDURE
8+
9+
[id="installing-the-logging-ui-plugin_gui{context}"]
10+
= Installing the Logging UI plugin by using the web console
11+
12+
Install the Logging UI plugin by using the web console so that you can visualize logs.
13+
14+
.Prerequisites
15+
* You have administrator permissions.
16+
* You have access to the {product-title} web console.
17+
* You installed and configured {loki-op}.
18+
19+
.Procedure
20+
. Install the {coo-full}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/cluster_observability_operator/installing-cluster-observability-operators[Installing the Cluster Observability Operator].
21+
22+
. Navigate to the *Installed Operators* page. Under *Provided APIs*, select *ClusterObservabilityOperator*. Find the `UIPlugin` resource and click *Create Instance*.
23+
24+
. Select the YAML view, and then use the following template to create a `UIPlugin` custom resource (CR):
25+
+
26+
[source,yaml]
27+
----
28+
apiVersion: observability.openshift.io/v1alpha1
29+
kind: UIPlugin
30+
metadata:
31+
name: logging # <1>
32+
spec:
33+
type: Logging # <2>
34+
logging:
35+
lokiStack:
36+
name: logging-loki # <3>
37+
----
38+
<1> Set `name` to `logging`.
39+
<2> Set `type` to `Logging`.
40+
<3> The `name` value must match the name of your LokiStack instance.
41+
+
42+
[NOTE]
43+
====
44+
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration.
45+
====
46+
47+
. Click *Create*.
48+
49+
.Verification
50+
51+
. Refresh the page when a pop-up message instructs you to do so.
52+
. Navigate to the *Observe → Logs* panel, where you can run LogQL queries. You can also query logs for individual pods from the *Aggregated Logs* tab of a specific pod.

‎observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,23 @@ endif::[]
3939
The following sections describe installing the {loki-op} and the {clo} by using the CLI.
4040

4141
include::modules/log6x-logging-loki-cli-install.adoc[leveloffset=+2]
42+
4243
include::modules/log6x-logging-clo-cli-install.adoc[leveloffset=+2]
4344

45+
nclude::modules/log6x-installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2]
46+
4447
[id="installing-loki-and-logging-gui_{context}"]
4548
== Installation by using the web console
4649

4750
The following sections describe installing the {loki-op} and the {clo} by using the web console.
4851

4952
include::modules/log6x-logging-loki-gui-install.adoc[leveloffset=+2]
53+
5054
include::modules/log6x-logging-clo-gui-install.adoc[leveloffset=+2]
5155

56+
include::modules/log6x-installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2]
57+
58+
5259
[role="_additional-resources"]
5360
.Additional resources
5461

‎observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,22 @@ endif::[]
3939
The following sections describe installing the {loki-op} and the {clo} by using the CLI.
4040

4141
include::modules/log6x-logging-loki-cli-install.adoc[leveloffset=+2]
42+
4243
include::modules/log6x-logging-clo-cli-install.adoc[leveloffset=+2]
4344

45+
include::modules/log6x-installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2]
46+
4447
[id="installing-loki-and-logging-gui_{context}"]
4548
== Installation by using the web console
4649

4750
The following sections describe installing the {loki-op} and the {clo} by using the web console.
4851

4952
include::modules/log6x-logging-loki-gui-install.adoc[leveloffset=+2]
53+
5054
include::modules/log6x-logging-clo-gui-install.adoc[leveloffset=+2]
5155

56+
include::modules/log6x-installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2]
57+
5258
[role="_additional-resources"]
5359
.Additional resources
5460

0 commit comments

Comments
 (0)