From 38a19371ca932c88825f045ea358131b8ad97259 Mon Sep 17 00:00:00 2001 From: rabi Date: Fri, 17 Jul 2026 15:15:11 +0530 Subject: [PATCH] Add DeploymentExecutionSummaries documentation Document the deploymentExecutionSummaries status field on OpenStackDataPlaneNodeSet in the data plane conditions and states reference. Remove the old condition example from the baremetal provisioning docs as it is already covered in the conditions and states reference. Signed-off-by: rabi --- ...visioning-bare-metal-data-plane-nodes.adoc | 17 ----- .../ref_data-plane-conditions-and-states.adoc | 62 +++++++++++++++++++ 2 files changed, 62 insertions(+), 17 deletions(-) diff --git a/docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc b/docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc index 7c85d6374a..e6a4e7bb3f 100644 --- a/docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc +++ b/docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc @@ -369,20 +369,3 @@ spec: edpm-compute-0: hostName: edpm-compute-0 ---- - -=== Relevant Status Condition - -`NodeSetBaremetalProvisionReady` condition in status condtions reflects the status of -baremetal provisioning as shown below. - -[,console] ----- -$ oc get openstackdataplanenodeset openstack-edpm-ipam -o json | jq '.status.conditions[] | select(.type=="NodeSetBaremetalProvisionReady")' -{ - "lastTransitionTime": "2024-02-01T04:41:58Z", - "message": "NodeSetBaremetalProvisionReady ready", - "reason": "Ready", - "status": "True", - "type": "NodeSetBaremetalProvisionReady" -} ----- diff --git a/docs/assemblies/ref_data-plane-conditions-and-states.adoc b/docs/assemblies/ref_data-plane-conditions-and-states.adoc index 0560946721..1bb3c49366 100644 --- a/docs/assemblies/ref_data-plane-conditions-and-states.adoc +++ b/docs/assemblies/ref_data-plane-conditions-and-states.adoc @@ -28,10 +28,72 @@ For an `OpenStackDataPlaneNodeSet`, until an `OpenStackDataPlaneDeployment` has |`Deployed` | * "True": The `OpenStackDataPlaneNodeSet` CR is successfully deployed. * "False": The deployment is not yet requested or has failed, or there are other failed conditions. +|`DeploymentExecutionSummaries` |Stores ansible execution summaries for all completed and failed deployments for the NodeSet, keyed by deployment name and then by ansible job name. For details, see xref:ref_deployment-execution-summaries_{context}[Deployment execution summaries]. |`DNSClusterAddresses` | |`CtlplaneSearchDomain` | |=== +[id="ref_deployment-execution-summaries_{context}"] +== Deployment execution summaries + +The `OpenStackDataPlaneNodeSet` status includes a +`deploymentExecutionSummaries` field that stores ansible execution summaries +for all completed and failed deployments for the NodeSet. + +The field is keyed first by deployment name and then by ansible job name. Each +job entry contains: + +* `totalHosts` +* `failedHosts` +* `unreachableHosts` +* `failurePercent` +* `failedHostList` +* `unreachableHostList` + +The following example shows how to view the execution summary recorded in the +NodeSet status: + +[,console] +---- +$ oc get openstackdataplanenodeset openstack-edpm-ipam -o json | jq '.status.deploymentExecutionSummaries' +{ + "openstack-edpm-deployment": { + "bootstrap-openstack-edpm-deployment-openstack-edpm-ipam": { + "totalHosts": 3, + "failedHosts": 1, + "unreachableHosts": 1, + "failurePercent": 67, + "failedHostList": [ + "host-b" + ], + "unreachableHostList": [ + "host-c" + ] + } + }, + "openstack-edpm-deployment-2": { + "bootstrap-openstack-edpm-deployment-2-openstack-edpm-ipam": { + "totalHosts": 2, + "failedHosts": 0, + "unreachableHosts": 0, + "failurePercent": 0, + "failedHostList": [], + "unreachableHostList": [] + }, + "configure-network-openstack-edpm-deployment-2-openstack-edpm-ipam": { + "totalHosts": 2, + "failedHosts": 0, + "unreachableHosts": 1, + "failurePercent": 50, + "failedHostList": [], + "unreachableHostList": [ + "host-a" + ] + } + } +} +---- + .`OpenStackDataPlaneDeployment` CR conditions [cols="40%a,60%a",options="header",] |===