From 474461a8cc190f57e1fca33c1280a7ee77d878e3 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 14:10:58 -0500 Subject: [PATCH 01/10] Documentation walk-through and clean up * Update architecture documentation, creating a new section describing the architecture changes in STF 1.5.3 * Update style for knowledge base article references based on editorial feedback --- ...installing-the-core-components-of-stf.adoc | 2 +- .../modules/con_observability-strategy.adoc | 5 +++- ...meters-of-the-servicetelemetry-object.adoc | 2 +- .../modules/con_resource-allocation.adoc | 2 +- .../modules/con_stf-architecture.adoc | 24 ++++++++++++------- ...proc_deploying-observability-operator.adoc | 2 +- 6 files changed, 23 insertions(+), 14 deletions(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index 7d8660a5..2b6567b4 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -23,7 +23,7 @@ endif::[] ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] * An {OpenShift} version inclusive of {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion} is running. endif::[] -* You have prepared your {OpenShift} environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShift} environment. For more information, see https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. +* You have prepared your {OpenShift} environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShift} environment. For more information about {ProjectShort} performance, see the Red Hat Knowledge Base article https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. * Your environment is fully connected. {ProjectShort} does not work in a {OpenShift}-disconnected environments or network proxy environments. ifeval::["{build}" == "downstream"] diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 77e4f74b..d11f2dfc 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -27,6 +27,9 @@ The following values are available: | No storage or alerting components are deployed |=== +[NOTE] +==== Newly deployed {ProjectShort} environments as of 1.5.3 default to `use_redhat`. Existing {ProjectShort} deployments created before 1.5.3 default to `use_community`. +==== -To migrate an existing {ProjectShort} deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators]. +To migrate an existing {ProjectShort} deployment to `use_redhat`, see the Red Hat Knowledge Base article link:https://access.redhat.com/articles/7011708[Migrating {Project} to fully supported operators]. diff --git a/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc b/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc index 42637a6f..5727d632 100644 --- a/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc @@ -113,7 +113,7 @@ spec: Older versions of {ProjectShort} would manage Elasticsearch objects for the community supported Elastic Cloud on Kubernetes Operator (ECK). Elasticsearch management functionality is deprecated as of {ProjectShort} 1.5.3. Future versions of Service Telemetry Operator will continue to support forwarding to an existing Elasticsearch instance (which can be deployed and managed by ECK), but will not manage the creation of Elasticsearch objects. When upgrading an {ProjectShort} deployment, any existing Elasticsearch object and deployment will remain intact, but will no longer be managed by {ProjectShort}. ifeval::["{build}" == "downstream"] -Refer to this article for additional information about https://access.redhat.com/articles/7031236[Using Service Telemetry Framework with Elasticsearch] +For more information about using Elasticsearch with {ProjectShort}, see the Red Hat Knowledge Base article https://access.redhat.com/articles/7031236[Using Service Telemetry Framework with Elasticsearch]. endif::[] ==== diff --git a/doc-Service-Telemetry-Framework/modules/con_resource-allocation.adoc b/doc-Service-Telemetry-Framework/modules/con_resource-allocation.adoc index ca3e4ab5..f9cfc7c8 100644 --- a/doc-Service-Telemetry-Framework/modules/con_resource-allocation.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_resource-allocation.adoc @@ -11,4 +11,4 @@ The amount of resources that you require to run {Project} ({ProjectShort}) depen .Additional resources -* For recommendations about sizing for metrics collection, see https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. \ No newline at end of file +* For recommendations about sizing for metrics collection, see the Red Hat Knowledge Base article https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. diff --git a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc index 068fbca4..edcf05d0 100644 --- a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc @@ -80,15 +80,6 @@ For client side metrics, collectd provides infrastructure metrics without projec When you collect and store events, collectd and Ceilometer deliver event data to the server side by using the {MessageBus} transport. Another Smart Gateway forwards the data to a user-provided Elasticsearch datastore. -[NOTE] -==== -In previous releases of {ProjectShort}, the Service Telemetry Operator requested instances of Elasticsearch from the Elastic Cloud on Kubernetes (ECK) Operator. {ProjectShort} now uses a forwarding model, where events are forwarded from a Smart Gateway instance to a user-provided instance of Elasticsearch. The management of an Elasticsearch instance by Service Telemetry Operator is deprecated. - -In new `ServiceTelemetry`deployments, the `observabilityStrategy` parameter has a value of `use_redhat`, that does not request Elasticsearch instances from ECK. Deployments of `ServiceTelemetry` that are version {ProjectShort} 1.5.3 or older have the `observabilityStrategy` parameter set to `use_community`, which matches the previous architecture. If a user deployed an Elasticsearch instance with {ProjectShort}, the Service Telemetry Operator updates the `ServiceTelemetry` custom resource object to have the `observabilityStrategy` parameter set to `use_community`, and functions similar to previous releases. For more information about observability strategies, see xref:observability-strategy-in-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[]. - -For more information about migration to the `use_redhat` observability strategy, see link:https://access.redhat.com/articles/7011708[Migrating Service Telemetry Framework to fully supported operators]. -==== - Server-side {ProjectShort} monitoring infrastructure consists of the following layers: * {Project} {ProductVersion} @@ -103,3 +94,18 @@ endif::[] [[osp-stf-server-side-monitoring]] .Server-side STF monitoring infrastructure image::363_OpenStack_STF_updates_0923_deployment_prereq.png[Server-side STF monitoring infrastructure] + +== {ProjectShort} Architecture Changes + +In releases of {ProjectShort} prior to 1.5.3, the Service Telemetry Operator requested instances of Elasticsearch from the Elastic Cloud on Kubernetes (ECK) Operator. {ProjectShort} now uses a forwarding model, where events are forwarded from a Smart Gateway instance to a user-provided instance of Elasticsearch. + +[NOTE] +==== +The management of an Elasticsearch instances by Service Telemetry Operator is deprecated. +==== + +In new `ServiceTelemetry` deployments, the `observabilityStrategy` parameter has a value of `use_redhat`, that does not request Elasticsearch instances from ECK. Deployments of `ServiceTelemetry` with {ProjectShort} version 1.5.2 or older and were updated to 1.5.3 will have the `observabilityStrategy` parameter set to `use_community`, which matches the previous architecture. + +If a user previously deployed an Elasticsearch instance with {ProjectShort}, the Service Telemetry Operator updates the `ServiceTelemetry` custom resource object to have the `observabilityStrategy` parameter set to `use_community`, and functions similar to previous releases. For more information about observability strategies, see xref:observability-strategy-in-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[]. + +It is recommended that users of {ProjectShort} migrate to the `use_redhat` observability strategy. For more information about migration to the `use_redhat` observability strategy, see the Red Hat Knowledge Base article link:https://access.redhat.com/articles/7011708[Migrating Service Telemetry Framework to fully supported operators]. diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc index 1d250ff5..eed17ed4 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc @@ -5,7 +5,7 @@ [role="_abstract"] // https://access.redhat.com/articles/7011708 covers migration to COO from community-operators Prometheus Operator. -The Cluster Observability Operator (COO) must be pre-installed before creating an instance of Service Telemetry Framework (STF) if the `observabilityStrategy` is set to `use_redhat` and the `backends.metrics.prometheus.enabled` is set to `true` in the `ServiceTelemetry` object. For more information about COO, see link:https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/monitoring/cluster_observability_operator/cluster-observability-operator-overview.html[Cluster Observability Operator overview]. +The Cluster Observability Operator (COO) must be pre-installed before creating an instance of Service Telemetry Framework (STF) if the `observabilityStrategy` is set to `use_redhat` and the `backends.metrics.prometheus.enabled` is set to `true` in the `ServiceTelemetry` object. For more information about COO, see link:https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/monitoring/cluster_observability_operator/cluster-observability-operator-overview.html[Cluster Observability Operator overview] in the _OpenShift Container Platform Documentation_. .Procedure From 65c7019e52cf3e43d301e8515e1b6d5c12ccd6e9 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 14:56:52 -0500 Subject: [PATCH 02/10] Add links to COO and cert-manager --- .../assembly_installing-the-core-components-of-stf.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index 2b6567b4..7b084d58 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -40,7 +40,8 @@ endif::[] * For more information about Operators, see the https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-what-operators-are.html[_Understanding Operators_] guide. * For more information about Operator catalogs, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-rh-catalogs.html[_Red Hat-provided Operator catalogs_]. -//* For more information about how to remove {ProjectShort} from the {OpenShift} environment, see xref:assembly-removing-stf-from-the-openshift-environment_{}[]. +* For more information about the cert-manager Operator for Red Hat, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/security/cert_manager_operator/index.html[_cert-manager Operator for Red Hat OpenShift overview_]. +* For more information about {ObservabilityOperator}, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/monitoring/cluster_observability_operator/cluster-observability-operator-overview.html[_Cluster Observability Operator Overview_]. include::../modules/con_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] From cf36a5230fd32095ac803d626682013ac179ca7f Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 14:57:20 -0500 Subject: [PATCH 03/10] Update cert-manager install to use oc wait --- ...deploying-certificate-manager-for-openshift-operator.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc index c3bd2e9d..e5bff783 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc @@ -79,8 +79,7 @@ EOF + [source,bash,options="nowrap",role="white-space-pre"] ---- -oc get csv --namespace cert-manager-operator --selector=operators.coreos.com/openshift-cert-manager-operator.cert-manager-operator +oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=cert-manager-operator --selector=operators.coreos.com/openshift-cert-manager-operator.cert-manager-operator -NAME DISPLAY VERSION REPLACES PHASE -cert-manager-operator.v1.12.1 cert-manager Operator for Red Hat OpenShift 1.12.1 cert-manager-operator.v1.12.0 Succeeded +clusterserviceversion.operators.coreos.com/cert-manager-operator.v1.12.1 condition met ---- From 786281503e7e2e188d9f1c58b4404a4538d94923 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 15:58:02 -0500 Subject: [PATCH 04/10] Multi-Cloud: Add warning about unique domains --- .../modules/con_configuring-multiple-clouds.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc b/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc index 477c1035..dae872f3 100644 --- a/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc @@ -4,6 +4,11 @@ [role="_abstract"] You can configure multiple {OpenStack} ({OpenStackShort}) clouds to target a single instance of {Project} ({ProjectShort}). When you configure multiple clouds, every cloud must send metrics and events on their own unique message bus topic. In the {ProjectShort} deployment, Smart Gateway instances listen on these topics to save information to the common data store. Data that is stored by the Smart Gateway in the data storage domain is filtered by using the metadata that each of Smart Gateways creates. +[WARNING] +==== +Be sure that every cloud deployment has a unique cloud domain configuration. For more information about configuring the domain for your cloud deployment, see xref:setting-a-unique-cloud-domain_assembly-completing-the-stf-configuration[]. +==== + [[osp-stf-multiple-clouds]] .Two {OpenStackShort} clouds connect to {ProjectShort} image::363_OpenStack_STF_updates_0923_topology_2.png[An example of two {OpenStackShort} clouds connecting to {ProjectShort}] From 227c54b7cad3042d8e6a25d11889a80879acce06 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 15:58:39 -0500 Subject: [PATCH 05/10] HA: Move warning to top --- .../modules/con_high-availability.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc b/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc index 8a6422e2..3db88d62 100644 --- a/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc @@ -2,13 +2,13 @@ = High availability [role="_abstract"] -With high availability, {Project} ({ProjectShort}) can rapidly recover from failures in its component services. Although {OpenShift} restarts a failed pod if nodes are available to schedule the workload, this recovery process might take more than one minute, during which time events and metrics are lost. A high availability configuration includes multiple copies of {ProjectShort} components, which reduces recovery time to approximately 2 seconds. To protect against failure of an {OpenShift} node, deploy {ProjectShort} to an {OpenShift} cluster with three or more nodes. - [WARNING] ==== {ProjectShort} high availability (HA) mode is deprecated and is not supported in production environments. {OpenShift} is a highly-available platform, and you can cause issues and complicate debugging in {ProjectShort} if you enable HA mode. ==== +With high availability, {Project} ({ProjectShort}) can rapidly recover from failures in its component services. Although {OpenShift} restarts a failed pod if nodes are available to schedule the workload, this recovery process might take more than one minute, during which time events and metrics are lost. A high availability configuration includes multiple copies of {ProjectShort} components, which reduces recovery time to approximately 2 seconds. To protect against failure of an {OpenShift} node, deploy {ProjectShort} to an {OpenShift} cluster with three or more nodes. + Enabling high availability has the following effects: * The following components run two pods instead of the default one: From 9e1830c6b0e7834d296184409f0108b374201f3a Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 15:59:14 -0500 Subject: [PATCH 06/10] Params: Add warning about HA deprecation --- ...on_primary-parameters-of-the-servicetelemetry-object.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc b/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc index 5727d632..7926e44f 100644 --- a/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc @@ -249,6 +249,11 @@ Use the `graphing` parameter to control the creation of a Grafana instance. By d [discrete] == The highAvailability parameter +[WARNING] +==== +{ProjectShort} high availability (HA) mode is deprecated and is not supported in production environments. {OpenShift} is a highly-available platform, and you can cause issues and complicate debugging in {ProjectShort} if you enable HA mode. +==== + Use the `highAvailability` parameter to control the instantiation of multiple copies of {ProjectShort} components to reduce recovery time of components that fail or are rescheduled. By default, `highAvailability` is disabled. For more information, see xref:high-availability_assembly-advanced-features[]. [id="transports_{context}"] From a3e27ab37c0610560a9cb3d23e3854c2b69dd413 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 15:59:37 -0500 Subject: [PATCH 07/10] Obs Strat: Add link to migration KBA --- .../modules/proc_configuring-observability-strategy.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc index 65f795ec..43fb10fe 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc @@ -48,4 +48,5 @@ smart-gateway-operator-58d77dcf7-6xsq7 1/1 Running 0 .Additional resources -For more information about configuring additional clouds or to change the set of supported collectors, see xref:deploying-smart-gateways_assembly-completing-the-stf-configuration[] +* For more information about configuring additional clouds or to change the set of supported collectors, see xref:deploying-smart-gateways_assembly-completing-the-stf-configuration[]. +* To migrate an existing {ProjectShort} deployment to `use_redhat`, see the Red Hat Knowledge Base article link:https://access.redhat.com/articles/7011708[Migrating {Project} to fully supported operators]. From 6565602380b829af53f471c765034eca4c405211 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 16:00:07 -0500 Subject: [PATCH 08/10] Multi-Cloud: Remove reference to Ansible-based deployments --- ...eating-openstack-environment-file-for-multiple-clouds.adoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc index c0c60399..5c35d4b2 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc @@ -146,10 +146,6 @@ If you use the `collectd-write-qdr.yaml` file with a custom `CollectdAmqpInstanc . Deploy the {OpenStack} overcloud. -ifdef::include_when_17[] -include::con_ansible-based-deployment.adoc[leveloffset=+1] -endif::include_when_17[] - .Additional resources * For information about how to validate the deployment, see xref:validating-clientside-installation_assembly-completing-the-stf-configuration[]. From bc425537d21190878e80b4092b93a9554c737a97 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 16:01:00 -0500 Subject: [PATCH 09/10] Dashboard: Fix links to collectd plugins Add wrappers to the collectd plugins in the Dashboard guide because paths changed between 16.2 and 17.1. --- .../modules/proc_importing-dashboards.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc index f3f53417..86602898 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc @@ -18,7 +18,13 @@ grafanadashboard.integreatly.org/rhos-dashboard-1 created . Import the cloud dashboard: + [WARNING] -In the `enable-stf.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. +In the `enable-stf.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. +ifdef::include_before_17[] +For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. +endif::include_before_17[] +ifdef::include_when_17[] +For more information about the `virt` plugin, see link:{defaultURL}/managing_overcloud_observability/collectd-plugins_assembly[collectd plugins]. +endif::include_when_17[] + [source,bash,options="nowrap"] ---- From 75159d2a508636d92485af4dd600f7a02c376bf1 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 29 Nov 2023 16:02:03 -0500 Subject: [PATCH 10/10] Update wording for CloudDomain overview Update the wording in the CloudDomain overview since router connections are controlled with router_id parameters now. --- .../modules/proc_setting-a-unique-cloud-domain.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-a-unique-cloud-domain.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-a-unique-cloud-domain.adoc index 7afea006..d15d1474 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_setting-a-unique-cloud-domain.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_setting-a-unique-cloud-domain.adoc @@ -2,7 +2,7 @@ = Setting a unique cloud domain [role="_abstract"] -To ensure that {MessageBus} router connections from {OpenStack} ({OpenStackShort}) to {Project} ({ProjectShort}) are unique and do not conflict, configure the `CloudDomain` parameter. +To ensure that telemetry from different {OpenStack} ({OpenStackShort}) clouds to {Project} ({ProjectShort}) can be uniquely identified and do not conflict, configure the `CloudDomain` parameter. WARNING: Ensure that you do not change host or domain names in an existing deployment. Host and domain name configuration is supported in new cloud deployments only.