Skip to content

Add DeploymentExecutionSummaries documentation #1983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rabi wants to merge 1 commit into
base: main
Choose a base branch
from
+62 −17
Open

Add DeploymentExecutionSummaries documentation #1983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions docs/assemblies/con_provisioning-bare-metal-data-plane-nodes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
----
62 changes: 62 additions & 0 deletions docs/assemblies/ref_data-plane-conditions-and-states.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",]
|===
Expand Down
Loading