Broadleaf Microservices
  • v1.0.0-latest-prod

Transition States and Statuses

This doc is designed to codify the states that exist in the ChangeSummary, ChangeSummaryGroup and ChangeDeploy states in the sandbox transition lifecycle.

Table 1. Transition States and Statuses
Domain Changes

Revert

ChangeSummary Start

  • status = REVERTING

  • state = USER

ChangeSummary Complete

  • status = FINISHED (or ERROR_REVERT if error)

  • state = USER

  • archived = true if not error

Promote

ChangeSummary Start

  • status = PROMOTING

  • state = USER

ChangeSummaryGroup Start

  • status = PROMOTING

  • state = PROMOTED

ChangeSummary Complete

  • status = FINISHED (or ERROR_PROMOTE if error)

  • state = PROMOTED (or USER if error)

ChangeSummaryGroup Complete

  • status = FINISHED (or ERROR_PROMOTE if error)

  • state = PROMOTED

  • archived = true if error

Reject

ChangeSummary Start

  • status = REJECTING

  • state = PROMOTED

ChangeSummaryGroup Start

  • status = REJECTING

  • state = PROMOTED

ChangeSummary Complete

  • status = REJECTED (or ERROR_REJECT if error)

  • state = USER (or PROMOTED if error)

ChangeSummaryGroup Complete

  • status = REJECTED (or ERROR_REJECT if error)

  • state = PROMOTED

  • archived = true if not error

Deploy Immediately

ChangeDeploy Start

  • status = DEPLOYING

  • state = SCHEDULED

ChangeSummaryGroup Start

  • status = DEPLOYING

  • state = APPROVED

ChangeSummary Start

  • status = FINISHED

  • state = APPROVED

Then the change summaries are deployed with the above states in ChangeSummary.

Scheduled Deployment

ChangeDeploy Start

  • status = SCHEDULING

  • state = APPROVED

ChangeSummaryGroup Start

  • status = SCHEDULING

  • state = APPROVED

ChangeSummary Start

  • status = SCHEDULING

  • state = APPROVED

ChangeDeploy Complete

  • status = FINISHED

  • state = SCHEDULED

ChangeSummaryGroup Complete

  • status = FINISHED

  • state = SCHEDULED

ChangeSummary Complete

  • status = FINISHED

  • state = SCHEDULED

Schedule Triggered

ChangeDeploy Start

  • status = DEPLOYING

  • state = SCHEDULED

ChangeSummaryGroup Start

  • status = DEPLOYING

  • state = SCHEDULED

Change summaries are read with a status of either FINISHED or SCHEDULING, and a state of either APPROVED or SCHEDULED, then the change summaries are deployed

Unschedule Deployment

ChangeDeploy Start

  • status = UNSCHEDULING

  • state = APPROVED/SCHEDULED

ChangeSummaryGroup Start

  • status = UNSCHEDULING

  • state = SCHEDULED

ChangeSummary Start

  • status = UNSCHEDULING

  • state = SCHEDULED

ChangeDeploy Complete

  • status = FINISHED (or ERROR_UNSCHEDULE if error)

  • state = APPROVED

ChangeSummaryGroup Complete

  • status = FINISHED (or ERROR_UNSCHEDULE if error)

  • state = APPROVED

ChangeSummary Complete

  • status = FINISHED (or ERROR_UNSCHEDULE if error)

  • state = APPROVED

Change Summary Deployments

Table 2. Deploying change summaries
Domain Changes

ChangeSummary Start

  • status = DEPLOYING

  • state = SCHEDULED

ChangeSummary Completion

  • status = FINISHED

  • state = DEPLOYED

WorkflowDeployRequests are created and executed against each change summary.