From 6d4b1ff150a5afddb504e32c69fb26cc31ee88d4 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Mon, 5 Jun 2023 15:23:59 -0400 Subject: [PATCH 1/5] Clarify topic configuration in stf-connectors.yaml Clarify the topic configuration in stf-connectors.yaml so the administrator knows there is an underlying transposition happening where the topic value is transposed into a topic address, and this is the full address that would be referenced by the Smart Gateway configuration via ServiceTelemetry object, clouds parameter. Add a note that helps with understanding how the value is transposed from the provided value into the full topic address listened on the bus. Also clarify the difference between the Ceilometer configuration which as a sub-parameter called topic, and the collectd configuration that has a unique parameter name to identify the topic value. Link back to an exaple configuration to make it clear how the value is transposed into the full address. Update the linked clouds section to match our unique-cloud configuration through the document. Closes: rhbz#2189678 Closes: rhbz#2189677 --- ...meters-of-the-servicetelemetry-object.adoc | 10 ++++---- ...-the-stf-connection-for-the-overcloud.adoc | 20 +++++++++++---- ...-environment-file-for-multiple-clouds.adoc | 25 +++++++++++++------ 3 files changed, 38 insertions(+), 17 deletions(-) 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..81490aba 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 defining the topics for collectd and Ceilometer, the value provided is transposed into the full topic that the Smart Gateway client will 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 that shows 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..5e634837 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 defining the topics for collectd and Ceilometer, the value provided is transposed into the full topic that the Smart Gateway client will 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 that shows 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`. From 0c51d46eeae9c533405becc1f2cf75d7a1a45ddf Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 6 Jun 2023 13:39:18 -0400 Subject: [PATCH 2/5] Update doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc Co-authored-by: mickogeary --- ...creating-openstack-environment-file-for-multiple-clouds.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 5e634837..00a7aabc 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 @@ -120,7 +120,7 @@ When defining the topics for collectd and Ceilometer, the value provided is tran 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 that shows a cloud configuration in the `ServiceTelemetry` object referring to the full topic address, see xref:clouds_assembly-installing-the-core-components-of-stf[]. +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`. From 8c125c37be8e4c92583e8213917b6f8fab6b09c1 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 6 Jun 2023 13:39:30 -0400 Subject: [PATCH 3/5] Update doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc Co-authored-by: mickogeary --- ...creating-openstack-environment-file-for-multiple-clouds.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 00a7aabc..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 @@ -115,7 +115,7 @@ endif::[] + [NOTE] ==== -When defining the topics for collectd and Ceilometer, the value provided is transposed into the full topic that the Smart Gateway client will listen for messages. +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.] From ad14a60e84ad9d4a89f5dacf68b49e88c7930b13 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 6 Jun 2023 13:50:09 -0400 Subject: [PATCH 4/5] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc Co-authored-by: mickogeary --- .../proc_configuring-the-stf-connection-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 81490aba..61d6048e 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 @@ -86,7 +86,7 @@ endif::[] [NOTE] ==== -When defining the topics for collectd and Ceilometer, the value provided is transposed into the full topic that the Smart Gateway client will listen for messages. +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.] From 29b769230ba385b9279351bd2250952b93627de0 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 6 Jun 2023 13:50:20 -0400 Subject: [PATCH 5/5] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc Co-authored-by: mickogeary --- .../proc_configuring-the-stf-connection-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 61d6048e..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 @@ -91,5 +91,5 @@ When you define the topics for collectd and Ceilometer, the value you provide is 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 that shows a cloud configuration in the `ServiceTelemetry` object referring to the full topic address, see xref:clouds_assembly-installing-the-core-components-of-stf[]. +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[]. ====