diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 86390a804d2b..702b6f9f3369 100644 --- 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 b/observability/_attributes similarity index 100% rename from kiali/_attributes rename to observability/_attributes diff --git a/observability/docinfo.xml b/observability/docinfo.xml new file mode 100644 index 000000000000..8f3a852be28c --- /dev/null +++ b/observability/docinfo.xml @@ -0,0 +1,12 @@ +Observability +Red Hat OpenShift Service Mesh +3.0.0tp1 +Observability and Service Mesh + + This document provides an overview of Red Hat OpenShift Observability integrations with OpenShift Service Mesh. + + + + Red Hat OpenShift Documentation Team + + diff --git a/kiali/images b/observability/images similarity index 100% rename from kiali/images rename to observability/images diff --git a/metrics/_attributes b/observability/kiali/_attributes similarity index 100% rename from metrics/_attributes rename to observability/kiali/_attributes diff --git a/kiali/docinfo.xml b/observability/kiali/docinfo.xml similarity index 73% rename from kiali/docinfo.xml rename to observability/kiali/docinfo.xml index c29816e36b86..6d31eacded9d 100644 --- a/kiali/docinfo.xml +++ b/observability/kiali/docinfo.xml @@ -3,7 +3,7 @@ 3.0 Using the Kiali Operator provided by Red Hat - This documentation provides information about the {KialiProduct}, and how to view the data that flows through your application. + This documentation provides information about Kiali Operator provided by Red Hat, and how to view the data that flows through your application. diff --git a/metrics/images b/observability/kiali/images similarity index 100% rename from metrics/images rename to observability/kiali/images diff --git a/kiali/modules b/observability/kiali/modules similarity index 100% rename from kiali/modules rename to observability/kiali/modules diff --git a/kiali/ossm-kiali-assembly.adoc b/observability/kiali/ossm-kiali-assembly.adoc similarity index 88% rename from kiali/ossm-kiali-assembly.adoc rename to observability/kiali/ossm-kiali-assembly.adoc index 18ea48f19628..d1e33ce7584a 100644 --- a/kiali/ossm-kiali-assembly.adoc +++ b/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. \ No newline at end of file diff --git a/kiali/snippets b/observability/kiali/snippets similarity index 100% rename from kiali/snippets rename to observability/kiali/snippets diff --git a/traces/_attributes b/observability/metrics/_attributes similarity index 100% rename from traces/_attributes rename to observability/metrics/_attributes diff --git a/metrics/docinfo.xml b/observability/metrics/docinfo.xml similarity index 100% rename from metrics/docinfo.xml rename to observability/metrics/docinfo.xml diff --git a/traces/images b/observability/metrics/images similarity index 100% rename from traces/images rename to observability/metrics/images diff --git a/metrics/modules b/observability/metrics/modules similarity index 100% rename from metrics/modules rename to observability/metrics/modules diff --git a/metrics/ossm-metrics-assembly.adoc b/observability/metrics/ossm-metrics-assembly.adoc similarity index 100% rename from metrics/ossm-metrics-assembly.adoc rename to observability/metrics/ossm-metrics-assembly.adoc diff --git a/metrics/snippets b/observability/metrics/snippets similarity index 100% rename from metrics/snippets rename to observability/metrics/snippets diff --git a/traces/modules b/observability/modules similarity index 100% rename from traces/modules rename to observability/modules diff --git a/observability/ossm-observability-service-mesh-assembly.adoc b/observability/ossm-observability-service-mesh-assembly.adoc new file mode 100644 index 000000000000..edf8d7fa5e74 --- /dev/null +++ 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. \ No newline at end of file diff --git a/traces/snippets b/observability/snippets similarity index 100% rename from traces/snippets rename to observability/snippets diff --git a/observability/traces/_attributes b/observability/traces/_attributes new file mode 120000 index 000000000000..93957f02273f --- /dev/null +++ b/observability/traces/_attributes @@ -0,0 +1 @@ +../_attributes \ No newline at end of file diff --git a/traces/docinfo.xml b/observability/traces/docinfo.xml similarity index 86% rename from traces/docinfo.xml rename to observability/traces/docinfo.xml index 7f5f65a0e4ba..eba9226adf33 100644 --- a/traces/docinfo.xml +++ b/observability/traces/docinfo.xml @@ -3,7 +3,7 @@ 3.0 Using distributed tracing with OpenShift Service Mesh - This document provides an overview of distributed tracing in {SMProduct}, and how to configure distributed tracing for {SMProductShortName}. + This document provides an overview of distributed tracing in OpenShift Service Mesh, and how to configure distributed tracing for {SMProductShortName}. diff --git a/observability/traces/images b/observability/traces/images new file mode 120000 index 000000000000..5e67573196d8 --- /dev/null +++ b/observability/traces/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/observability/traces/modules b/observability/traces/modules new file mode 120000 index 000000000000..464b823aca16 --- /dev/null +++ b/observability/traces/modules @@ -0,0 +1 @@ +../modules \ No newline at end of file diff --git a/traces/ossm-distr-tracing-assembly.adoc b/observability/traces/ossm-distr-tracing-assembly.adoc similarity index 100% rename from traces/ossm-distr-tracing-assembly.adoc rename to observability/traces/ossm-distr-tracing-assembly.adoc diff --git a/observability/traces/snippets b/observability/traces/snippets new file mode 120000 index 000000000000..9f5bc7e4dde0 --- /dev/null +++ b/observability/traces/snippets @@ -0,0 +1 @@ +../snippets \ No newline at end of file