RHDEVDOCS-5176 - 5.7 Subfolder creation.

libander · libander · commit 6a19d5b863a0 · 2023-05-02T02:47:11.000-05:00
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2442,6 +2442,22 @@ Distros: openshift-enterprise,openshift-origin
 Topics:
 - Name: Release notes
   File: cluster-logging-release-notes
+#- Name: Logging 5.7
+#  Dir: v5_7
+#  Distros: openshift-enterprise,openshift-origin
+#  Topics:
+#  Name: Logging 5.7 Release Notes
+#  File: logging-5-7-release-notes
+#  Name: Getting started with logging
+#  File: logging-5-7-getting-started
+#  Name: Understanding Logging
+#  File: logging-5-7-architecture
+#  Name: Configuring Logging
+#  File: logging-5-7-configuration
+#  Name: Administering Logging
+#  File: logging-5-7-administration
+#  Name: Logging Reference
+#  File: logging-5-7-reference
 - Name: Logging 5.6
   Dir: v5_6
   Distros: openshift-enterprise,openshift-origin
diff --git a/logging/v5_5/logging-5-5-getting-started.adoc b/logging/v5_5/logging-5-5-getting-started.adoc
@@ -3,38 +3,5 @@
 [id="logging-5-5-getting-started"]
 = Getting started with logging 5.5
 
-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.
-
---
-include::snippets/logging-under-construction-snip.adoc[]
---
-
---
-include::snippets/logging-compatibility-snip.adoc[]
---
-
-.Prerequisites
-* LogStore preference: *Elasticsearch* or *LokiStack*
-* Collector implementation preference: *Fluentd* or *Vector*
-* Credentials for your log forwarding outputs
-
-.Procedure
---
-include::snippets/logging-elastic-dep-snip.adoc[]
---
-. Install the Operator for the logstore you'd like to use.
-** For *Elasticsearch*, install the *OpenShift Elasticsearch Operator*.
-** For *LokiStack*, install the *Loki Operator*.
-*** Create a `LokiStack` custom resource (CR) instance.
-
-. Install the *Red Hat OpenShift Logging Operator*.
-
-. Create a `ClusterLogging` custom resource (CR) instance.
-.. Select your Collector Implementation.
-+
---
-include::snippets/logging-fluentd-dep-snip.adoc[]
---
-. Create a `ClusterLogForwarder` custom resource (CR) instance.
-
-. Create a secret for the selected output pipeline.
+:context: logging-5-5-getting-started
+include::modules/logging-getting-started.adoc[lines=5..39]
diff --git a/logging/v5_6/logging-5-6-architecture.adoc b/logging/v5_6/logging-5-6-architecture.adoc
@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="logging-architecture-5-6"]
-= Understanding logging
+= Understanding logging architecture
 include::_attributes/common-attributes.adoc[]
 :context: logging-5.6-architecture
 
diff --git a/logging/v5_6/logging-5-6-getting-started.adoc b/logging/v5_6/logging-5-6-getting-started.adoc
@@ -3,38 +3,5 @@
 [id="logging-getting-started-5-6"]
 = Getting started with logging 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.
-
---
-include::snippets/logging-under-construction-snip.adoc[]
---
-
---
-include::snippets/logging-compatibility-snip.adoc[]
---
-
-.Prerequisites
-* LogStore preference: *Elasticsearch* or *LokiStack*
-* Collector implementation preference: *Fluentd* or *Vector*
-* Credentials for your log forwarding outputs
-
-.Procedure
---
-include::snippets/logging-elastic-dep-snip.adoc[]
---
-. Install the Operator for the logstore you'd like to use.
-** For *Elasticsearch*, install the *OpenShift Elasticsearch Operator*.
-** For *LokiStack*, install the *Loki Operator*.
-*** Create a `LokiStack` custom resource (CR) instance.
-
-. Install the *Red Hat OpenShift Logging Operator*.
-
-. Create a `ClusterLogging` custom resource (CR) instance.
-.. Select your Collector Implementation.
-+
---
-include::snippets/logging-fluentd-dep-snip.adoc[]
---
-. Create a `ClusterLogForwarder` custom resource (CR) instance.
-
-. Create a secret for the selected output pipeline.
+:context: logging-5-6-getting-started
+include::modules/logging-getting-started.adoc[lines=5..39]
diff --git a/logging/v5_7/attributes b/logging/v5_7/attributes
@@ -0,0 +1 @@
+../../_attributes/
diff --git a/logging/v5_7/images b/logging/v5_7/images
@@ -0,0 +1 @@
+../../images/
diff --git a/logging/v5_7/logging-5-7-administration.adoc b/logging/v5_7/logging-5-7-administration.adoc
@@ -0,0 +1,22 @@
+:_content-type: ASSEMBLY
+[id="logging-administration-5-7"]
+= Administering your logging deployment
+include::_attributes/common-attributes.adoc[]
+:context: logging-5.7-administration
+
+toc::[]
+
+//Installing the Red Hat OpenShift Logging Operator via webconsole
+include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
+
+//Installing the Loki Operator via webconsole
+include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
+
+//Generic installing operators from operator hub using CLI
+include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
+
+//Generic deleting operators from cluster using web console
+include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]
+
+//Generic deleting operators from a cluster using CLI
+include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+1]
diff --git a/logging/v5_7/logging-5-7-architecture.adoc b/logging/v5_7/logging-5-7-architecture.adoc
@@ -0,0 +1,10 @@
+:_content-type: ASSEMBLY
+[id="logging-architecture-5-7"]
+= Understanding logging architecture
+include::_attributes/common-attributes.adoc[]
+:context: logging-5.7-architecture
+
+toc::[]
+
+:context: logging-5-7-architecture
+include::modules/logging-architecture-overview.adoc[lines=9..31]
diff --git a/logging/v5_7/logging-5-7-configuration.adoc b/logging/v5_7/logging-5-7-configuration.adoc
@@ -0,0 +1,11 @@
+:_content-type: ASSEMBLY
+[id="logging-configuration-5-7"]
+= Configuring your logging deployment
+include::_attributes/common-attributes.adoc[]
+:context: logging-5.7-configuration
+
+toc::[]
+
+include::snippets/logging-crs-by-operator-snip.adoc[]
+
+include::snippets/logging-supported-config-snip.adoc[]
diff --git a/logging/v5_7/logging-5-7-getting-started.adoc b/logging/v5_7/logging-5-7-getting-started.adoc
@@ -0,0 +1,7 @@
+:_content-type: ASSEMBLY
+
+[id="logging-getting-started-5-7"]
+= Getting started with logging 5.7
+
+:context: logging-5-7-getting-started
+include::modules/logging-getting-started.adoc[lines=5..39]
diff --git a/logging/v5_7/logging-5-7-reference.adoc b/logging/v5_7/logging-5-7-reference.adoc
@@ -0,0 +1,7 @@
+:_content-type: ASSEMBLY
+[id="logging-reference-5-7"]
+= Logging References
+include::_attributes/common-attributes.adoc[]
+:context: logging-5.7-reference
+
+toc::[]
diff --git a/logging/v5_7/logging-5-7-release-notes.adoc b/logging/v5_7/logging-5-7-release-notes.adoc
@@ -0,0 +1,11 @@
+:_content-type: ASSEMBLY
+[id="logging-release-notes-5-7"]
+= Logging 5.7 Release Notes
+include::_attributes/common-attributes.adoc[]
+:context: logging-5.7-release-notes
+
+toc::[]
+
+include::snippets/logging-compatibility-snip.adoc[]
+
+include::snippets/logging-stable-updates-snip.adoc[]
diff --git a/logging/v5_7/modules b/logging/v5_7/modules
@@ -0,0 +1 @@
+../../modules/
diff --git a/logging/v5_7/snippets b/logging/v5_7/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/modules/logging-getting-started.adoc b/modules/logging-getting-started.adoc
@@ -0,0 +1,45 @@
+:_content-type: PROCEDURE
+[id="logging-getting-started_{context}"]
+= Getting started with logging
+
+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.
+
+--
+include::snippets/logging-under-construction-snip.adoc[]
+--
+
+--
+include::snippets/logging-compatibility-snip.adoc[]
+--
+
+.Prerequisites
+* Log store preference: Elasticsearch or LokiStack
+* Collector implementation preference: Fluentd or Vector
+* Credentials for your log forwarding outputs
+
+.Procedure
+
+--
+include::snippets/logging-elastic-dep-snip.adoc[]
+--
+
+. Install the Operator for the log store you'd like to use.
+** For Elasticsearch, install the *OpenShift Elasticsearch Operator*.
+** For LokiStack, install the *Loki Operator*.
++
+[NOTE]
+====
+If you have installed the Loki Operator, create a `LokiStack` custom resource (CR) instance as well.
+====
+
+. Install the *Red Hat OpenShift Logging* Operator.
+
+. Create a `ClusterLogging` CR instance.
+** Select your collector implementation.
++
+--
+include::snippets/logging-fluentd-dep-snip.adoc[]
+--
+. Create a `ClusterLogForwarder` CR instance.
+
+. Create a secret for the selected output pipeline.
diff --git a/snippets/logging-compatibility-snip.adoc b/snippets/logging-compatibility-snip.adoc
@@ -8,5 +8,5 @@
 
 [NOTE]
 ====
-The {logging-title} is provided as an installable component, with a distinct release cycle from the core {product-title}. The link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy] outlines release compatibility.
+Logging is provided as an installable component, with a distinct release cycle from the core {product-title}. The link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy] outlines release compatibility.
 ====
diff --git a/snippets/logging-elastic-dep-snip.adoc b/snippets/logging-elastic-dep-snip.adoc
@@ -8,5 +8,5 @@
 
 [NOTE]
 ====
-As of logging version 5.4.3 the Elasticsearch Operator is deprecated and is planned to be removed in a future release. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to using the Elasticsearch Operator to manage the default log storage, you can use the Loki Operator.
+As of logging version 5.4.3 the OpenShift Elasticsearch Operator is deprecated and is planned to be removed in a future release. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to using the OpenShift Elasticsearch Operator to manage the default log storage, you can use the Loki Operator.
 ====
