Skip to content

Commit 382e23f

Browse files
theashiottheashiot
committed
OBSDOCS-1749: Add section about uiplugin in installing logging
1 parent 1ce55ac commit 382e23f

File tree

4 files changed

+113
-0
lines changed

4 files changed

+113
-0
lines changed

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
:_newdoc-version: 2.18.4
2+
:_template-generated: 2025-04-18
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="installing-the-logging-ui-plug-in-cli_{context}"]
6+
= Installing the Logging UI plug-in by using the CLI
7+
8+
Install the Logging UI plug-in by using the comman-line interfatce (CLI) to visualize logs.
9+
10+
.Prerequisites
11+
* You have administrator permissions.
12+
* You installed the {oc-first}.
13+
* You installed and configured {loki-op}.
14+
15+
.Procedure
16+
. 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[Cluster Observability Operator].
17+
18+
. Create a `UIPlugin` custom resource (CR):
19+
+
20+
.Example `UIPlugin` CR
21+
[source,yaml]
22+
----
23+
apiVersion: observability.openshift.io/v1alpha1
24+
kind: UIPlugin
25+
metadata:
26+
name: logging # <1>
27+
spec:
28+
type: Logging # <2>
29+
logging:
30+
lokiStack:
31+
name: logging-loki # <3>
32+
----
33+
<1> Set `name` to `logging`.
34+
<2> Set `type` to `Logging`.
35+
<3> `name` must match the name of your LokiStack instance.
36+
+
37+
[NOTE]
38+
====
39+
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration.
40+
====
41+
42+
. Apply the `UIPlugin` CR object by running the following command:
43+
+
44+
[source,terminal]
45+
----
46+
$ oc apply -f <filename>.yaml
47+
----
48+
49+
.Verification
50+
51+
. Access the OpenShift Container Platform web console and refresh the page if 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 pods view *Aggregated Logs* tab.

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_newdoc-version: 2.18.4
2+
:_template-generated: 2025-04-18
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="installing-the-logging-ui-plug-in_gui{context}"]
6+
= Installing the Logging UI plug-in by using the web console
7+
8+
Install the Logging UI plug-in by using the web console to visualize logs.
9+
10+
.Prerequisites
11+
* You have administrator permissions.
12+
* You have access to the OpenShift Container Platform web console.
13+
* You installed and configured {loki-op}.
14+
15+
.Procedure
16+
. 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[Cluster Observability Operator].
17+
18+
. Navigate to the *Installed Operators* page. Select the *ClusterObservabilityOperator* under *Provided APIs*, find the `UIPlugin` resource and click *Create Instance*.
19+
20+
. Select the YAML view, and then use the following template to create a `UIPlugin` custom resource (CR):
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: observability.openshift.io/v1alpha1
25+
kind: UIPlugin
26+
metadata:
27+
name: logging # <1>
28+
spec:
29+
type: Logging # <2>
30+
logging:
31+
lokiStack:
32+
name: logging-loki # <3>
33+
----
34+
<1> Set `name` to `logging`.
35+
<2> Set `type` to `Logging`.
36+
<3> `name` must match the name of your LokiStack instance.
37+
+
38+
[NOTE]
39+
====
40+
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration.
41+
====
42+
43+
. Click *Create*.
44+
45+
.Verification
46+
47+
. Refresh the page when a pop-up message instructs you to do so.
48+
. Navigate to the Observe → Logs panel where you can run LogQL queries. You can also query Logs for individual pods from the pods view *Aggregated Logs* tab.

‎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)