openstack
/
tripleo-docs
Code Issues Proposed changes

Merge "Update documentation about deployment status"

This commit is contained in:
Zuul 2022-11-14 14:00:18 +00:00 committed by Gerrit Code Review
parent 2522113767 3b584b8f4f
commit aa74a99b02
1 changed files with 15 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
deploy-guide/source/deployment/deployment_status.rst
View File

@ -12,53 +12,22 @@ example of the output::
[stack@undercloud ]$ openstack overcloud status
+-----------+---------------------+---------------------+-------------------+
| Plan Name | Created | Updated | Deployment Status |
+-----------+---------------------+---------------------+-------------------+
| overcloud | 2018-05-03 21:24:50 | 2018-05-03 21:27:59 | DEPLOY_SUCCESS |
+-----------+---------------------+---------------------+-------------------+
+------------+-------------------+
| Stack Name | Deployment Status |
+------------+-------------------+
| overcloud | DEPLOY_SUCCESS |
+------------+-------------------+
A different plan name can be specified with ``--plan``::
A different stack name can be specified with ``--stack``::
[stack@undercloud ]$ openstack overcloud status --plan my-deployment
[stack@undercloud ]$ openstack overcloud status --stack my-deployment
+---------------+---------------------+---------------------+-------------------+
| Plan Name | Created | Updated | Deployment Status |
+-----------+-------------------------+---------------------+-------------------+
| my-deployment | 2018-05-03 21:24:50 | 2018-05-03 21:27:59 | DEPLOY_SUCCESS |
+---------------+---------------------+---------------------+-------------------+
+---------------+-------------------+
| Stack Name | Deployment Status |
+-----------+-----------------------+
| my-deployment | DEPLOY_SUCCESS |
+---------------+-------------------+
Deployment failures can also be shown with a new command::
[stack@undercloud ]$ openstack overcloud failures --plan my-deployment
.. note::
Heat CLI commands such as ``openstack stack failures list`` can still be used
to show stack failures, however since Heat no longer applies software
configuration, it will no longer show any errors related to configuration.
Setting the status
__________________
The status of the deployment will be automatically set by the API used by the
Mistral workflows. However, in some cases, it may be required to manually set
the status to reflect what has been done manually outside of the API. The
following commands can be used to manually set the status.
Set the status to ``DEPLOY_SUCCESS``::
openstack workflow execution create tripleo.deployment.v1.set_deployment_status_success
Set the status to ``DEPLOYING``::
openstack workflow execution create tripleo.deployment.v1.set_deployment_status_deploying
Set the status to ``DEPLOY_FAILED``::
openstack workflow execution create tripleo.deployment.v1.set_deployment_status_failed
The default plan name of overcloud will be used in the above commands. It can
be overridden with any of the above commands if needed::
openstack workflow execution create tripleo.deployment.v1.set_deployment_status_success '{"plan":"my-cloud-name"}'
The deployment status is stored in the YAML file, generated at
``$HOME/overcloud-deploy/<stack>/<stack>-deployment_status.yaml`` in
the undercloud node.