Skip to content

Commit a7b61c1

Browse files
max-cxmax-cx
committed
OBSDOCS-1348: Add support exception statement in Logging docs for COO due to its logging UI plugin
1 parent a3272e9 commit a7b61c1

File tree

5 files changed

+29
-7
lines changed

5 files changed

+29
-7
lines changed

‎observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
:FeatureName: The {coo-full}
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
9+
[IMPORTANT]
10+
====
11+
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for the logging UI plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the logging UI plugin is ready for GA.
12+
====
1213

1314
The logging UI plugin surfaces logging data in the {product-title} web console on the *Observe* -> *Logs* page.
1415
You can specify filters, queries, time ranges and refresh rates, with the results displayed as a list of collapsed logs, which can then be expanded to show more detailed information for each log.

‎observability/logging/cluster-logging-support.adoc

+7-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ include::snippets/logging-compatibility-snip.adoc[]
1919
* A guaranteed log sink
2020
* Secure storage - audit logs are not stored by default
2121
22-
[id="cluster-logging-support-CRDs"]
22+
[id="cluster-logging-support-CRDs_{context}"]
2323
== Supported API custom resource definitions
2424

2525
LokiStack development is ongoing. Not all APIs are currently supported.
@@ -51,7 +51,12 @@ LokiStack development is ongoing. Not all APIs are currently supported.
5151
include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1]
5252
include::modules/unmanaged-operators.adoc[leveloffset=+1]
5353

54-
[id="cluster-logging-support-must-gather"]
54+
[id="support-exception-for-coo-logging-ui-plugin_{context}"]
55+
== Support exception for the Logging UI Plugin
56+
57+
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
58+
59+
[id="cluster-logging-support-must-gather_{context}"]
5560
== Collecting logging data for Red Hat Support
5661

5762
When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support.

‎observability/logging/logging-6.0/log6x-release-notes.adoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ In order to continue to use Elasticsearch and Kibana managed by the elasticsearc
3939

4040
* This feature introduces a new architecture for {logging} {for} by shifting component responsibilities to their relevant Operators, such as for storage, visualization, and collection. It introduces the `ClusterLogForwarder.observability.openshift.io` API for log collection and forwarding. Support for the `ClusterLogging.logging.openshift.io` and `ClusterLogForwarder.logging.openshift.io` APIs, along with the Red Hat managed Elastic stack (Elasticsearch and Kibana), is removed. Users are encouraged to migrate to the Red Hat `LokiStack` for log storage. Existing managed Elasticsearch deployments can be used for a limited time. Automated migration for log collection is not provided, so administrators need to create a new ClusterLogForwarder.observability.openshift.io specification to replace their previous custom resources. Refer to the official product documentation for more details. (link:https://issues.redhat.com/browse/LOG-3493[LOG-3493])
4141

42-
* With this release, the responsibility for deploying the {logging} view plugin shifts from the {clo} to the {coo-first}. For new log storage installations that need visualization, the {coo-full} and the associated UIPlugin resource must be deployed. Refer to the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator Overview] product documentation for more details. (link:https://issues.redhat.com/browse/LOG-5461[LOG-5461])
42+
* With this release, the responsibility for deploying the {logging} view plugin shifts from the {clo} to the {coo-first}. For new log storage installations that need visualization, the {coo-full} and the associated `UIPlugin` resource must be deployed. For more information, see xref:log6x-visual.adoc#log6x-visual[Visualization for logging]. (link:https://issues.redhat.com/browse/LOG-5461[LOG-5461])
43+
+
44+
--
45+
include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[]
46+
--
4347

4448
* This enhancement sets default requests and limits for Vector collector deployments' memory and CPU usage based on Vector documentation recommendations. (link:https://issues.redhat.com/browse/LOG-4745[LOG-4745])
4549

‎observability/logging/logging-6.0/log6x-visual.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Visualization for logging is provided by installing the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator].
9+
Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation.
10+
11+
include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[]

‎snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Text snippet included in the following assembly:
2+
//
3+
// * observability/logging/logging-6.0/log6x-visual.adoc
4+
5+
:_mod-docs-content-type: SNIPPET
6+
7+
[IMPORTANT]
8+
====
9+
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
10+
====

0 commit comments

Comments
 (0)