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 90ebf7cd..8cfc38b8 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 @@ -187,20 +187,20 @@ spec: metrics: collectors: - collectorType: collectd - subscriptionAddress: collectd/telemetry + subscriptionAddress: collectd/cloud1-telemetry - collectorType: ceilometer - subscriptionAddress: anycast/ceilometer/metering.sample + subscriptionAddress: anycast/ceilometer/cloud1-metering.sample ifndef::include_when_13[] - collectorType: sensubility - subscriptionAddress: sensubility/telemetry + subscriptionAddress: sensubility/cloud1-telemetry debugEnabled: false endif::[] events: collectors: - collectorType: collectd - subscriptionAddress: collectd/notify + subscriptionAddress: collectd/cloud1-notify - collectorType: ceilometer - subscriptionAddress: anycast/ceilometer/event.sample + subscriptionAddress: anycast/ceilometer/cloud1-event.sample ---- ifndef::include_when_13[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc index 720b7414..9210e48a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc @@ -76,10 +76,20 @@ ifdef::include_when_13,include_when_17[] * Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] * Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. -* Set `CeilometerQdrEventsConfig.topic` to define the topic for Ceilometer events. The format of this value is `anycast/ceilometer/cloud1-event.sample`. -* Set `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. The format of this value is `anycast/ceilometer/cloud1-metering.sample`. -* Set `CollectdAmqpInstances` to define the topic for collectd events. The format of this value is `collectd/cloud1-notify`. -* Set `CollectdAmqpInstances` to define the topic for collectd metrics. The format of this value is `collectd/cloud1-telemetry`. +* Set `topic` value of `CeilometerQdrEventsConfig` to define the topic for Ceilometer events. The value is a unique topic idenifier for the cloud such as `cloud1-event`. +* Set `topic` value of `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. The value is a unique topic identifier for the cloud such as `cloud1-metering`. +* Set `CollectdAmqpInstances` sub-paramter to define the topic for collectd events. The section name is a unique topic identifier for the cloud such as `cloud1-notify`. +* Set `CollectdAmqpInstances` sub-parameter to define the topic for collectd metrics. The section name is a unique topic identifier for the cloud such as `cloud1-telemetry`. ifndef::include_when_13[] -* Set `CollectdSensubilityResultsChannel` to define the topic for collectd-sensubility events. The format of this value is `sensubility/cloud1-telemetry`. +* Set `CollectdSensubilityResultsChannel` to define the topic for collectd-sensubility events. The value is a unique topic identifier for the cloud such as `sensubility/cloud1-telemetry`. endif::[] + +[NOTE] +==== +When you define the topics for collectd and Ceilometer, the value you provide is transposed into the full topic that the Smart Gateway client uses to listen for messages. + +Ceilometer topic values are transposed into the topic address `anycast/ceilometer/.sample` and collectd topic values are transposed into the topic address `collectd/`. +ifndef::include_when_13[The value for sensubility is the full topic path and has no transposition from topic value to topic address.] + +For an example of a cloud configuration in the `ServiceTelemetry` object referring to the full topic address, see xref:clouds_assembly-installing-the-core-components-of-stf[]. +==== 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 b2f92d52..f44f1dbe 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 @@ -98,19 +98,30 @@ ifndef::include_when_13[] CollectdSensubilityResultsChannel: sensubility/cloud1-telemetry endif::[] ---- - ++ * The `resource_registry` configuration directly loads the collectd service because you do not include the `collectd-write-qdr.yaml` environment file for multiple cloud deployments. +* Replace the `host` parameter with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. ifdef::include_when_13,include_when_17[] -* Replace the `MetricsQdrConnectors.host` parameter with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. * Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] -* Set the `CeilometerQdrEventsConfig.topic` to define the topic for Ceilometer events. This value is the address format of `anycast/ceilometer/cloud1-event.sample`. -* Set the `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. This value is the address format of `anycast/ceilometer/cloud1-metering.sample`. -* Set the `CollectdAmqpInstances` to define the topic for collectd events. This value is the format of `collectd/cloud1-notify`. -* Set the `CollectdAmqpInstances` to define the topic for collectd metrics. This value is the format of `collectd/cloud1-telemetry`. +* Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. +* Set `topic` value of `CeilometerQdrEventsConfig` to define the topic for Ceilometer events. The value is a unique topic idenifier for the cloud such as `cloud1-event`. +* Set `topic` value of `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. The value is a unique topic identifier for the cloud such as `cloud1-metering`. +* Set `CollectdAmqpInstances` sub-paramter to define the topic for collectd events. The section name is a unique topic identifier for the cloud such as `cloud1-notify`. +* Set `CollectdAmqpInstances` sub-parameter to define the topic for collectd metrics. The section name is a unique topic identifier for the cloud such as `cloud1-telemetry`. ifndef::include_when_13[] -* Set the `CollectdSensubilityResultsChannel` to define the topic for collectd-sensubility events. This value is the format of `sensubility/cloud1-telemetry` +* Set `CollectdSensubilityResultsChannel` to define the topic for collectd-sensubility events. The value is a unique topic identifier for the cloud such as `sensubility/cloud1-telemetry`. endif::[] ++ +[NOTE] +==== +When you define the topics for collectd and Ceilometer, the value you provide is transposed into the full topic that the Smart Gateway client uses to listen for messages. + +Ceilometer topic values are transposed into the topic address `anycast/ceilometer/.sample` and collectd topic values are transposed into the topic address `collectd/`. +ifndef::include_when_13[The value for sensubility is the full topic path and has no transposition from topic value to topic address.] + +For an example of a cloud configuration in the `ServiceTelemetry` object referring to the full topic address, see xref:clouds_assembly-installing-the-core-components-of-stf[]. +==== . Ensure that the naming convention in the `stf-connectors.yaml` file aligns with the `spec.bridge.amqpUrl` field in the Smart Gateway configuration. For example, configure the `CeilometerQdrEventsConfig.topic` field to a value of `cloud1-event`.