openshift · mburke5678 · Oct 30, 2024 · Oct 21, 2024 · Oct 30, 2024
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -27,23 +27,24 @@ Topics:
 - Name: Updating OpenShift Service Mesh
   File: ossm-updating-openshift-service-mesh
 ---
-Name: Metrics
-Dir: metrics
+Name: Observability
+Dir: observability
 Distros: openshift-service-mesh
 Topics:
-- Name: Using metrics with Service Mesh
-  File: ossm-metrics-assembly
----
-Name: Distributed tracing
-Dir: traces
-Distros: openshift-service-mesh
-Topics:
-- Name: Configuring distributed tracing with Service Mesh
-  File: ossm-distr-tracing-assembly
----
-Name: Kiali Operator provided by Red Hat
-Dir: kiali
-Distros: openshift-service-mesh
-Topics:
-- Name: Using Kiali Operator provided by Red Hat
-  File: ossm-kiali-assembly
+- Name: Observability and Service Mesh
+  File: ossm-observability-service-mesh-assembly
+- Name: Metrics and Service Mesh
+  Dir: metrics
+  Topics:
+  - Name: Using metrics with Service Mesh
+    File: ossm-metrics-assembly
+- Name: Distributed tracing and Service Mesh
+  Dir: traces
+  Topics:
+  - Name: Configuring distributed tracing with Service Mesh
+    File: ossm-distr-tracing-assembly
+- Name: Kiali Operator provided by Red Hat
+  Dir: kiali
+  Topics:
+  - Name: Using Kiali Operator provided by Red Hat
+    File: ossm-kiali-assembly
diff --git a/kiali/_attributes → observability/_attributes b/kiali/_attributes → observability/_attributes
diff --git a/observability/docinfo.xml b/observability/docinfo.xml
@@ -0,0 +1,12 @@
+<title>Observability</title>
+<productname>Red Hat OpenShift Service Mesh</productname>
+<productnumber>3.0.0tp1</productnumber>
+<subtitle>Observability and Service Mesh</subtitle>
+<abstract>
+    <para>This document provides an overview of Red Hat OpenShift Observability integrations with OpenShift Service Mesh.
+    </para>
+</abstract>
+<authorgroup>
+    <orgname>Red Hat OpenShift Documentation Team</orgname>
+</authorgroup>
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/kiali/images → observability/images b/kiali/images → observability/images
diff --git a/metrics/_attributes → observability/kiali/_attributes b/metrics/_attributes → observability/kiali/_attributes
diff --git a/kiali/docinfo.xml → observability/kiali/docinfo.xml b/kiali/docinfo.xml → observability/kiali/docinfo.xml
@@ -3,7 +3,7 @@
 <productnumber>3.0</productnumber>
 <subtitle>Using the Kiali Operator provided by Red Hat</subtitle>
 <abstract>
-    <para>This documentation provides information about the {KialiProduct}, and how to view the data that flows through your application.
+    <para>This documentation provides information about Kiali Operator provided by Red Hat, and how to view the data that flows through your application.
     </para>
 </abstract>
 <authorgroup>

diff --git a/metrics/images → observability/kiali/images b/metrics/images → observability/kiali/images
diff --git a/kiali/modules → observability/kiali/modules b/kiali/modules → observability/kiali/modules
diff --git a/kiali/ossm-kiali-assembly.adoc → observability/kiali/ossm-kiali-assembly.adoc b/kiali/ossm-kiali-assembly.adoc → observability/kiali/ossm-kiali-assembly.adoc
@@ -25,5 +25,7 @@ include::modules/ossm-config-otel-kiali.adoc[leveloffset=2]
 
 * xref:../traces/ossm-distr-tracing-assembly.html#ossm-config-otel_ossm-traces-assembly[Configuring {OTELName} with Service Mesh]
 
+//NOTES 10/24/2024: Will likely be renamed "Kiali provided by Red Hat and Service Mesh". 3.x IA is under development. Change will also necessitate change to Pantheon.
+
 // TP 1 content. Banner handled separately by different PR handled by Tim O'Keefe. Per Tim, banner should appear across all 3.0 content, nothing needs to be added to this file
 // Content may change, file names may change, directories may change, the order of directories may change, everything may change.
diff --git a/kiali/snippets → observability/kiali/snippets b/kiali/snippets → observability/kiali/snippets
diff --git a/traces/_attributes → observability/metrics/_attributes b/traces/_attributes → observability/metrics/_attributes
diff --git a/metrics/docinfo.xml → observability/metrics/docinfo.xml b/metrics/docinfo.xml → observability/metrics/docinfo.xml
diff --git a/traces/images → observability/metrics/images b/traces/images → observability/metrics/images
diff --git a/metrics/modules → observability/metrics/modules b/metrics/modules → observability/metrics/modules
diff --git a/metrics/ossm-metrics-assembly.adoc → ...bility/metrics/ossm-metrics-assembly.adoc b/metrics/ossm-metrics-assembly.adoc → ...bility/metrics/ossm-metrics-assembly.adoc
diff --git a/metrics/snippets → observability/metrics/snippets b/metrics/snippets → observability/metrics/snippets
diff --git a/traces/modules → observability/modules b/traces/modules → observability/modules
diff --git a/observability/ossm-observability-service-mesh-assembly.adoc b/observability/ossm-observability-service-mesh-assembly.adoc
@@ -0,0 +1,30 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ossm-observability-service-mesh-assembly"]
+= Observability and Service Mesh
+include::_attributes/common-attributes.adoc[]
+:context: ossm-observability-assembly
+
+toc::[]
+
+Red{nbsp}Hat OpenShift Observability provides real-time visibility, monitoring, and analysis of various system metrics, logs, and events to help you quickly diagnose and troubleshoot issues before they impact systems or applications.
+
+Red{nbsp}Hat OpenShift Observability connects open-source observability tools and technologies to create a unified Observability solution. The components of Red Hat OpenShift Observability work together to help you collect, store, deliver, analyze, and visualize data.
+
+{SMProductName} integrates with the following Red{nbsp}Hat OpenShift Observability components:
+
+* OpenShift Monitoring
+* {DTProductName}
+
+{SMProduct} also integrates with:
+
+* Kiali provided by Red{nbsp}Hat, a powerful console for visualizing and managing your service mesh.
+* {SMPlugin}, an {ocp-product-title} console plugin that seamlessly integrates Kiali console features into your {ocp-short-name} console.
+
+//Observability attributes are not part of the Service Mesh standalone attributes file as of 10/22/2024
+//There are Kiali attributes forthcoming.
+//Kiali Operator provided by Red Hat is the official, approved name, and the name that appears in the console UI when presented with Kiali Operator options to install.
+//There is a Jira created to add a number of attributes to the _attributes file for OSSM 3.0 GA.
+//There are more things coming for Metrics, distributed tracing, and Kiali. The Service Mesh Console (OSSMC) plugin, for example, will be added to the Kiali distro. It is unclear what is necessary for GA and what is  being pushed post-GA, so the directories and respective assemblies have been left for traces, metrics, and kiali.
+
+// TP 1 content. Banner handled separately by different PR handled by Tim O'Keefe. Per Tim, banner should appear across all 3.0 content, nothing needs to be added to this file
+// Content may change, file names may change, directories may change, the order of directories may change, everything may change.
diff --git a/traces/snippets → observability/snippets b/traces/snippets → observability/snippets
diff --git a/observability/traces/_attributes b/observability/traces/_attributes
@@ -0,0 +1 @@
+../_attributes
diff --git a/traces/docinfo.xml → observability/traces/docinfo.xml b/traces/docinfo.xml → observability/traces/docinfo.xml
@@ -3,7 +3,7 @@
 <productnumber>3.0</productnumber>
 <subtitle>Using distributed tracing with OpenShift Service Mesh</subtitle>
 <abstract>
-    <para>This document provides an overview of distributed tracing in {SMProduct}, and how to configure distributed tracing for {SMProductShortName}.
+    <para>This document provides an overview of distributed tracing in OpenShift Service Mesh, and how to configure distributed tracing for {SMProductShortName}.
     </para>
 </abstract>
 <authorgroup>

diff --git a/observability/traces/images b/observability/traces/images
@@ -0,0 +1 @@
+../images
diff --git a/observability/traces/modules b/observability/traces/modules
@@ -0,0 +1 @@
+../modules
diff --git a/traces/ossm-distr-tracing-assembly.adoc → ...y/traces/ossm-distr-tracing-assembly.adoc b/traces/ossm-distr-tracing-assembly.adoc → ...y/traces/ossm-distr-tracing-assembly.adoc
diff --git a/observability/traces/snippets b/observability/traces/snippets
@@ -0,0 +1 @@
+../snippets