diff --git a/modules/log6x-installing-the-logging-ui-plug-in-cli.adoc b/modules/log6x-installing-the-logging-ui-plug-in-cli.adoc new file mode 100644 index 000000000000..c28a10c4cdb0 --- /dev/null +++ b/modules/log6x-installing-the-logging-ui-plug-in-cli.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc + +:_newdoc-version: 2.18.4 +:_template-generated: 2025-04-18 +:_mod-docs-content-type: PROCEDURE + +[id="installing-the-logging-ui-plugin-cli_{context}"] += Installing the Logging UI plugin by using the CLI + +Install the Logging UI plugin by using the command-line interface (CLI) so that you can visualize logs. + +.Prerequisites +* You have administrator permissions. +* You installed the {oc-first}. +* You installed and configured {loki-op}. + +.Procedure +. 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]. + +. Create a `UIPlugin` custom resource (CR): ++ +.Example `UIPlugin` CR +[source,yaml] +---- +apiVersion: observability.openshift.io/v1alpha1 +kind: UIPlugin +metadata: + name: logging # <1> +spec: + type: Logging # <2> + logging: + lokiStack: + name: logging-loki # <3> +---- +<1> Set `name` to `logging`. +<2> Set `type` to `Logging`. +<3> The `name` value must match the name of your LokiStack instance. ++ +[NOTE] +==== +If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. +==== + +. Apply the `UIPlugin` CR object by running the following command: ++ +[source,terminal] +---- +$ oc apply -f .yaml +---- + +.Verification + +. Access the {product-title} web console, and refresh the page if a pop-up message instructs you to do so. +. 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. \ No newline at end of file diff --git a/modules/log6x-installing-the-logging-ui-plug-in-gui.adoc b/modules/log6x-installing-the-logging-ui-plug-in-gui.adoc new file mode 100644 index 000000000000..913123dd3e02 --- /dev/null +++ b/modules/log6x-installing-the-logging-ui-plug-in-gui.adoc @@ -0,0 +1,52 @@ +// Module included in the following assemblies: +// +// * observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc + +:_newdoc-version: 2.18.4 +:_template-generated: 2025-04-18 +:_mod-docs-content-type: PROCEDURE + +[id="installing-the-logging-ui-plugin_gui{context}"] += Installing the Logging UI plugin by using the web console + +Install the Logging UI plugin by using the web console so that you can visualize logs. + +.Prerequisites +* You have administrator permissions. +* You have access to the {product-title} web console. +* You installed and configured {loki-op}. + +.Procedure +. 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]. + +. Navigate to the *Installed Operators* page. Under *Provided APIs*, select *ClusterObservabilityOperator*. Find the `UIPlugin` resource and click *Create Instance*. + +. Select the YAML view, and then use the following template to create a `UIPlugin` custom resource (CR): ++ +[source,yaml] +---- +apiVersion: observability.openshift.io/v1alpha1 +kind: UIPlugin +metadata: + name: logging # <1> +spec: + type: Logging # <2> + logging: + lokiStack: + name: logging-loki # <3> +---- +<1> Set `name` to `logging`. +<2> Set `type` to `Logging`. +<3> The `name` value must match the name of your LokiStack instance. ++ +[NOTE] +==== +If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. +==== + +. Click *Create*. + +.Verification + +. Refresh the page when a pop-up message instructs you to do so. +. 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. \ No newline at end of file diff --git a/observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc b/observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc index a367ee3c8486..7387380a96ad 100644 --- a/observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc +++ b/observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc @@ -39,16 +39,23 @@ endif::[] The following sections describe installing the {loki-op} and the {clo} by using the CLI. include::modules/log6x-logging-loki-cli-install.adoc[leveloffset=+2] + include::modules/log6x-logging-clo-cli-install.adoc[leveloffset=+2] +nclude::modules/log6x-installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2] + [id="installing-loki-and-logging-gui_{context}"] == Installation by using the web console The following sections describe installing the {loki-op} and the {clo} by using the web console. include::modules/log6x-logging-loki-gui-install.adoc[leveloffset=+2] + include::modules/log6x-logging-clo-gui-install.adoc[leveloffset=+2] +include::modules/log6x-installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2] + + [role="_additional-resources"] .Additional resources diff --git a/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc b/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc index 3092ea55b1e3..8f9382adf7e7 100644 --- a/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc +++ b/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc @@ -39,16 +39,22 @@ endif::[] The following sections describe installing the {loki-op} and the {clo} by using the CLI. include::modules/log6x-logging-loki-cli-install.adoc[leveloffset=+2] + include::modules/log6x-logging-clo-cli-install.adoc[leveloffset=+2] +include::modules/log6x-installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2] + [id="installing-loki-and-logging-gui_{context}"] == Installation by using the web console The following sections describe installing the {loki-op} and the {clo} by using the web console. include::modules/log6x-logging-loki-gui-install.adoc[leveloffset=+2] + include::modules/log6x-logging-clo-gui-install.adoc[leveloffset=+2] +include::modules/log6x-installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources