Skip to content

Commit 9ca111b

Browse files
committed
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 <ramishra@redhat.com>
1 parent b243f21 commit 9ca111b

2 files changed

Lines changed: 62 additions & 17 deletions

File tree

docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -369,20 +369,3 @@ spec:
369369
edpm-compute-0:
370370
hostName: edpm-compute-0
371371
----
372-
373-
=== Relevant Status Condition
374-
375-
`NodeSetBaremetalProvisionReady` condition in status condtions reflects the status of
376-
baremetal provisioning as shown below.
377-
378-
[,console]
379-
----
380-
$ oc get openstackdataplanenodeset openstack-edpm-ipam -o json | jq '.status.conditions[] | select(.type=="NodeSetBaremetalProvisionReady")'
381-
{
382-
"lastTransitionTime": "2024-02-01T04:41:58Z",
383-
"message": "NodeSetBaremetalProvisionReady ready",
384-
"reason": "Ready",
385-
"status": "True",
386-
"type": "NodeSetBaremetalProvisionReady"
387-
}
388-
----

docs/assemblies/ref_data-plane-conditions-and-states.adoc

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,72 @@ For an `OpenStackDataPlaneNodeSet`, until an `OpenStackDataPlaneDeployment` has
2828
|`Deployed` |
2929
* "True": The `OpenStackDataPlaneNodeSet` CR is successfully deployed.
3030
* "False": The deployment is not yet requested or has failed, or there are other failed conditions.
31+
|`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].
3132
|`DNSClusterAddresses` |
3233
|`CtlplaneSearchDomain` |
3334
|===
3435

36+
[id="ref_deployment-execution-summaries_{context}"]
37+
=== Deployment execution summaries
38+
39+
The `OpenStackDataPlaneNodeSet` status includes a
40+
`deploymentExecutionSummaries` field that stores ansible execution summaries
41+
for all completed and failed deployments for the NodeSet.
42+
43+
The field is keyed first by deployment name and then by ansible job name. Each
44+
job entry contains:
45+
46+
* `totalHosts`
47+
* `failedHosts`
48+
* `unreachableHosts`
49+
* `failurePercent`
50+
* `failedHostList`
51+
* `unreachableHostList`
52+
53+
The following example shows how to view the execution summary recorded in the
54+
NodeSet status:
55+
56+
[,console]
57+
----
58+
$ oc get openstackdataplanenodeset openstack-edpm-ipam -o json | jq '.status.deploymentExecutionSummaries'
59+
{
60+
"openstack-edpm-deployment": {
61+
"bootstrap-openstack-edpm-deployment-openstack-edpm-ipam": {
62+
"totalHosts": 3,
63+
"failedHosts": 1,
64+
"unreachableHosts": 1,
65+
"failurePercent": 67,
66+
"failedHostList": [
67+
"host-b"
68+
],
69+
"unreachableHostList": [
70+
"host-c"
71+
]
72+
}
73+
},
74+
"openstack-edpm-deployment-2": {
75+
"bootstrap-openstack-edpm-deployment-2-openstack-edpm-ipam": {
76+
"totalHosts": 2,
77+
"failedHosts": 0,
78+
"unreachableHosts": 0,
79+
"failurePercent": 0,
80+
"failedHostList": [],
81+
"unreachableHostList": []
82+
},
83+
"configure-network-openstack-edpm-deployment-2-openstack-edpm-ipam": {
84+
"totalHosts": 2,
85+
"failedHosts": 0,
86+
"unreachableHosts": 1,
87+
"failurePercent": 50,
88+
"failedHostList": [],
89+
"unreachableHostList": [
90+
"host-a"
91+
]
92+
}
93+
}
94+
}
95+
----
96+
3597
.`OpenStackDataPlaneDeployment` CR conditions
3698
[cols="40%a,60%a",options="header",]
3799
|===

0 commit comments

Comments
 (0)