From 56d0a0d6ea9fa2ede55b4dadda05e60609e3b986 Mon Sep 17 00:00:00 2001 From: Ronelle Landy Date: Fri, 27 Jun 2025 16:46:17 -0400 Subject: [PATCH] Update workload balance doc per review comments The original documentation update review [1] had some additional comments for improvements. The commit adds the suggested changes. [1] https://review.opendev.org/c/openstack/watcher/+/951025 Change-Id: I4b4624e2dbc4c6a5f888ec77d6a03b8f66ff0a23 --- doc/source/strategies/workload_balance.rst | 44 +++++++++++----------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/source/strategies/workload_balance.rst b/doc/source/strategies/workload_balance.rst index 4f0a22589..e3d664f34 100644 --- a/doc/source/strategies/workload_balance.rst +++ b/doc/source/strategies/workload_balance.rst @@ -14,7 +14,7 @@ Synopsis Metrics ******* -The *workload_balance* strategy requires the following metrics: +The ``workload_balance`` strategy requires the following metrics: ======================= ============ ======= =========== ====================== metric service name plugins unit comment @@ -29,17 +29,17 @@ metric service name plugins unit comment .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute -**Notes** - -* The parameters above reference the instance CPU or RAM usage, but - the threshold calculation is based of the CPU/RAM usage on the hypervisor. -* The RAM usage can be calculated based on the RAM consumed by the instance, - and the available RAM on the hypervisor. -* The CPU percentage calculation relies on the CPU load, but also on the number - of CPUs on the hypervisor. -* The memory host metric is calculated by summing the RAM usage of each - instance on the host. This measure is close to the real usage, but is not - the exact usage on the host. +.. note:: + * The parameters above reference the instance CPU or RAM usage, but + the threshold calculation is based of the CPU/RAM usage on the + hypervisor. + * The RAM usage can be calculated based on the RAM consumed by the instance, + and the available RAM on the hypervisor. + * The CPU percentage calculation relies on the CPU load, but also on the + number of CPUs on the hypervisor. + * The host memory metric is calculated by summing the RAM usage of each + instance on the host. This measure is close to the real usage, but is + not the exact usage on the host. Cluster data model ****************** @@ -77,7 +77,7 @@ Strategy parameters are: ================ ====== ==================== ================================== parameter type default value description ================ ====== ==================== ================================== -``metrics`` String 'instance_cpu_usage' Workload balance base on cpu or +``metrics`` String instance_cpu_usage Workload balance base on cpu or ram utilization. Choices: ['instance_cpu_usage', 'instance_ram_usage'] @@ -111,19 +111,19 @@ to: https://specs.openstack.org/openstack/watcher-specs/specs/mitaka/implemented How to use it ? --------------- -Create and audit template using the Workload Balancing strategy. +Create an audit template using the Workload Balancing strategy. .. code-block:: shell $ openstack optimize audittemplate create \ at1 workload_balancing --strategy workload_balance -Run an audit using the Workload Balance strategy where -the aim is to get a plan to move VMs from any host where the -CPU usage is over the threshold of 26%, to a host where the -utilization of CPU is under the threshold. -The measurements of CPU utilization are taken from Ceilometer -with an aggregate period of 310. +Run an audit using the Workload Balance strategy. The result of +the audit should be an action plan to move VMs from any host +where the CPU usage is over the threshold of 26%, to a host +where the utilization of CPU is under the threshold. +The measurements of CPU utilization are taken from the configured +datasouce plugin with an aggregate period of 310. .. code-block:: shell @@ -132,8 +132,8 @@ with an aggregate period of 310. Run an audit using the Workload Balance strategy to obtain a plan to balance VMs over hosts with a threshold of 20%. -In this case, the stipulation of the Ceilometer CPU utilization -metric measurement is a combination of period and granularity. +In this case, the stipulation of the CPU utilization metric +measurement is a combination of period and granularity. .. code-block:: shell