OBSDOCS-1749: Add section about uiplugin in installing logging #92388

theashiot · 2025-04-21T09:19:22Z

Version(s): 4.18, 4.17, 4.16

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

openshift-ci-robot · 2025-04-21T09:19:26Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2025-04-21T09:19:26Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

theashiot · 2025-04-21T10:15:17Z

/test all

ocpdocs-previewbot · 2025-04-21T10:40:00Z

🤖 Fri May 23 08:12:00 - Prow CI generated the docs preview:

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.html
https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html

openshift-ci-robot · 2025-04-22T11:28:49Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview: https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in_installing-logging-6-2

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

JoaoBraveCoding · 2025-04-23T08:53:38Z

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

+* You have installed the Loki operator.
+
+.Procedure
+. Install the {coo-full}. For more information, see xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator].


This is not linking to the correct page. The page we want is https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/cluster_observability_operator/installing-the-cluster-observability-operator

JoaoBraveCoding · 2025-04-23T09:07:28Z

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

+.Procedure
+. Install the {coo-full}. For more information, see xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator].
+
+. Create an instance of the `UIPlugin` resource.


Suggested change

. Create an instance of the `UIPlugin` resource.

. Navigate to the `Installed Operators` page. Select the `ClusterObservabilityOperator` under the Provided APIs find the `UIPlugin` resource and click Create Instance.

. Select YAML view, and then use the following template to create a `UIPlugin` CR:

JoaoBraveCoding · 2025-04-23T10:21:56Z

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

+<1> Set `name` to `logging`.
+<2> Set `type` to `Logging`.
+<3> `name` must match the name of your LokiStack instance. 
+


Suggested change

. Click Create.

Add a tip that if LokiStack is installed in a namespace other than openshift-logging they can also set namespace in the lokistack refrence

JoaoBraveCoding · 2025-04-23T10:22:51Z

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

+<2> Set `type` to `Logging`.
+<3> `name` must match the name of your LokiStack instance. 
+
+. Navigate to the Observe → Logs panel where you can run LogQL queries. You can aslo query Logs for individual pods from the pods view *Aggregated Logs* tab.


Can you put this under ".Verification"

Wait a few minutes for a pop-up to show on the top right of the screen to refresh

Navigate...

JoaoBraveCoding · 2025-04-23T10:26:39Z

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

For CLI instructions they should be the same but instead of user navigating in the console they only need to create a YAML resource and then apply that resource with oc apply -f similar to who we wrote for the other CLI instructions

theashiot · 2025-04-28T10:01:37Z

Thanks, @JoaoBraveCoding for the review! I've made the required changes and also added steps for CLI.

openshift-ci-robot · 2025-04-28T10:55:35Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in-cli_installing-logging-6-2

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in_guiinstalling-logging-6-2

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

JoaoBraveCoding · 2025-05-05T14:05:07Z

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

+* You have administrator permissions.
+* You installed the {oc-first}.
+* You installed and configured {loki-op}.
+* You have created the `openshift-logging` namespace.


Suggested change

* You have created the `openshift-logging` namespace.

JoaoBraveCoding · 2025-05-05T14:06:05Z

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

+. 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 aslo query Logs for individual pods from the pods view *Aggregated Logs* tab.


Suggested change

. 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 aslo query Logs for individual pods from the pods view *Aggregated Logs* tab.

. 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 pods view *Aggregated Logs* tab.

good catch, fixed!

JoaoBraveCoding · 2025-05-05T14:07:24Z

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

+====
+If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. 
+====
+


Suggested change

JoaoBraveCoding · 2025-05-05T14:07:45Z

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

+* Verify the installation by running the following command:
+
+[source,terminal]
+----
+$ oc get pods -n openshift-logging
+----
+
+.Example output
+[source,terminal]
+----
+$ oc get pods -n openshift-logging
+NAME                                               READY   STATUS    RESTARTS   AGE
+cluster-logging-operator-56764d8c76-7m9kg          1/1     Running   0          19m
+logging-loki-compactor-0                           1/1     Running   0          10m
+logging-loki-distributor-657647b49b-2hxwl          1/1     Running   0          10m
+logging-loki-distributor-657647b49b-qdnpf          1/1     Running   0          10m
+logging-loki-gateway-79c497c9-69mqs                2/2     Running   0          10m
+logging-loki-gateway-79c497c9-hd9w5                2/2     Running   0          10m
+logging-loki-index-gateway-0                       1/1     Running   0          10m
+logging-loki-index-gateway-1                       1/1     Running   0          10m
+logging-loki-ingester-0                            1/1     Running   0          10m
+logging-loki-ingester-1                            1/1     Running   0         9m38s
+logging-loki-querier-59c966d69c-ggjlg              1/1     Running   0          10m
+logging-loki-querier-59c966d69c-n6c2g              1/1     Running   0          10m
+logging-loki-query-frontend-bc86757-8qzwd          1/1     Running   0          10m
+logging-loki-query-frontend-bc86757-kswxk          1/1     Running   0          10m
+logging-loki-ruler-0                               1/1     Running   0          10m
+logging-loki-ruler-1                               1/1     Running   0          10m
+
+----
+


Suggested change

* Verify the installation by running the following command:

+

[source,terminal]

----

$ oc get pods -n openshift-logging

----

+

.Example output

[source,terminal]

----

$ oc get pods -n openshift-logging

NAME READY STATUS RESTARTS AGE

cluster-logging-operator-56764d8c76-7m9kg 1/1 Running 0 19m

logging-loki-compactor-0 1/1 Running 0 10m

logging-loki-distributor-657647b49b-2hxwl 1/1 Running 0 10m

logging-loki-distributor-657647b49b-qdnpf 1/1 Running 0 10m

logging-loki-gateway-79c497c9-69mqs 2/2 Running 0 10m

logging-loki-gateway-79c497c9-hd9w5 2/2 Running 0 10m

logging-loki-index-gateway-0 1/1 Running 0 10m

logging-loki-index-gateway-1 1/1 Running 0 10m

logging-loki-ingester-0 1/1 Running 0 10m

logging-loki-ingester-1 1/1 Running 0 9m38s

logging-loki-querier-59c966d69c-ggjlg 1/1 Running 0 10m

logging-loki-querier-59c966d69c-n6c2g 1/1 Running 0 10m

logging-loki-query-frontend-bc86757-8qzwd 1/1 Running 0 10m

logging-loki-query-frontend-bc86757-kswxk 1/1 Running 0 10m

logging-loki-ruler-0 1/1 Running 0 10m

logging-loki-ruler-1 1/1 Running 0 10m

----

. Access the OpenShift Container Platform 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 pods view *Aggregated Logs* tab.

JoaoBraveCoding · 2025-05-05T14:09:43Z

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

+Install the Logging UI plug-in by using the web console to visualize logs.
+
+.Prerequisites
+* You have installed the Loki operator.


Suggested change

* You have installed the Loki operator.

* You have administrator permissions.

* You have access to the OpenShift Container Platform web console.

* You installed and configured {loki-op}.

theashiot · 2025-05-08T12:42:46Z

Thanks, @JoaoBraveCoding for approving the changes!

best,
ashwin

theashiot · 2025-05-12T07:36:28Z

For QE review, @anpingli , @kabirbhartiRH, @QiaolingTang , can someone please review the docs?

thanks,
ashwin

anpingli · 2025-05-12T14:36:13Z

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

+<2> Set `type` to `Logging`.
+<3> `name` must match the name of your LokiStack instance. 
+
+[NOTE]


We don't support deploy lokistack in the other namespace expect for openshift-logging . @JoaoBraveCoding Can you confirm if we can enable it now?

https://github.com/rhobs/observability-operator/blob/main/bundle/manifests/observability.openshift.io_uiplugins.yaml#L121

I know there was a customer case that required us to add the namespace. But in regards to support I'm not I'll check with @xperimental during the daily today

Discussed it with @xperimental and with 6.x there isn't anything blocking users from installing logging on a different namespace

No idea if there is limitation to deploy the logging in the other namespace. let me confirm this.

openshift-ci-robot · 2025-05-21T08:26:06Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in-cli_installing-logging-6-2

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in_guiinstalling-logging-6-2

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

theashiot · 2025-05-21T08:26:29Z

Thanks, @JoaoBraveCoding, @anpingli for the reveiw!

theashiot · 2025-05-21T08:26:44Z

/label peer-review-needed

lahinson

Nice work! I made a few suggestions for your consideration.

lahinson · 2025-05-21T17:28:17Z

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

+:_mod-docs-content-type: PROCEDURE
+
+[id="installing-the-logging-ui-plug-in-cli_{context}"]
+= Installing the Logging UI plug-in by using the CLI


Supplementary Style Guide: https://redhat-documentation.github.io/supplementary-style-guide/#plug-in

Suggested change

= Installing the Logging UI plug-in by using the CLI

= Installing the Logging UI plugin by using the CLI

lahinson · 2025-05-21T17:28:44Z

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

+[id="installing-the-logging-ui-plug-in-cli_{context}"]
+= Installing the Logging UI plug-in by using the CLI
+
+Install the Logging UI plug-in by using the comman-line interfatce (CLI) to visualize logs.


Suggested change

Install the Logging UI plug-in by using the comman-line interfatce (CLI) to visualize logs.

Install the Logging UI plugin by using the command-line interface (CLI) so that you can visualize logs.

lahinson · 2025-05-21T17:30:06Z

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

+----
+<1> Set `name` to `logging`.
+<2> Set `type` to `Logging`.
+<3> `name` must match the name of your LokiStack instance. 


Suggested change

<3> `name` must match the name of your LokiStack instance.

<3> The `name` value must match the name of your LokiStack instance.

lahinson · 2025-05-21T17:34:08Z

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

+
+.Verification
+
+. Access the OpenShift Container Platform web console and refresh the page if a pop-up message instructs you to do so. 


Suggested change

. Access the OpenShift Container Platform web console and refresh the page if a pop-up message instructs you to do so.

. Access the {product-title} web console, and refresh the page if a pop-up message instructs you to do so.

lahinson · 2025-05-21T17:36:19Z

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

+.Verification
+
+. Access the OpenShift Container Platform 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 pods view *Aggregated Logs* tab.


Suggested change

. 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.

. 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.

lahinson · 2025-05-21T17:40:18Z

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

+
+.Prerequisites
+* You have administrator permissions.
+* You have access to the OpenShift Container Platform web console.


Suggested change

* You have access to the OpenShift Container Platform web console.

* You have access to the {product-title} web console.

lahinson · 2025-05-21T17:40:45Z

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

+* 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[Cluster Observability Operator].


Suggested change

. 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].

. 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].

lahinson · 2025-05-21T17:41:32Z

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

+.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[Cluster Observability Operator].
+
+. Navigate to the *Installed Operators* page. Select the *ClusterObservabilityOperator* under *Provided APIs*, find the `UIPlugin` resource and click *Create Instance*.


Suggested change

. Navigate to the *Installed Operators* page. Select the *ClusterObservabilityOperator* under *Provided APIs*, find the `UIPlugin` resource and click *Create Instance*.

. Navigate to the *Installed Operators* page. Under *Provided APIs*, select *ClusterObservabilityOperator*. Find the `UIPlugin` resource and click *Create Instance*.

lahinson · 2025-05-21T17:42:00Z

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

+----
+<1> Set `name` to `logging`.
+<2> Set `type` to `Logging`.
+<3> `name` must match the name of your LokiStack instance. 


Suggested change

<3> `name` must match the name of your LokiStack instance.

<3> The `name` value must match the name of your LokiStack instance.

lahinson · 2025-05-21T17:42:50Z

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

+.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 pods view *Aggregated Logs* tab.


Suggested change

. 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.

. 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.

openshift-ci · 2025-05-23T07:48:51Z

New changes are detected. LGTM label has been removed.

openshift-ci · 2025-05-23T08:16:22Z

@theashiot: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot · 2025-05-26T17:22:25Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17, 4.17

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in-cli_installing-logging-6-2

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in_guiinstalling-logging-6-2

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-05-26T17:22:33Z

@theashiot: This pull request references OBSDOCS-1749 which is a valid jira issue.

In response to this:

Version(s): 4.18, 4.17, 4.16

Issue: https://issues.redhat.com/browse/OBSDOCS-1749

Link to docs preview:

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in-cli_installing-logging-6-2

https://92388--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.html#installing-the-logging-ui-plug-in_guiinstalling-logging-6-2

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

theashiot · 2025-05-26T17:22:46Z

/label merge-review-needed

stevsmit · 2025-05-27T17:36:30Z

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

+* 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].


Shouldn't this be an xref?

stevsmit · 2025-05-27T17:44:09Z

/cherry-pick enterprise-4.17

stevsmit · 2025-05-27T17:44:13Z

/cherry-pick enterprise-4.16

openshift-cherrypick-robot · 2025-05-27T17:45:01Z

@stevsmit: new pull request created: #93780

In response to this:

/cherry-pick enterprise-4.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-05-27T17:45:03Z

@stevsmit: #92388 failed to apply on top of branch "enterprise-4.16":

Applying: OBSDOCS-1749: Add section about uiplugin in installing logging
.git/rebase-apply/patch:28: trailing whitespace.
 
.git/rebase-apply/patch:58: trailing whitespace.
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. 
.git/rebase-apply/patch:90: trailing whitespace.
 
.git/rebase-apply/patch:121: trailing whitespace.
If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. 
.git/rebase-apply/patch:128: trailing whitespace.
. Refresh the page when a pop-up message instructs you to do so. 
warning: 5 lines add whitespace errors.
Using index info to reconstruct a base tree...
A	observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc
A	observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc deleted in HEAD and modified in OBSDOCS-1749: Add section about uiplugin in installing logging. Version OBSDOCS-1749: Add section about uiplugin in installing logging of observability/logging/logging-6.2/6x-cluster-logging-deploying-6.2.adoc left in tree.
CONFLICT (modify/delete): observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc deleted in HEAD and modified in OBSDOCS-1749: Add section about uiplugin in installing logging. Version OBSDOCS-1749: Add section about uiplugin in installing logging of observability/logging/logging-6.1/6x-cluster-logging-deploying-6.1.adoc left in tree.
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OBSDOCS-1749: Add section about uiplugin in installing logging

In response to this:

/cherry-pick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 21, 2025

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 21, 2025

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 21, 2025

JoaoBraveCoding reviewed Apr 23, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1749 branch from 9dd5727 to fff52a4 Compare April 26, 2025 07:24

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 26, 2025

theashiot marked this pull request as ready for review April 28, 2025 10:01

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 28, 2025

JoaoBraveCoding reviewed May 5, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1749 branch from fff52a4 to 130cdb9 Compare May 6, 2025 12:59

JoaoBraveCoding approved these changes May 7, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1749 branch from 130cdb9 to 382e23f Compare May 8, 2025 12:46

anpingli reviewed May 12, 2025

View reviewed changes

openshift-ci bot assigned anpingli May 19, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 19, 2025

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label May 21, 2025

lahinson removed the peer-review-needed Signifies that the peer review team needs to review this PR label May 21, 2025

lahinson added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label May 21, 2025

lahinson reviewed May 21, 2025

View reviewed changes

lahinson added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 21, 2025

OBSDOCS-1749: Add section about uiplugin in installing logging

64ffaec

theashiot force-pushed the OBSDOCS-1749 branch from 382e23f to 64ffaec Compare May 23, 2025 07:48

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label May 23, 2025

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label May 26, 2025

stevsmit reviewed May 27, 2025

View reviewed changes

stevsmit merged commit 4121d91 into openshift:enterprise-4.18 May 27, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request May 27, 2025

[enterprise-4.17] OBSDOCS-1749: Add section about uiplugin in installing logging #93780

Merged

theashiot mentioned this pull request Jun 13, 2025

OBSDOCS-1982: Transfer UIPlugin content to standalone #94438

Merged

1 task

-. Create an instance of the `UIPlugin` resource.
+. Navigate to the `Installed Operators` page. Select the `ClusterObservabilityOperator` under the Provided APIs find the `UIPlugin` resource and click Create Instance.
+. Select YAML view, and then use the following template to create a `UIPlugin` CR:

		. 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 aslo query Logs for individual pods from the pods view Aggregated Logs tab.

	= Installing the Logging UI plug-in by using the CLI
	= Installing the Logging UI plugin by using the CLI

	Install the Logging UI plug-in by using the comman-line interfatce (CLI) to visualize logs.
	Install the Logging UI plugin by using the command-line interface (CLI) so that you can visualize logs.

	<3> `name` must match the name of your LokiStack instance.
	<3> The `name` value must match the name of your LokiStack instance.


		.Verification

		. Access the OpenShift Container Platform web console and refresh the page if a pop-up message instructs you to do so.

	. Access the OpenShift Container Platform web console and refresh the page if a pop-up message instructs you to do so.
	. 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 pods view Aggregated Logs tab.
	. 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.

	* You have access to the OpenShift Container Platform web console.
	* You have access to the {product-title} web console.

	. 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].
	. 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. Select the ClusterObservabilityOperator under Provided APIs, find the `UIPlugin` resource and click Create Instance.
	. Navigate to the Installed Operators page. Under Provided APIs, select ClusterObservabilityOperator. Find the `UIPlugin` resource and click Create Instance.

OBSDOCS-1749: Add section about uiplugin in installing logging #92388

OBSDOCS-1749: Add section about uiplugin in installing logging #92388

Uh oh!

Conversation

theashiot commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Apr 21, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented Apr 21, 2025

Uh oh!

theashiot commented Apr 21, 2025

Uh oh!

ocpdocs-previewbot commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Apr 22, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theashiot commented Apr 28, 2025

Uh oh!

openshift-ci-robot commented Apr 28, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theashiot commented May 8, 2025

Uh oh!

theashiot commented May 12, 2025

Uh oh!

anpingli May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

theashiot commented Apr 21, 2025 •

edited

Loading

openshift-ci-robot commented Apr 21, 2025 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Apr 21, 2025 •

edited

Loading

openshift-ci-robot commented Apr 22, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Apr 28, 2025 •

edited by openshift-ci bot

Loading

anpingli May 12, 2025 •

edited

Loading

openshift-ci-robot commented May 21, 2025 •

edited by openshift-ci bot

Loading