From ccd422a230e433edb4cacf51a62c37304d5329be Mon Sep 17 00:00:00 2001 From: pleimer Date: Thu, 22 Oct 2020 15:18:59 -0400 Subject: [PATCH 1/7] Add explanation for enabling libpodstats --- .../modules/con_advanced-features.adoc | 1 + .../con_service-resource-usage-metrics.adoc | 28 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc diff --git a/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc b/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc index 6e17e8f6..d21145d2 100644 --- a/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc @@ -32,3 +32,4 @@ The following optional features can provide additional functionality to the {Pro * Dashboards. For more information, see xref:dashboards_advanced-features[]. * Multiple clouds. For more information, see xref:configuring-multiple-clouds_advanced-features[]. * Ephemeral storage. For more information, see xref:ephemeral-storage_advanced-features[]. +* Service resource usage metrics. For more information, see xref:service-resource-usage-metrics[]. diff --git a/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc b/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc new file mode 100644 index 00000000..6003a8e6 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc @@ -0,0 +1,28 @@ + +// Module included in the following assemblies: +// +// + +// This module can be included from assemblies using the following include statement: +// include::/con_manifest-overrides.adoc[leveloffset=+1] + +// The file name and the ID are based on the module title. For example: +// * file name: con_my-concept-module-a.adoc +// * ID: [id='con_my-concept-module-a_{context}'] +// * Title: = My concept module A +// +// The ID is used as an anchor for linking to the module. Avoid changing +// it after the module has been published to ensure existing links are not +// broken. +// +// The `context` attribute enables module reuse. Every module's ID includes +// {context}, which ensures that the module has a unique ID even if it is +// reused multiple times in a guide. +// +// In the title, include nouns that are used in the body text. This helps +// readers and search engines find information quickly. +// Do not start the title with a verb. See also _Wording of headings_ +// in _The IBM Style Guide_. +[id="service-resource-usage-metrics_{context}"] += Service resource usage metrics +Metrics pertaining to the resource usage of individual service contianers within an overcloud are not enabled by default. To gather these metrics, set `CollectdEnableLibpodstats: true` in the xref:configuring-red-hat-openstack-platform-overcloud-for-stf[stf-connectors.yaml] when deploying the overcloud. \ No newline at end of file From 11c95dfed118fec39b959d66ed9ec81a9e98e11d Mon Sep 17 00:00:00 2001 From: pleimer Date: Fri, 23 Oct 2020 11:18:20 -0400 Subject: [PATCH 2/7] Include more connceptual information, versions, and prerequisites --- .../con_service-resource-usage-metrics.adoc | 23 ++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc b/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc index 6003a8e6..6a5ba82b 100644 --- a/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc @@ -4,7 +4,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/con_manifest-overrides.adoc[leveloffset=+1] +// include::/con_manifest-features.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: con_my-concept-module-a.adoc @@ -24,5 +24,22 @@ // Do not start the title with a verb. See also _Wording of headings_ // in _The IBM Style Guide_. [id="service-resource-usage-metrics_{context}"] -= Service resource usage metrics -Metrics pertaining to the resource usage of individual service contianers within an overcloud are not enabled by default. To gather these metrics, set `CollectdEnableLibpodstats: true` in the xref:configuring-red-hat-openstack-platform-overcloud-for-stf[stf-connectors.yaml] when deploying the overcloud. \ No newline at end of file += OpenStack service monitoring +Conceptual overview: +Monitoring the resource usage of the openstack services such as the APIs and other infrastructure processes can be very useful in identifying areas of the cloud that are under a lot of stress. This can be done by enabling the collectd-libpod-stats plugin to gather CPU and memory usage metrics for every container running in the overcloud. + +Requirements: +{OpenStackVersion} //Train and OSP16.1.3 + +Procedure: + +- Modify your `stf-connectors.yaml`. See xref:configuring-red-hat-openstack-platform-overcloud-for-stf[] for more information about creating `stf-connectors.yaml`. +- Add `CollectdEnableLibpodstats: true` +``` +--- +parameter_defaults: + ... + CollectdEnableLibpodstats: true + +``` +- Continue with the overcloud deployment procedure \ No newline at end of file From d627f9eff9d8d561eecd60eae8166c63facc188e Mon Sep 17 00:00:00 2001 From: Joanne O'Flynn Date: Sun, 25 Oct 2020 23:47:30 +0000 Subject: [PATCH 3/7] Changed module name and make minor edits --- .../assembly_advanced-features.adoc | 4 +++ .../modules/con_advanced-features.adoc | 14 ++++----- ...resource-usage-of-openstack-services.adoc} | 29 ++++++++++--------- 3 files changed, 26 insertions(+), 21 deletions(-) rename doc-Service-Telemetry-Framework/modules/{con_service-resource-usage-metrics.adoc => proc_monitoring-resource-usage-of-openstack-services.adoc} (55%) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 65c14863..49eb5bc7 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -61,6 +61,7 @@ include::../modules/con_configuring-multiple-clouds.adoc[leveloffset=+1] include::../modules/proc_planning-amqp-address-prefixes.adoc[leveloffset=+2] include::../modules/proc_deploying-smart-gateways.adoc[leveloffset=+2] include::../modules/ref_example-manifests.adoc[leveloffset=+3] + // deleting smart gateways is not currently possible from the service telemetry operator //include::../modules/proc_deleting-the-default-smart-gateways.adoc[leveloffset=+2] include::../modules/proc_creating-openstack-environment-file.adoc[leveloffset=+2] @@ -69,3 +70,6 @@ include::../modules/proc_querying-metrics-data-from-multiple-clouds.adoc[levelof //Configuring ephemeral storage include::../modules/con_ephemeral-storage.adoc[leveloffset=+1] include::../modules/proc_configuring-ephemeral-storage.adoc[leveloffset=+2] + +//Monitoring the resource usage of Openstack services +include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc b/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc index d21145d2..47bd6233 100644 --- a/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc @@ -26,10 +26,10 @@ The following optional features can provide additional functionality to the {Project} ({ProjectShort}): -* Customizing the deployment. For more information, see xref:manifest-overrides_advanced-features[]. -* Alerts. For more information, see xref:alerts_advanced-features[]. -* High availability. For more information, see xref:high-availability_advanced-features[]. -* Dashboards. For more information, see xref:dashboards_advanced-features[]. -* Multiple clouds. For more information, see xref:configuring-multiple-clouds_advanced-features[]. -* Ephemeral storage. For more information, see xref:ephemeral-storage_advanced-features[]. -* Service resource usage metrics. For more information, see xref:service-resource-usage-metrics[]. +* xref:manifest-overrides_advanced-features[] +* xref:alerts_advanced-features[] +* xref:high-availability_advanced-features[] +* xref:dashboards_advanced-features[] +* xref:configuring-multiple-clouds_advanced-features[] +* xref:ephemeral-storage_advanced-features[] +* xref:monitoring-resource-usage-of-openstack-services_advanced-features[] diff --git a/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc similarity index 55% rename from doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc rename to doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc index 6a5ba82b..9d674f27 100644 --- a/doc-Service-Telemetry-Framework/modules/con_service-resource-usage-metrics.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc @@ -23,23 +23,24 @@ // readers and search engines find information quickly. // Do not start the title with a verb. See also _Wording of headings_ // in _The IBM Style Guide_. -[id="service-resource-usage-metrics_{context}"] -= OpenStack service monitoring -Conceptual overview: -Monitoring the resource usage of the openstack services such as the APIs and other infrastructure processes can be very useful in identifying areas of the cloud that are under a lot of stress. This can be done by enabling the collectd-libpod-stats plugin to gather CPU and memory usage metrics for every container running in the overcloud. +[id="monitoring-resource-usage-of-openstack-services_{context}"] += Monitoring the resource usage of {OpenStack} services -Requirements: -{OpenStackVersion} //Train and OSP16.1.3 +Monitor the resource usage of the {OpenStack} services, such as the APIs and other infrastructure processes, to identify areas of the cloud that are under a lot of stress. Enable the `collectd-libpod-stats` plug-in to gather CPU and memory usage metrics for every container running in the overcloud. -Procedure: +.Prerequisites -- Modify your `stf-connectors.yaml`. See xref:configuring-red-hat-openstack-platform-overcloud-for-stf[] for more information about creating `stf-connectors.yaml`. -- Add `CollectdEnableLibpodstats: true` +* You have created the `stf-connectors.yaml` file. For more information, see xref:configuring-red-hat-openstack-platform-overcloud-for-stf_completing-the-stf-configuration[]. +* You are using the most current version of {OpenStack}: {OpenStackVersion}. + +.Procedure + +. Open the `stf-connectors.yaml`. + +. Add the following configuration to `parameter_defaults`: ++ ``` ---- -parameter_defaults: - ... CollectdEnableLibpodstats: true - ``` -- Continue with the overcloud deployment procedure \ No newline at end of file + +. Continue with the overcloud deployment procedure. From b1bb91cffa235099cc37b03775c59aaadc344ee9 Mon Sep 17 00:00:00 2001 From: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Date: Tue, 27 Oct 2020 13:32:58 +0000 Subject: [PATCH 4/7] Update doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc --- .../proc_monitoring-resource-usage-of-openstack-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc index 9d674f27..5fb7f182 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc @@ -26,7 +26,7 @@ [id="monitoring-resource-usage-of-openstack-services_{context}"] = Monitoring the resource usage of {OpenStack} services -Monitor the resource usage of the {OpenStack} services, such as the APIs and other infrastructure processes, to identify areas of the cloud that are under a lot of stress. Enable the `collectd-libpod-stats` plug-in to gather CPU and memory usage metrics for every container running in the overcloud. +Monitor the resource usage of the {OpenStack} services, such as the APIs and other infrastructure processes, to identify areas of the cloud that require more compute power. Enable the `collectd-libpod-stats` plug-in to gather CPU and memory usage metrics for every container running in the overcloud. .Prerequisites From 4c1af6f1ac5f2cd0509f0250eebe41d231c8760d Mon Sep 17 00:00:00 2001 From: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Date: Tue, 27 Oct 2020 13:34:38 +0000 Subject: [PATCH 5/7] Update doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc --- .../proc_monitoring-resource-usage-of-openstack-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc index 5fb7f182..2c5fc985 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc @@ -35,7 +35,7 @@ Monitor the resource usage of the {OpenStack} services, such as the APIs and oth .Procedure -. Open the `stf-connectors.yaml`. +. Open the `stf-connectors.yaml` file. . Add the following configuration to `parameter_defaults`: + From 516cfb0dd9e2347ee0c8d4214ff0291a2cb4d3a4 Mon Sep 17 00:00:00 2001 From: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Date: Tue, 27 Oct 2020 13:41:54 +0000 Subject: [PATCH 6/7] Update doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc --- .../proc_monitoring-resource-usage-of-openstack-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc index 2c5fc985..828352a3 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc @@ -26,7 +26,7 @@ [id="monitoring-resource-usage-of-openstack-services_{context}"] = Monitoring the resource usage of {OpenStack} services -Monitor the resource usage of the {OpenStack} services, such as the APIs and other infrastructure processes, to identify areas of the cloud that require more compute power. Enable the `collectd-libpod-stats` plug-in to gather CPU and memory usage metrics for every container running in the overcloud. +Monitor the resource usage of the {OpenStack} services, such as the APIs and other infrastructure processes, to identify bottlenecks in the overcloud by showing services running out of compute power. Enable the `collectd-libpod-stats` plug-in to gather CPU and memory usage metrics for every container running in the overcloud. .Prerequisites From bf010334f51793532c343a311e798cce9761d837 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 28 Oct 2020 09:44:42 -0400 Subject: [PATCH 7/7] Update doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc --- .../proc_monitoring-resource-usage-of-openstack-services.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc index 828352a3..d4d94848 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_monitoring-resource-usage-of-openstack-services.adoc @@ -39,8 +39,8 @@ Monitor the resource usage of the {OpenStack} services, such as the APIs and oth . Add the following configuration to `parameter_defaults`: + -``` +---- CollectdEnableLibpodstats: true -``` +---- . Continue with the overcloud deployment procedure.