distcloud/api-ref/source/samples
Victor Romano f081453b3c Add subcloud deploy abort option to dcmanager
This commit adds the command "subcloud deploy abort" to dcmanager.
It allows the user to abort the on-going execution of a playbook
against the subcloud. Any task will be aborted immediately if the
unabortable flag is not set by the playbook [1]. If current
operation is install, a shutdown command will also be issued.

Test Plan:
  Success cases:
  - PASS: Trigger an abort during installation and verify that the
          playbook execution was aborted immediately, the subcloud was
          shut dows after it and the RVMC pod and job were terminated.
  - PASS: Trigger an abort during config and verify that
          the playbook execution was aborted immediately.
  - PASS: Trigger an abort during bootstrap without the presence
          of unabortable flag and verify that the playbook execution
          was aborted immidiately.
  - PASS: Trigger an abort during bootstrap with the presence of
          unabortable flag and verify that the playbook execution
          was aborted only after the flag was deleted.
  - PASS: Trigger an abort directly calling the API (using CURL
          instead of using the CLI.
  Failure cases:
  - PASS: Verify that the abort request is rejected if deploy
          state is not 'installing', 'bootstrapping' or 'configuring'.
  - PASS: Abort when an unabortable task is running and then force an
          external error during this task restarting dcmanager-manager
          service, verify that deploy state is set to a failed state
          e.g. bootstrap-failed.
  - PASS: Abort when an unabortable task is running and then force an
          internal error during this task using ansible.builtin.fail
          module, verify that deploy state is set to a failed state
          e.g. bootstrap-failed.
  - PASS: Abort when an unabortable task is running and then force
          the playbook to halt the execution during this task using
          ansible.builtin.pause module, verify that deploy state is
          set to a failed state after 10 minutes
          e.g. bootstrap-failed.

Story: 2010756
Task: 48102

Co-Authored-By: Gustavo Herzmann <gustavo.herzmann@windriver.com>
Signed-off-by: Victor Romano <victor.gluzromano@windriver.com>
Change-Id: Ic5311324a76bf7ce1215692e934d5577ff82868e
2023-07-19 14:16:00 -03:00
..
alarms Updating API docs for dcmanager commands 2022-01-13 12:45:53 -06:00
phased-subcloud-deploy Add subcloud deploy abort option to dcmanager 2023-07-19 14:16:00 -03:00
subcloud-backup Add release parameter to subcloud-backup restore 2023-04-12 16:20:33 -03:00
subcloud-deploy Add release optionality to subcloud add/reinstall 2023-04-03 00:12:39 +00:00
subcloud-groups Update dcmanager API doc for subcloud-backup 2022-10-27 15:23:34 -03:00
subclouds Rename config_sync_status field 2023-05-24 17:57:11 -03:00
sw-update-options Updating API docs for dcmanager commands 2022-01-13 12:45:53 -06:00
sw-update-strategy Add upload-only parameter to dcmanager api-ref docs 2023-03-15 09:12:05 -03:00
root-get-response.json Updating API docs for dcmanager commands 2022-01-13 12:45:53 -06:00