diff --git a/.gitignore b/.gitignore index 567609b1..0a9f24ca 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ build/ +departure/ diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc index 79fab438..301c42b2 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc @@ -19,9 +19,7 @@ To collect metrics, events, or both, and to send them to the {Project} ({Project ** To deploy data collection and transport to {ProjectShort} on {OpenStackShort} cloud nodes that employ routed L3 domains, such as distributed compute node (DCN) or spine-leaf, see xref:deploying-to-non-standard-network-topologies_assembly-completing-the-stf-configuration[]. -ifdef::include_when_16[] -** To send metrics to both Gnocchi and {ProjectShort}, see xref:sending-metrics-to-gnocchi-and-to-stf_assembly-completing-the-stf-configuration[]. -endif::include_when_16[] +** To disable the data collector services, see xref:disabling-openstack-services-used-with-stf_assembly-completing-the-stf-configuration[]. ifdef::include_when_13[] ** If you synchronized container images to a local registry, you must create an environment file and include the paths to the container images. For more information, see xref:adding-container-images-to-the-undercloud_assembly-completing-the-stf-configuration[]. @@ -39,11 +37,6 @@ include::../modules/proc_deploying-the-overcloud.adoc[leveloffset=+2] include::../modules/proc_validating-clientside-installation.adoc[leveloffset=+2] include::../modules/proc_disabling-openstack-services-used-with-stf.adoc[leveloffset=+1] -//Sending metrics to Gnocchi and to STF -ifdef::include_when_16[] -include::../modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc[leveloffset=+1] -endif::include_when_16[] - // Gather information for deployment in non-standard network topologies in the OSP overcloud include::../modules/proc_deploying-to-non-standard-network-topologies.adoc[leveloffset=+1] 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 b31756b5..0413d78e 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 @@ -39,7 +39,7 @@ endif::[] .Additional resources * 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 how to remove {ProjectShort} from the {OpenShift} environment, see xref:assembly-removing-stf-from-the-openshift-environment_assembly[]. +//* For more information about how to remove {ProjectShort} from the {OpenShift} environment, see xref:assembly-removing-stf-from-the-openshift-environment_{}[]. include::../modules/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] include::../modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/master.adoc b/doc-Service-Telemetry-Framework/master.adoc index 1a7764d0..e836b7a4 100644 --- a/doc-Service-Telemetry-Framework/master.adoc +++ b/doc-Service-Telemetry-Framework/master.adoc @@ -38,7 +38,7 @@ include::assemblies/assembly_advanced-features.adoc[leveloffset=+1] include::assemblies/assembly_renewing-the-amq-interconnect-certificate.adoc[leveloffset=+1] // upgrading to 1.4 -include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-4.adoc[leveloffset=+1] +//include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-4.adoc[leveloffset=+1] // removing include::assemblies/assembly_removing-stf-from-the-openshift-environment.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc index 79dbe600..c52e383d 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc @@ -13,10 +13,6 @@ To configure the base parameters to provide a compatible data collection and tra [IMPORTANT] ==== Setting `EventPipelinePublishers` and `PipelinePublishers` to empty lists results in no event or metric data passing to {OpenStackShort} telemetry components, such as Gnocchi or Panko. If you need to send data to additional pipelines, the Ceilometer polling interval of 30 seconds, as specified in `ExtraConfig`, might overwhelm the {OpenStackShort} telemetry components, and you must increase the interval to a larger value, such as `300`. Increasing the value to a longer polling interval results in less telemetry resolution in {ProjectShort}. - -ifdef::include_when_16[] -To enable collection of telemetry with {ProjectShort} and Gnocchi, see xref:sending-metrics-to-gnocchi-and-to-stf_assembly-completing-the-stf-configuration[] -endif::include_when_16[] ==== + .enable-stf.yaml diff --git a/doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc index 374e9864..5f6edaf1 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_disabling-openstack-services-used-with-stf.adoc @@ -4,9 +4,6 @@ [role="_abstract"] Disable the services used when deploying {OpenStack} ({OpenStackShort}) and connecting it to {Project} ({ProjectShort}). There is no removal of logs or generated configuration files as part of the disablement of the services. -[WARNING] -Do not use this procedure when also using the xref:sending-metrics-to-gnocchi-and-to-stf_assembly-completing-the-stf-configuration[] procedure because the `gnocchi-connectors.yaml` does not contain all dependencies required. If you want to remove {ProjectShort}-related services on {OpenStackShort}, ensure that you update your environment to enable data collection and data storage dependencies. - .Procedure . Log in to the {OpenStackShort} undercloud as the `stack` user. diff --git a/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc deleted file mode 100644 index 321cb527..00000000 --- a/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc +++ /dev/null @@ -1,71 +0,0 @@ -[id="sending-metrics-to-gnocchi-and-to-stf_{context}"] -= Sending metrics to Gnocchi and {Project} - -[role="_abstract"] - -To send metrics to {Project} ({ProjectShort}) and Gnocchi simultaneously, you must include an environment file in your deployment to enable an additional publisher. - -[WARNING] -If you need to send data to additional pipelines, the Ceilometer polling interval of 30 seconds, as specified in `ExtraConfig`, might overwhelm the {OpenStackShort} telemetry components, and you must increase the interval to a larger value, such as `300`. Increasing the value to a longer polling interval results in less telemetry resolution in {ProjectShort}. - -.Prerequisites - -* You have created a file that contains the connection configuration of the {MessageBus} for the overcloud to {ProjectShort}. For more information, see xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[]. - -.Procedure - -. Create an environment file named `gnocchi-connectors.yaml` in the `/home/stack` directory. -+ -[source,yaml,options="nowrap",subs="none"] ----- -resource_registry: - OS::TripleO::Services::GnocchiApi: /usr/share/openstack-tripleo-heat-templates/deployment/gnocchi/gnocchi-api-container-puppet.yaml - OS::TripleO::Services::GnocchiMetricd: /usr/share/openstack-tripleo-heat-templates/deployment/gnocchi/gnocchi-metricd-container-puppet.yaml - OS::TripleO::Services::GnocchiStatsd: /usr/share/openstack-tripleo-heat-templates/deployment/gnocchi/gnocchi-statsd-container-puppet.yaml - OS::TripleO::Services::AodhApi: /usr/share/openstack-tripleo-heat-templates/deployment/aodh/aodh-api-container-puppet.yaml - OS::TripleO::Services::AodhEvaluator: /usr/share/openstack-tripleo-heat-templates/deployment/aodh/aodh-evaluator-container-puppet.yaml - OS::TripleO::Services::AodhNotifier: /usr/share/openstack-tripleo-heat-templates/deployment/aodh/aodh-notifier-container-puppet.yaml - OS::TripleO::Services::AodhListener: /usr/share/openstack-tripleo-heat-templates/deployment/aodh/aodh-listener-container-puppet.yaml - -parameter_defaults: - CeilometerEnableGnocchi: true - CeilometerEnablePanko: false - GnocchiArchivePolicy: 'high' - GnocchiBackend: 'rbd' - GnocchiRbdPoolName: 'metrics' - - EventPipelinePublishers: ['gnocchi://?filter_project=service'] - PipelinePublishers: ['gnocchi://?filter_project=service'] ----- - -. Add the environment file `gnocchi-connectors.yaml` to the deployment command. Replace __ with files that are applicable to your environment. -+ -[source,bash,options="nowrap",subs="+quotes"] ----- -$ openstack overcloud deploy __ ---templates /usr/share/openstack-tripleo-heat-templates \ - --environment-file _<...other_environment_files...>_ \ - --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/ceilometer-write-qdr.yaml \ - --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/collectd-write-qdr.yaml \ - --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-edge-only.yaml \ - --environment-file /home/stack/enable-stf.yaml \ - --environment-file /home/stack/stf-connectors.yaml \ - --environment-file /home/stack/gnocchi-connectors.yaml ----- - -. To ensure that the configuration was successful, verify the content of the file `/var/lib/config-data/puppet-generated/ceilometer/etc/ceilometer/pipeline.yaml` on a Controller node. Ensure that the `publishers` section of the file contains information for both `notifier` and `Gnocchi`. -+ -[source,yaml,options="nowrap"] ----- -sources: - - name: meter_source - meters: - - "*" - sinks: - - meter_sink -sinks: - - name: meter_sink - publishers: - - gnocchi://?filter_project=service - - notifier://172.17.1.35:5666/?driver=amqp&topic=metering -----