Skip to content

Commit 3c7fb42

Browse files
theashiotopenshift-cherrypick-robot
theashiot
authored and
openshift-cherrypick-robot
committed
OBSDOCS-1530: All the support section was removed from Logging documentation in 4.17
1 parent 7465f0a commit 3c7fb42

File tree

9 files changed

+227
-20
lines changed

9 files changed

+227
-20
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2991,6 +2991,8 @@ Topics:
29912991
- Name: Logging 6.2
29922992
Dir: logging-6.2
29932993
Topics:
2994+
- Name: Support
2995+
File: log62-cluster-logging-support
29942996
- Name: Release notes
29952997
File: log6x-release-notes-6.2
29962998
- Name: About logging 6.2
@@ -3004,6 +3006,8 @@ Topics:
30043006
- Name: Logging 6.1
30053007
Dir: logging-6.1
30063008
Topics:
3009+
- Name: Support
3010+
File: log61-cluster-logging-support
30073011
- Name: Release notes
30083012
File: log6x-release-notes-6.1
30093013
- Name: About logging 6.1

‎modules/cluster-logging-maintenance-support-list-6x.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.0/log60-cluster-logging-support.adoc
4+
// * observability/logging/logging-6.1/log61-cluster-logging-support.adoc
5+
// * observability/logging/logging-6.2/log62-cluster-logging-support.adoc
6+
7+
:_mod-docs-content-type: REFERENCE
8+
[id="cluster-logging-maintenance-support-list_{context}"]
9+
= Unsupported configurations
10+
11+
You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
12+
13+
* The collector configuration file
14+
15+
* The collector daemonset
16+
17+
Explicitly unsupported cases include:
18+
19+
* *Configuring the logging collector using environment variables*. You cannot use environment variables to modify the log collector.
20+
21+
* *Configuring how the log collector normalizes logs*. You cannot modify default log normalization.

‎modules/cluster-logging-maintenance-support-list.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,14 @@
77

88
You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
99

10-
* The `Elasticsearch` custom resource (CR)
11-
12-
* The Kibana deployment
13-
1410
* The `fluent.conf` file
1511

1612
* The Fluentd daemon set
1713

18-
You must set the OpenShift Elasticsearch Operator to the `Unmanaged` state to modify the Elasticsearch deployment files.
14+
* The `vector.toml` file for Vector collector deployments
1915

20-
Explicitly unsupported cases include:
2116

22-
* *Configuring default log rotation*. You cannot modify the default log rotation configuration.
17+
Explicitly unsupported cases include:
2318

2419
* *Configuring the collected log location*. You cannot change the location of the log collector output file, which by default is `/var/log/fluentd/fluentd.log`.
2520

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="log60-cluster-logging-support"]
3+
= Support
4+
include::_attributes/common-attributes.adoc[]
5+
:context: log60-cluster-logging-support
6+
7+
toc::[]
8+
9+
include::snippets/logging-supported-config-snip.adoc[]
10+
include::snippets/logging-compatibility-snip.adoc[]
11+
include::snippets/log6x-loki-statement-snip.adoc[]
12+
13+
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
14+
15+
{logging-uc} is not:
16+
17+
* A high scale log collection system
18+
* Security Information and Event Monitoring (SIEM) compliant
19+
* A "bring your own" (BYO) log collector configuration
20+
* Historical or long term log retention or storage
21+
* A guaranteed log sink
22+
* Secure storage - audit logs are not stored by default
23+
24+
[id="cluster-logging-support-CRDs_{context}"]
25+
== Supported API custom resource definitions
26+
27+
The following table describes the supported {logging-uc} APIs.
28+
29+
include::snippets/log6x-api-support-states-snip.adoc[]
30+
31+
include::modules/cluster-logging-maintenance-support-list-6x.adoc[leveloffset=+1]
32+
include::modules/unmanaged-operators.adoc[leveloffset=+1]
33+
34+
[id="support-exception-for-coo-logging-ui-plugin_{context}"]
35+
== Support exception for the Logging UI Plugin
36+
37+
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.
38+
39+
[id="cluster-logging-support-must-gather_{context}"]
40+
== Collecting {logging} data for Red Hat Support
41+
42+
When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support.
43+
44+
You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
45+
For prompt support, supply diagnostic information for both {product-title} and {logging}.
46+
47+
include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2]
48+
include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2]

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="log61-cluster-logging-support"]
3+
= Support
4+
include::_attributes/common-attributes.adoc[]
5+
:context: log61-cluster-logging-support
6+
7+
toc::[]
8+
9+
include::snippets/logging-supported-config-snip.adoc[]
10+
include::snippets/logging-compatibility-snip.adoc[]
11+
include::snippets/log6x-loki-statement-snip.adoc[]
12+
13+
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
14+
15+
{logging-uc} is not:
16+
17+
* A high scale log collection system
18+
* Security Information and Event Monitoring (SIEM) compliant
19+
* A "bring your own" (BYO) log collector configuration
20+
* Historical or long term log retention or storage
21+
* A guaranteed log sink
22+
* Secure storage - audit logs are not stored by default
23+
24+
[id="cluster-logging-support-CRDs_{context}"]
25+
== Supported API custom resource definitions
26+
27+
The following table describes the supported {logging-uc} APIs.
28+
29+
include::snippets/log6x-api-support-states-snip.adoc[]
30+
31+
include::modules/cluster-logging-maintenance-support-list-6x.adoc[leveloffset=+1]
32+
include::modules/unmanaged-operators.adoc[leveloffset=+1]
33+
34+
[id="support-exception-for-coo-logging-ui-plugin_{context}"]
35+
== Support exception for the Logging UI Plugin
36+
37+
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.
38+
39+
[id="cluster-logging-support-must-gather_{context}"]
40+
== Collecting {logging} data for Red Hat Support
41+
42+
When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support.
43+
44+
You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
45+
For prompt support, supply diagnostic information for both {product-title} and {logging}.
46+
47+
include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2]
48+
include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2]

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="log62-cluster-logging-support"]
3+
= Support
4+
include::_attributes/common-attributes.adoc[]
5+
:context: log62-cluster-logging-support
6+
7+
toc::[]
8+
9+
include::snippets/logging-supported-config-snip.adoc[]
10+
include::snippets/logging-compatibility-snip.adoc[]
11+
include::snippets/log6x-loki-statement-snip.adoc[]
12+
13+
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
14+
15+
{logging-uc} is not:
16+
17+
* A high scale log collection system
18+
* Security Information and Event Monitoring (SIEM) compliant
19+
* A "bring your own" (BYO) log collector configuration
20+
* Historical or long term log retention or storage
21+
* A guaranteed log sink
22+
* Secure storage - audit logs are not stored by default
23+
24+
[id="cluster-logging-support-CRDs_{context}"]
25+
== Supported API custom resource definitions
26+
27+
The following table describes the supported {logging-uc} APIs.
28+
29+
include::snippets/log6x-api-support-states-snip.adoc[]
30+
31+
include::modules/cluster-logging-maintenance-support-list-6x.adoc[leveloffset=+1]
32+
include::modules/unmanaged-operators.adoc[leveloffset=+1]
33+
34+
[id="support-exception-for-coo-logging-ui-plugin_{context}"]
35+
== Support exception for the Logging UI Plugin
36+
37+
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.
38+
39+
[id="cluster-logging-support-must-gather_{context}"]
40+
== Collecting {logging} data for Red Hat Support
41+
42+
When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support.
43+
44+
You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
45+
For prompt support, supply diagnostic information for both {product-title} and {logging}.
46+
47+
include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2]
48+
include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2]

‎observability/logging/logging-6.2/log6x-clf-6.2.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Outputs are configured in an array under `spec.outputs`. Each output must have a
8181

8282
azureMonitor:: Forwards logs to Azure Monitor.
8383
cloudwatch:: Forwards logs to AWS CloudWatch.
84-
//elasticsearch:: Forwards logs to an external Elasticsearch instance.
84+
elasticsearch:: Forwards logs to an external Elasticsearch instance.
8585
googleCloudLogging:: Forwards logs to Google Cloud Logging.
8686
http:: Forwards logs to a generic HTTP endpoint.
8787
kafka:: Forwards logs to a Kafka broker.

‎observability/logging/cluster-logging-support.adoc renamed to ‎observability/logging/logging_release_notes/cluster-logging-support.adoc

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@ include::snippets/log6x-loki-statement-snip.adoc[]
1616

1717
* A high scale log collection system
1818
* Security Information and Event Monitoring (SIEM) compliant
19+
* A "bring your own" (BYO) log collector configuration
1920
* Historical or long term log retention or storage
2021
* A guaranteed log sink
2122
* Secure storage - audit logs are not stored by default
2223
2324
[id="cluster-logging-support-CRDs_{context}"]
2425
== Supported API custom resource definitions
2526

26-
LokiStack development is ongoing. Not all APIs are currently supported.
27+
The following table describes the supported {logging-uc} APIs.
2728

2829
.Loki API support states
2930
[cols="3",options="header"]
@@ -34,19 +35,27 @@ LokiStack development is ongoing. Not all APIs are currently supported.
3435

3536
|LokiStack
3637
|lokistack.loki.grafana.com/v1
37-
|Supported in 5.5
38+
|Supported from 5.5
3839

3940
|RulerConfig
4041
|rulerconfig.loki.grafana/v1
41-
|Supported in 5.7
42+
|Supported from 5.7
4243

4344
|AlertingRule
4445
|alertingrule.loki.grafana/v1
45-
|Supported in 5.7
46+
|Supported from 5.7
4647

4748
|RecordingRule
4849
|recordingrule.loki.grafana/v1
49-
|Supported in 5.7
50+
|Supported from 5.7
51+
52+
|LogFileMetricExporter
53+
|LogFileMetricExporter.logging.openshift.io/v1alpha1
54+
|Supported from 5.8
55+
56+
|ClusterLogForwarder
57+
|clusterlogforwarder.logging.openshift.io/v1
58+
|Supported from 4.5.
5059
|===
5160

5261
include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1]
@@ -62,14 +71,8 @@ Until the approaching General Availability (GA) release of the Cluster Observabi
6271

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

65-
You can use the xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
66-
74+
You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
6775
For prompt support, supply diagnostic information for both {product-title} and {logging}.
6876

69-
[NOTE]
70-
====
71-
Do not use the `hack/logging-dump.sh` script. The script is no longer supported and does not collect data.
72-
====
73-
7477
include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2]
7578
include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2]

‎snippets/log6x-api-support-states-snip.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Text snippet included in the following assemblies:
2+
// logging/logging-6.2/log62-cluster-logging-support.adoc
3+
// logging/logging-6.1/log61-cluster-logging-support.adoc
4+
//logging/logging-6.0/log60-cluster-logging-support.adoc
5+
// Text snippet included in the following modules:
6+
//
7+
//
8+
:_mod-docs-content-type: SNIPPET
9+
10+
.Logging API support states
11+
[cols="3",options="header"]
12+
|===
13+
|CustomResourceDefinition (CRD)
14+
|ApiVersion
15+
|Support state
16+
17+
|LokiStack
18+
|lokistack.loki.grafana.com/v1
19+
|Supported from 5.5
20+
21+
|RulerConfig
22+
|rulerconfig.loki.grafana/v1
23+
|Supported from 5.7
24+
25+
|AlertingRule
26+
|alertingrule.loki.grafana/v1
27+
|Supported from 5.7
28+
29+
|RecordingRule
30+
|recordingrule.loki.grafana/v1
31+
|Supported from 5.7
32+
33+
|LogFileMetricExporter
34+
|LogFileMetricExporter.logging.openshift.io/v1alpha1
35+
|Supported from 5.8
36+
37+
|ClusterLogForwarder
38+
|clusterlogforwarder.observability.openshift.io/v1
39+
|Supported from 6.0
40+
|===

0 commit comments

Comments
 (0)