Workflow Zaqar messages should be standardised

[Dougal Matthews]

Most workflows in tripleo-common send messages to the CLI or GUI via Zaqar. The structure for these messages is copied and pasted in all of the workflows.

We should capture this and standardise it across all workflows. This will make for a more consistent messaging behaviour with less repetition.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dougal Matthews (<email address hidden>) on branch: master
Review: https://review.openstack.org/554594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/425060
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=2f91f4c58e075a3d756463663ccc9d45032f5262
Submitter: Zuul
Branch: master

commit 2f91f4c58e075a3d756463663ccc9d45032f5262
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 13 09:16:09 2018 +0000

    Standardise Workflow messaging and optionally persist messages

    This workflow captures the boilerplate that is copied and pasted for Zaqar
    messages. It also adds the ability to persist the messages in Swift.

    This can be manually tested with:

        $ cat input.json
        {
            "type": "test",
            "queue_name": "tripleo",
            "plan_name": "overcloud",
            "execution": {
                "id": "UUID"
            }
        }
        $ openstack workflow execution create tripleo.messaging.v1.send input.json

    Co-Authored-By: Steven Hardy <email address hidden>
    Related-Bug: #1757372
    Implements: blueprint config-download-workflows
    Depends-On: I78b4fc7673a4039ed7ef32b16bb2850411f7fcc6
    Change-Id: Ib854689a3e606f18db7354427918fa8043ac28e0

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/554548
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=53b1704d990900b504b6f24742ce8cc95d39a3ed
Submitter: Zuul
Branch: master

commit 53b1704d990900b504b6f24742ce8cc95d39a3ed
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 20 13:54:19 2018 +0000

    Use the standard messaging in the derive_parameters workbook

    Update the derive_parameters workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Related-Bug: #1757372
    Change-Id: If9bcf6f0348d06041754522d30cb1a110ea7186d

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/554552
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=4c124f6559ae8b17f1634784a0e4ceae81994b23
Submitter: Zuul
Branch: master

commit 4c124f6559ae8b17f1634784a0e4ceae81994b23
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 20 14:01:11 2018 +0000

    Use the standard messaging in the fernet-key-rotate workbook

    Update the fernet-key-rotate workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Related-Bug: #1757372

    Change-Id: I5087b777a24700c0d99c42db9ead64933674247b

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/554593
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=6b47b360afd43cd691619dd6cf7628874224c900
Submitter: Zuul
Branch: master

commit 6b47b360afd43cd691619dd6cf7628874224c900
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 20 14:10:47 2018 +0000

    Use the standard messaging in the networks workbook

    Update the networks workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Related-Bug: #1757372

    Change-Id: Ib346f56b4de59c275e907a6ee4364eb311af2fc5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/552460
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=3b28b87e49cf633e1aa9b6c55c7d2784c2cb0217
Submitter: Zuul
Branch: master

commit 3b28b87e49cf633e1aa9b6c55c7d2784c2cb0217
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 13 09:17:43 2018 +0000

    Use the standard messaging in the baremetal workbook

    Update the baremetal workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Related-Bug: #1757372
    Change-Id: I1665ae56a88557bdb8459651021185cfb9fd1a8f

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/572340

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/572343

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/554595
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=dca8418e78ec50a8dd3a6584e29b68b67ce5bd69
Submitter: Zuul
Branch: master

commit dca8418e78ec50a8dd3a6584e29b68b67ce5bd69
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 20 15:35:26 2018 +0000

    Use the standard messaging in the plan_management workbook

    Update the plan_management workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Related-Bug: #1757372
    Change-Id: I9755eaa6621ec1d83fe98e20445a4f13b4ea0686

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/572343
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=1adc25c9b269fe087a563fb57c3b6092137c3e42
Submitter: Zuul
Branch: master

commit 1adc25c9b269fe087a563fb57c3b6092137c3e42
Author: Dougal Matthews <email address hidden>
Date: Tue Jun 5 12:10:11 2018 +0100

    Use the standard messaging in the swift_rings_backup workbook

    Update the swift_rings_backup workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: Iad199545d0093ccdedf082a945345ad4863ed4d0
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/572340
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=34b4d10634cd56413f610cd8c4e0c19baf04f28b
Submitter: Zuul
Branch: master

commit 34b4d10634cd56413f610cd8c4e0c19baf04f28b
Author: Dougal Matthews <email address hidden>
Date: Tue Jun 5 12:06:27 2018 +0100

    Use the standard messaging in the validations workbook

    Update the validations workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I162407a561cae4e8e7fd665ccbb459b6ccf00bf4
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576173

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576180

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576182

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576187

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576188

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576189

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576190

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/576196

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576180
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=14c73ee0be209d868859e28883535dd2b2773369
Submitter: Zuul
Branch: master

commit 14c73ee0be209d868859e28883535dd2b2773369
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:36:58 2018 +0100

    Use the standard messaging in the package_update workbook

    Update the package_update workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: Icad2846b43dec8032d9692daea390bffa7486dac
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576182
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=e47bbf649eb7a888dd643af8d146f81d3bf21838
Submitter: Zuul
Branch: master

commit e47bbf649eb7a888dd643af8d146f81d3bf21838
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:44:09 2018 +0100

    Use the standard messaging in the plan_management workbook

    Update the plan_management workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    This is a continuation of I9755eaa6621ec1d83fe98e20445a4f13b4ea0686.
    Some old-style messaging was added after the refactor and some redundant
    lines were not removed.

    Change-Id: Ia50e4055e24d07cb39d4c05745bd6694e94621f9
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576188
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=4c24a04977e99d5fcd069ebfc85954d0bb083bc1
Submitter: Zuul
Branch: master

commit 4c24a04977e99d5fcd069ebfc85954d0bb083bc1
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:54:01 2018 +0100

    Use the standard messaging in the scale workbook

    Update the scale workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I906e0ae92bcd084f4bf6ec669d6be0f71dc7a29b
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576189
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=9ca3346709b17aef09abb2e34c6b64f51d6e9aae
Submitter: Zuul
Branch: master

commit 9ca3346709b17aef09abb2e34c6b64f51d6e9aae
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:55:52 2018 +0100

    Use the standard messaging in the undercloud_backup workbook

    Update the undercloud_backup workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I71e761c1295ae0d0ca2773c7521b6a57cabd6227
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576190
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=6c32361cfd5067f4d620a685a47291abe4f4a2f8
Submitter: Zuul
Branch: master

commit 6c32361cfd5067f4d620a685a47291abe4f4a2f8
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:57:13 2018 +0100

    Use the standard messaging in the stack workbook

    Update the stack workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I2bf3b0eea591969892d8c98937f62719c4e02361
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576196
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=388665361d2829424c640e5073ee4137d67f1502
Submitter: Zuul
Branch: master

commit 388665361d2829424c640e5073ee4137d67f1502
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 17:01:01 2018 +0100

    Use the standard messaging in the baremetal workbook

    Update the baremetal workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    This is a continuation of I1665ae56a88557bdb8459651021185cfb9fd1a8f.
    Some old-style messaging was added after the refactor and some redundant
    lines were not removed.

    Change-Id: Ieeabe23ffe134cf19634b4b052805ae7165f34e6
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576187
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=e3834bb2d2eaee5e2ff7644d9e80e37cd50ef02f
Submitter: Zuul
Branch: master

commit e3834bb2d2eaee5e2ff7644d9e80e37cd50ef02f
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:52:13 2018 +0100

    Use the standard messaging in the parameters workbook

    Update the parameters workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I010b848721732a7a186dd4de183089b5e24bfd04
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/576173
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=b1be9bf25b45932372a9acc699d187a703fbb2b2
Submitter: Zuul
Branch: master

commit b1be9bf25b45932372a9acc699d187a703fbb2b2
Author: Dougal Matthews <email address hidden>
Date: Mon Jun 18 16:30:50 2018 +0100

    Use the standard messaging in the support workbook

    Update the support workbook to use the standard message sending
    workflow. This workflow reduces the boilerplate that is copied between
    workflows by defining the message structure, providing the retry logic
    and ensuring the task on a "FAILED" message.

    The workflow also offers optional persistence in Swift. If the plan name
    is given to the workflow it will store the messages in a Swift container
    named <plan_name>-messages.

    Change-Id: I9f914489630b9de59ffa819093b8b54e135877e8
    Related-Bug: #1757372

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/queens
Review: https://review.opendev.org/655203

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/655203
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=3ea5ae621439ec082e1a77b2d43de5dd94a3e52f
Submitter: Zuul
Branch: stable/queens

commit 3ea5ae621439ec082e1a77b2d43de5dd94a3e52f
Author: Dougal Matthews <email address hidden>
Date: Tue Mar 13 09:16:09 2018 +0000

    Standardise Workflow messaging and optionally persist messages

    This workflow captures the boilerplate that is copied and pasted for Zaqar
    messages. It also adds the ability to persist the messages in Swift.

    This can be manually tested with:

        $ cat input.json
        {
            "type": "test",
            "queue_name": "tripleo",
            "plan_name": "overcloud",
            "execution": {
                "id": "UUID"
            }
        }
        $ openstack workflow execution create tripleo.messaging.v1.send input.json

    Co-Authored-By: Steven Hardy <email address hidden>
    Related-Bug: #1757372
    Implements: blueprint config-download-workflows
    Depends-On: I78b4fc7673a4039ed7ef32b16bb2850411f7fcc6
    Change-Id: Ib854689a3e606f18db7354427918fa8043ac28e0
    (cherry picked from commit 2f91f4c58e075a3d756463663ccc9d45032f5262)