OBSDOCS-1749: Add section about uiplugin in installing logging #92388
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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] | ||
|
There was a problem hiding this comment. We don't support deploy lokistack in the other namespace expect for openshift-logging . @JoaoBraveCoding Can you confirm if we can enable it now?
Contributor
There was a problem hiding this comment. 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
Contributor
There was a problem hiding this comment. Discussed it with @xperimental and with 6.x there isn't anything blocking users from installing logging on a different namespace There was a problem hiding this comment. No idea if there is limitation to deploy the logging in the other namespace. let me confirm this. |
||
| ==== | ||
| 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 <filename>.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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure that this module file contains the required metadata, per the OCP doc guidelines: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#module-file-metadata
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done