Skip to content

Commit 8b82bd6

Browse files
rolfedhrolfedh
authored
Merge pull request #56096 from libander/RHDEVDOCS-4448-quick
RHDEVDOCS-4448 - Restructure Phase 1
2 parents 9b6379c + 3f66daa commit 8b82bd6

24 files changed

+648
-44
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2367,6 +2367,38 @@ Distros: openshift-enterprise,openshift-origin
23672367
Topics:
23682368
- Name: Release notes
23692369
File: cluster-logging-release-notes
2370+
- Name: Logging 5.6 (EUS)
2371+
Dir: v5_6
2372+
Distros: openshift-enterprise,openshift-origin
2373+
Topics:
2374+
- Name: Logging 5.6 Release Notes
2375+
File: logging-5-6-release-notes
2376+
- Name: Getting started with logging
2377+
File: logging-5-6-getting-started
2378+
- Name: Understanding Logging
2379+
File: logging-5-6-architecture
2380+
- Name: Configuring Logging
2381+
File: logging-5-6-configuration
2382+
- Name: Administering Logging
2383+
File: logging-5-6-administration
2384+
- Name: Logging Reference
2385+
File: logging-5-6-reference
2386+
- Name: Logging 5.5
2387+
Dir: v5_5
2388+
Distros: openshift-enterprise,openshift-origin
2389+
Topics:
2390+
- Name: Logging 5.5 Release Notes
2391+
File: logging-5-5-release-notes
2392+
- Name: Getting started with logging
2393+
File: logging-5-5-getting-started
2394+
- Name: Understanding Logging
2395+
File: logging-5-5-architecture
2396+
- Name: Administering Logging
2397+
File: logging-5-5-administration
2398+
- Name: Configuring Logging
2399+
File: logging-5-5-configuration
2400+
- Name: Logging Reference
2401+
File: logging-5-5-reference
23702402
- Name: About Logging
23712403
File: cluster-logging
23722404
- Name: Installing Logging
@@ -2437,34 +2469,6 @@ Topics:
24372469
- Name: Exported fields
24382470
File: cluster-logging-exported-fields
24392471
Distros: openshift-enterprise,openshift-origin
2440-
#- Name: Logging 5.5
2441-
# Dir: v5_5
2442-
# Distros: openshift-enterprise,openshift-origin
2443-
# Topics:
2444-
# - Name: Logging 5.5 Release Notes
2445-
# File: logging-5-5-release-notes
2446-
# - Name: Understanding Logging
2447-
# File: logging-5-5-architecture
2448-
# - Name: Administering Logging
2449-
# File: logging-5-5-administration
2450-
# - Name: Configuring Logging
2451-
# File: logging-5-5-configuration
2452-
# - Name: Logging Reference
2453-
# File: logging-5-5-reference
2454-
#- Name: Logging 5.6
2455-
# Dir: v5_6
2456-
# Distros: openshift-enterprise,openshift-origin
2457-
# Topics:
2458-
# - Name: Logging 5.6 Release Notes
2459-
# File: logging-5-6-release-notes
2460-
# - Name: Understanding Logging
2461-
# File: logging-5-6-architecture
2462-
# - Name: Configuring Logging
2463-
# File: logging-5-6-configuration
2464-
# - Name: Administering Logging
2465-
# File: logging-5-6-administration
2466-
# - Name: Logging Reference
2467-
# File: logging-5-6-reference
24682472
---
24692473
Name: Monitoring
24702474
Dir: monitoring

‎logging/v5_5/logging-5-5-administration.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,18 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.5-administration
66

77
toc::[]
8+
9+
//Installing the Red Hat OpenShift Logging Operator via webconsole
10+
include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
11+
12+
//Installing the Loki Operator via webconsole
13+
include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
14+
15+
//Generic installing operators from operator hub using CLI
16+
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
17+
18+
//Generic deleting operators from cluster using web console
19+
include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]
20+
21+
//Generic deleting operators from a cluster using CLI
22+
include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+1]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.5-architecture
66

77
toc::[]
8+
9+
:context: logging-5-5-architecture
10+
include::modules/logging-architecture-overview.adoc[lines=9..31]

‎logging/v5_5/logging-5-5-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.5-configuration
66

77
toc::[]
8+
9+
include::snippets/logging-crs-by-operator-snip.adoc[]
10+
11+
include::snippets/logging-supported-config-snip.adoc[]

‎logging/v5_5/logging-5-5-getting-started.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
:_content-type: ASSEMBLY
2+
3+
[id="logging-5-5-getting-started"]
4+
= Getting started with logging 5.5
5+
6+
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+
8+
--
9+
include::snippets/logging-under-construction-snip.adoc[]
10+
--
11+
12+
--
13+
include::snippets/logging-compatibility-snip.adoc[]
14+
--
15+
16+
.Prerequisites
17+
* LogStore preference: *Elasticsearch* or *LokiStack*
18+
* Collector implementation preference: *Fluentd* or *Vector* See the xref:../logging-5-5-reference.adoc[Logging reference] to review the differences between Fluentd and Vector implementations.
19+
* Credentials for your log forwarding outputs
20+
21+
.Procedure
22+
--
23+
include::snippets/logging-elastic-dep-snip.adoc[]
24+
--
25+
. Install the Operator for the logstore you'd like to use.
26+
** For *Elasticsearch*, install the *OpenShift Elasticsearch Operator*.
27+
** For *LokiStack*, install the *Loki Operator*.
28+
*** Create a `LokiStack` custom resource (CR) instance.
29+
30+
. Install the *Red Hat OpenShift Logging Operator*.
31+
32+
. Create a `ClusterLogging` custom resource (CR) instance.
33+
.. Select your Collector Implementation.
34+
+
35+
--
36+
include::snippets/logging-fluentd-dep-snip.adoc[]
37+
--
38+
. Create a `ClusterLogForwarder` custom resource (CR) instance. See the xref:../logging-5-5-reference.adoc[Logging reference] to review the available output options for the collector implementation you've selected.
39+
40+
. Create a secret for the selected output pipeline.

‎logging/v5_6/logging-5-6-administration.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,18 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.6-administration
66

77
toc::[]
8+
9+
//Installing the Red Hat OpenShift Logging Operator via webconsole
10+
include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
11+
12+
//Installing the Loki Operator via webconsole
13+
include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
14+
15+
//Generic installing operators from operator hub using CLI
16+
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
17+
18+
//Generic deleting operators from cluster using web console
19+
include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]
20+
21+
//Generic deleting operators from a cluster using CLI
22+
include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+1]

‎logging/v5_6/logging-5-6-architecture.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.6-architecture
66

77
toc::[]
8+
9+
:context: logging-5-6-architecture
10+
include::modules/logging-architecture-overview.adoc[lines=9..31]

‎logging/v5_6/logging-5-6-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ include::_attributes/common-attributes.adoc[]
55
:context: logging-5.6-configuration
66

77
toc::[]
8+
9+
include::snippets/logging-crs-by-operator-snip.adoc[]
10+
11+
include::snippets/logging-supported-config-snip.adoc[]

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
:_content-type: ASSEMBLY
2+
3+
[id="logging-getting-started-5-6"]
4+
= Getting started with logging 5.6
5+
6+
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+
+
8+
--
9+
include::snippets/logging-under-construction-snip.adoc[]
10+
--
11+
12+
--
13+
include::snippets/logging-compatibility-snip.adoc[]
14+
--
15+
16+
.Prerequisites
17+
* LogStore preference: *Elasticsearch* or *LokiStack*
18+
* Collector implementation preference: *Fluentd* or *Vector* See the xref:../logging-5-6-reference.adoc[Logging reference] to review the differences between Fluentd and Vector implementations.
19+
* Credentials for your log forwarding outputs
20+
21+
.Procedure
22+
--
23+
include::snippets/logging-elastic-dep-snip.adoc[]
24+
--
25+
. Install the Operator for the logstore you'd like to use.
26+
** For *Elasticsearch*, install the *OpenShift Elasticsearch Operator*.
27+
** For *LokiStack*, install the *Loki Operator*.
28+
*** Create a `LokiStack` custom resource (CR) instance.
29+
30+
. Install the *Red Hat OpenShift Logging Operator*.
31+
32+
. Create a `ClusterLogging` custom resource (CR) instance.
33+
.. Select your Collector Implementation.
34+
+
35+
--
36+
include::snippets/logging-fluentd-dep-snip.adoc[]
37+
--
38+
. Create a `ClusterLogForwarder` custom resource (CR) instance. See the xref:../logging-5-5-reference.adoc[Logging reference] to review the available output options for the collector implementation you've selected.
39+
40+
. Create a secret for the selected output pipeline.

‎logging/v5_6/logging-5-6-release-notes.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,13 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
include::snippets/logging-compatibility-snip.adoc[]
10+
11+
include::snippets/logging-stable-updates-snip.adoc[]
12+
13+
include::modules/logging-rn-5.6.3.adoc[leveloffset=+1]
14+
15+
include::modules/logging-rn-5.6.2.adoc[leveloffset=+1]
16+
17+
include::modules/logging-rn-5.6.1.adoc[leveloffset=+1]
18+
19+
include::modules/logging-rn-5.6.0.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)