Merge pull request #85401 from mramendi/cicd-observability-overviews-4.16

Preeticp · web-flow · commit 1b5fecfa19b5 · 2024-11-25T21:35:25.000+05:30
OSDOCS 12388 ci/cd and observability overview books
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2041,7 +2041,11 @@ Dir: cicd
 Distros: openshift-enterprise,openshift-origin,openshift-online
 Topics:
 - Name: CI/CD overview
-  File: index
+  Dir: overview
+  Distros: openshift-enterprise,openshift-origin,openshift-online
+  Topics:
+  - Name: About CI/CD
+    File: index
 - Name: Builds using Shipwright
   Dir: builds_using_shipwright
   Distros: openshift-enterprise
@@ -2737,7 +2741,11 @@ Dir: observability
 Distros: openshift-enterprise,openshift-origin
 Topics:
 - Name: Observability overview
-  File: index
+  Dir: overview
+  Distros: openshift-enterprise,openshift-origin
+  Topics:
+  - Name: About Observability
+    File: index
 - Name: Monitoring
   Dir: monitoring
   Distros: openshift-enterprise,openshift-origin
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -463,7 +463,10 @@ Dir: cicd
 Distros: openshift-dedicated
 Topics:
 - Name: CI/CD overview
-  File: index
+  Dir: overview
+  Topics:
+  - Name: About CI/CD
+    File: index
 # This can be included when Shipwright is ported.
 # - Name: Builds using Shipwright
 #   Dir: builds_using_shipwright
@@ -1196,7 +1199,10 @@ Dir: observability
 Distros: openshift-dedicated
 Topics:
 - Name: Observability overview
-  File: index
+  Dir: overview
+  Topics:
+  - Name: About Observability
+    File: index
 - Name: Monitoring
   Dir: monitoring
   Distros: openshift-dedicated
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -732,7 +732,10 @@ Dir: cicd
 Distros: openshift-rosa
 Topics:
 - Name: CI/CD overview
-  File: index
+  Dir: overview
+  Topics:
+  - Name: About CI/CD
+    File: index
 # This can be included when Shipwright is ported.
 # - Name: Builds using Shipwright
 #   Dir: builds_using_shipwright
@@ -1491,7 +1494,10 @@ Dir: observability
 Distros: openshift-rosa
 Topics:
 - Name: Observability overview
-  File: index
+  Dir: overview
+  Topics:
+  - Name: About Observability
+    File: index
 - Name: Monitoring
   Dir: monitoring
   Distros: openshift-rosa
diff --git a/cicd/overview/_attributes b/cicd/overview/_attributes
@@ -0,0 +1 @@
+../../_attributes
diff --git a/cicd/overview/images b/cicd/overview/images
@@ -0,0 +1 @@
+../../images
diff --git a/cicd/overview/index.adoc b/cicd/overview/index.adoc
@@ -1,14 +1,14 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="ci-cd-overview"]
-= {product-title} CI/CD overview
+= About CI/CD
 include::_attributes/common-attributes.adoc[]
 :context: ci-cd-overview
 
 toc::[]
 
 // The Shipwright, Pipelines, and GitOps content is not currently included
-// in the OSD and ROSA docs. As these layered products are added to the 
-// OSD and ROSA docs, the applicable content and xrefs below should be 
+// in the OSD and ROSA docs. As these layered products are added to the
+// OSD and ROSA docs, the applicable content and xrefs below should be
 // included.
 
 {product-title} is an enterprise-ready Kubernetes platform for developers, which enables organizations to automate the application delivery process through DevOps practices, such as continuous integration (CI) and continuous delivery (CD). To meet your organizational needs, the {product-title} provides the following CI/CD solutions:
@@ -28,18 +28,18 @@ OpenShift Builds provides you the following options to configure and run a build
 
 * Builds using Shipwright is an extensible build framework based on the Shipwright project. You can use it to build container images on an {product-title} cluster. You can build container images from source code and Dockerfile by using image build tools, such as Source-to-Image (S2I) and Buildah.
 +
-For more information, see link:https://docs.openshift.com/builds/latest/about/overview-openshift-builds.html[Overview of Builds].
+For more information, see link:https://docs.redhat.com/en/documentation/builds_for_red_hat_openshift[builds for Red Hat OpenShift].
 
 * Builds using `BuildConfig` objects is a declarative build process to create cloud-native apps. You can define the build process in a YAML file that you use to create a `BuildConfig` object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the `BuildConfig` object builds a runnable image and pushes the image to a container image registry. With the `BuildConfig` object, you can create a Docker, Source-to-image (S2I), or custom build.
 +
-For more information, see xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
+For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
 endif::openshift-dedicated,openshift-rosa[]
 
 // This is the same para as above, but without the unordered list.
 ifdef::openshift-dedicated,openshift-rosa[]
 Builds using `BuildConfig` objects is a declarative build process to create cloud-native apps. You can define the build process in a YAML file that you use to create a `BuildConfig` object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the `BuildConfig` object builds a runnable image and pushes the image to a container image registry. With the `BuildConfig` object, you can create a Docker, Source-to-image (S2I), or custom build.
 
-For more information, see xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
+For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
 endif::openshift-dedicated,openshift-rosa[]
 
 // This can be included in OSD and ROSA when the Pipelines doc is ported.
@@ -48,7 +48,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
 == {pipelines-shortname}
 {pipelines-shortname} provides a Kubernetes-native CI/CD framework to design and run each step of the CI/CD pipeline in its own container. It can scale independently to meet the on-demand pipelines with predictable outcomes.
 
-For more information, see link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[Understanding {pipelines-shortname}].
+For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines[Red Hat OpenShift Pipelines].
 endif::openshift-dedicated,openshift-rosa[]
 
 // This can be included in OSD and ROSA when the GitOps doc is ported.
@@ -57,9 +57,11 @@ ifndef::openshift-dedicated,openshift-rosa[]
 == OpenShift GitOps
 OpenShift GitOps is an Operator that uses Argo CD as the declarative GitOps engine. It enables GitOps workflows across multicluster OpenShift and Kubernetes infrastructure. Using OpenShift GitOps, administrators can consistently configure and deploy Kubernetes-based infrastructure and applications across clusters and development lifecycles.
 
-For more information, see xref:../cicd/gitops/about-redhat-openshift-gitops.adoc#about-redhat-openshift-gitops[About {gitops-title}].
+For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_gitops[Red Hat OpenShift GitOps].
 endif::openshift-dedicated,openshift-rosa[]
 
 [id="jenkins-ci-cd"]
 == Jenkins
 Jenkins automates the process of building, testing, and deploying applications and projects. OpenShift Developer Tools provides a Jenkins image that integrates directly with the {product-title}. Jenkins can be deployed on OpenShift by using the Samples Operator templates or certified Helm chart.
+
+For more information, see xref:../../cicd/jenkins/images-other-jenkins.adoc#images-other-jenkins[Configuring Jenkins images].
diff --git a/cicd/overview/modules b/cicd/overview/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/cicd/overview/snippets b/cicd/overview/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/modules/op-about-workspace-optional.adoc b/modules/op-about-workspace-optional.adoc
@@ -0,0 +1,5 @@
+// This module is included in the following assemblies:
+// * about/understanding-openshift-pipelines.adoc
+
+[id="about-workspaces-optional_{context}"]
+= Workspaces
diff --git a/observability/overview/_attributes b/observability/overview/_attributes
@@ -0,0 +1 @@
+../../_attributes
diff --git a/observability/overview/images b/observability/overview/images
@@ -0,0 +1 @@
+../../images
diff --git a/observability/overview/index.adoc b/observability/overview/index.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="observability-overview"]
-= {product-title} Observability overview
+= About Observability
 include::_attributes/common-attributes.adoc[]
 :context: observability-overview
 
@@ -36,37 +36,36 @@ Monitor the in-cluster health and performance of your applications running on {p
 
 Monitoring stack components are deployed by default in every {product-title} installation and are managed by the {cmo-first}. These components include Prometheus, Alertmanager, Thanos Querier, and others. The {cmo-short} also deploys the Telemeter Client, which sends a subset of data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters.
 
-For more information, see xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring].
+For more information, see xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring].
 
 [id="cluster-logging-index_{context}"]
 == Logging
 Collect, visualize, forward, and store log data to troubleshoot issues, identify performance bottlenecks, and detect security threats. In logging 5.7 and later versions, users can configure the LokiStack deployment to produce customized alerts and recorded metrics.
 
-For more information, see xref:../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
+For more information, see xref:../../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
 
 ifdef::openshift-enterprise,openshift-origin[]
 [id="distr-tracing-architecture-index_{context}"]
 == Distributed tracing
 Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use it for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
 
-For more information, see xref:distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
+For more information, see xref:../../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
 
 [id="otel-release-notes-index_{context}"]
 == {OTELName}
 Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open-source back ends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate.
 
-For more information, see xref:otel/otel-installing.adoc#install-otel[{OTELName}].
+For more information, see xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}].
 
 [id="network-observability-overview-index_{context}"]
 == Network Observability
 Observe the network traffic for {product-title} clusters and create network flows with the Network Observability Operator. View and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting.
 
-For more information, see xref:../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
+For more information, see xref:../../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
 
 [id="power-monitoring-overview-index_{context}"]
 == Power monitoring
 Monitor the power usage of workloads and identify the most power-consuming namespaces running in a cluster with key power consumption metrics, such as CPU or DRAM measured at the container level. Visualize energy-related system statistics with the {PM-operator}.
 
-For more information, see xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power monitoring overview].
+For more information, see xref:../../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power monitoring overview].
 endif::[]
-
diff --git a/observability/overview/modules b/observability/overview/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/observability/overview/snippets b/observability/overview/snippets
@@ -0,0 +1 @@
+../../snippets/
