Skip to content

Commit ca79a62

Browse files
committed
Logging 6x - Docs Skeleton for Collab/Feedback.
1 parent d855388 commit ca79a62

15 files changed

+2123
-3
lines changed

_topic_maps/_topic_map.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2709,6 +2709,17 @@ Topics:
27092709
File: logging-5-8-release-notes
27102710
- Name: Logging 5.7
27112711
File: logging-5-7-release-notes
2712+
- Name: Logging 6.0
2713+
Dir: logging-6.0
2714+
Topics:
2715+
- Name: About Logging 6.0
2716+
File: log6x-about
2717+
- Name: Getting started
2718+
File: log6x-start
2719+
- Name: Configuring log forwarding
2720+
File: log6x-clf
2721+
- Name: Configuring LokiStack storage
2722+
File: log6x-loki
27122723
- Name: Support
27132724
File: cluster-logging-support
27142725
- Name: Troubleshooting logging

modules/log6x-oc-explain.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
// Module included in the following assemblies:
3+
//
4+
:_mod-docs-content-type: CONCEPT
5+
[id="log6x-oc-explain_{context}"]
6+
7+
= Using the `oc explain` command
8+
9+
The `oc explain` command is an essential tool in the OpenShift Command-Line Interface (CLI) that provides detailed descriptions of the fields within Kubernetes resources, including Custom Resources (CRs) introduced by Operators. This command is invaluable for administrators and developers who are configuring or troubleshooting resources in an OpenShift cluster.
10+
11+
. *Resource Descriptions*: It offers in-depth explanations of all fields associated with a specific Kubernetes or Custom Resource. This includes standard resources like pods and services, as well as more complex entities like statefulsets.
12+
13+
. *Hierarchical Structure*: The command displays the structure of resource fields in a hierarchical format, clarifying the relationships between different configuration options. This hierarchical view is crucial for proper configuration.
14+
15+
. *Type Information*: `oc explain` also indicates the type of each field (such as string, integer, or boolean), which is critical for ensuring that resource definitions are provided with correct data types.
16+
17+
. *Default Values*: When applicable, the command shows the default values for fields, providing insights into what values will be used if none are explicitly specified.

modules/logging-6x-v-5x.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="logging-6x-v-5x_{context}"]
7+
= OpenShift Logging 6.0: Key Differences from Previous Versions
8+
9+
OpenShift Logging 6.0 is the culmination of efforts to modernize the underlying components of the logging solution. Over the past few releases, Loki and Vector were gradually introduced with a focus on improving performance and enhancing features while maintaining the stability required for business continuity.
10+
11+
12+
* **Horizontal Scalability:** Loki's architecture allows for seamless horizontal scaling, ensuring that the logging system can handle the growing demands of large-scale OpenShift deployments.
13+
14+
* **Improved Query Performance:** Loki's indexing and query mechanisms are optimized for speed, enabling faster log retrieval and analysis.
15+
16+
* **Streamlined Configuration:** The removal of Elasticsearch and Fluentd simplify setup and configuration.
17+
18+
* **Improved Integration:** Loki and Vector offer tighter integration with OpenShift, providing a more seamless and native logging experience.
19+
20+
* **Expanded Log Sources:** Vector's flexibility allows you to collect logs from an even wider range of sources, providing greater visibility into your OpenShift environment.
21+
22+
* **Enhanced Log Processing:** Vector's processing capabilities have been expanded, enabling you to perform more complex filtering.
23+
24+
* **OpenShift Web Console:** The integrated Logs page offers a user-friendly interface for searching, filtering, and viewing logs directly within the OpenShift console.
25+
26+
* **Grafana:** OpenShift Logging integrates seamlessly with Grafana, enabling you to create rich, customizable dashboards to visualize and correlate log data with metrics and other observability data.

modules/logging-content-filter-drop-records.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * observability/logging/performance_reliability/logging-content-filtering.adoc
4+
// * observability/logging/logging-6.0/log6x-clf.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="logging-content-filter-drop-records_{context}"]
@@ -10,7 +11,6 @@ When the `drop` filter is configured, the log collector evaluates log streams ac
1011

1112
.Prerequisites
1213

13-
* You have installed the {clo}.
1414
* You have administrator permissions.
1515
* You have created a `ClusterLogForwarder` custom resource (CR).
1616

modules/logging-content-filter-prune-records.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * observability/logging/performance_reliability/logging-content-filtering.adoc
4-
4+
// * observability/logging/logging-6.0/log6x-clf.adoc
55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-content-filter-prune-records_{context}"]
77
= Configuring content filters to prune log records
@@ -10,7 +10,6 @@ When the `prune` filter is configured, the log collector evaluates log streams a
1010

1111
.Prerequisites
1212

13-
* You have installed the {clo}.
1413
* You have administrator permissions.
1514
* You have created a `ClusterLogForwarder` custom resource (CR).
1615

0 commit comments

Comments
 (0)