Skip to content

Commit 737a435

Browse files
authored
Merge pull request #59109 from libander/RHDEVDOCS-2671
RHDEVDOCS-2671 - Logging support considerations
2 parents 992359c + afb4238 commit 737a435

File tree

5 files changed

+39
-6
lines changed

5 files changed

+39
-6
lines changed

logging/cluster-logging.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Because the internal {product-title} Elasticsearch log store does not provide se
2222
====
2323
endif::[]
2424

25+
include::modules/logging-support-considerations.adoc[leveloffset=+1]
26+
2527
// The following include statements pull in the module files that comprise
2628
// the assembly. Include any combination of concept, procedure, or reference
2729
// modules required to cover the user story. You can also include other

logging/v5_5/logging-5-5-architecture.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
:context: logging-5-5-architecture
10-
include::modules/logging-architecture-overview.adoc[lines=9..31]
10+
include::modules/logging-architecture-overview.adoc[leveloffset=+1,lines=9..31]
11+
12+
include::modules/logging-support-considerations.adoc[leveloffset=+1]
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
:_content-type: ASSEMBLY
22
[id="logging-architecture-5-6"]
3-
= Administering your logging deployment
3+
= Understanding logging
44
include::_attributes/common-attributes.adoc[]
55
:context: logging-5.6-architecture
66

77
toc::[]
88

9-
:context: logging-5-6-architecture
10-
include::modules/logging-architecture-overview.adoc[lines=9..31]
9+
10+
include::modules/logging-architecture-overview.adoc[leveloffset=+1,lines=9..31]
11+
12+
include::modules/logging-support-considerations.adoc[leveloffset=+1]

logging/v5_6/logging-5-6-getting-started.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
= Getting started with logging 5.6
55

66
This overview of the logging deployment process is provided for ease of reference. It is not a substitute for full documentation. For new installations, *Vector* and *LokiStack* are recommended.
7-
+
7+
88
--
99
include::snippets/logging-under-construction-snip.adoc[]
1010
--
@@ -15,7 +15,7 @@ include::snippets/logging-compatibility-snip.adoc[]
1515

1616
.Prerequisites
1717
* LogStore preference: *Elasticsearch* or *LokiStack*
18-
* Collector implementation preference: *Fluentd* or *Vector*
18+
* Collector implementation preference: *Fluentd* or *Vector*
1919
* Credentials for your log forwarding outputs
2020

2121
.Procedure
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
// logging/v5_6/logging-5-6-architecture.adoc
3+
4+
:_content-type: CONCEPT
5+
[id="logging-support-considerations_{context}"]
6+
= Support considerations for logging
7+
8+
include::snippets/logging-compatibility-snip.adoc[]
9+
10+
include::snippets/logging-supported-config-snip.adoc[]
11+
12+
The following modifications are explicitly not supported:
13+
14+
* *Deploying logging to namespaces not specified in the documentation.*
15+
* *Installing custom Elasticsearch, Kibana, Fluentd, or Loki instances on {product-title}.*
16+
* *Changes to the Kibana Custom Resource (CR) or Elasticsearch CR.*
17+
* *Changes to secrets or config maps not specified in the documentation.*
18+
19+
The {logging-title} 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.
20+
21+
The {logging-title} is not:
22+
23+
* A high scale log collection system
24+
* Security Information and Event Monitoring (SIEM) compliant
25+
* Historical or long term log retention or storage
26+
* A guaranteed log sink
27+
* Secure storage - audit logs are not stored by default

0 commit comments

Comments
 (0)