Skip to content

Commit 07a23ba

Browse files
authored
Merge pull request #93374 from gabriel-rh/OBSDOCS-1900
OBSDOCS-1900 promote quick start content
2 parents 11a8b84 + 250754b commit 07a23ba

File tree

3 files changed

+26
-20
lines changed

3 files changed

+26
-20
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Distros: openshift-logging
55
Topics:
66
- Name: Logging overview
77
File: about-logging
8+
- Name: Quick start
9+
File: quick-start
810
- Name: Cluster logging support
911
File: cluster-logging-support
1012
- Name: Visualization for logging

about/about-logging.adoc

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `ClusterLogForwarder` custom resource (CR) is the central configuration poin
1212
== Inputs and outputs
1313

1414
Inputs specify the sources of logs to be forwarded. Logging provides the following built-in input types that select logs from different parts of your cluster:
15-
15+
1616
* `application`
1717
* `receiver`
1818
* `infrastructure`
@@ -44,22 +44,3 @@ The Cluster Logging Operator manages the deployment and configuration of the col
4444
[id="validation_{context}"]
4545
== Validation
4646
Logging includes extensive validation rules and default values to ensure a smooth and error-free configuration experience. The `ClusterLogForwarder` resource enforces validation checks on required fields, dependencies between fields, and the format of input values. Default values are provided for certain fields, reducing the need for explicit configuration in common scenarios.
47-
48-
[id="quick-start_{context}"]
49-
== Quick start
50-
51-
OpenShift Logging supports two data models:
52-
53-
* ViaQ (General Availability)
54-
* OpenTelemetry (Technology Preview)
55-
56-
You can select either of these data models based on your requirement by configuring the `lokiStack.dataModel` field in the `ClusterLogForwarder`. ViaQ is the default data model when forwarding logs to LokiStack.
57-
58-
[NOTE]
59-
====
60-
In future releases of OpenShift Logging, the default data model will change from ViaQ to OpenTelemetry.
61-
====
62-
63-
include::modules/quickstart-viaq.adoc[leveloffset=+2]
64-
65-
include::modules/quickstart-opentelemetry.adoc[leveloffset=+2]

about/quick-start.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="quick-start"]
4+
= Quick start
5+
:context: quick-start
6+
7+
toc::[]
8+
9+
OpenShift Logging supports two data models:
10+
11+
* ViaQ (General Availability)
12+
* OpenTelemetry (Technology Preview)
13+
14+
You can select either of these data models based on your requirement by configuring the `lokiStack.dataModel` field in the `ClusterLogForwarder`. ViaQ is the default data model when forwarding logs to LokiStack.
15+
16+
[NOTE]
17+
====
18+
In future releases of OpenShift Logging, the default data model will change from ViaQ to OpenTelemetry.
19+
====
20+
21+
include::modules/quickstart-viaq.adoc[leveloffset=+1]
22+
23+
include::modules/quickstart-opentelemetry.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)