Request states

Edition: Community and Enterprise

A request passes through these states. The page shows the words, never the internal name. The words "when it is your turn" appear to the person who must act next.

stateDiagram-v2
    [*] --> draft
    draft --> checking
    checking --> checks_failed
    checking --> dry_run_pending
    dry_run_pending --> dry_running
    dry_running --> dry_run_failed
    dry_running --> awaiting_review
    awaiting_review --> awaiting_business
    awaiting_review --> approved
    awaiting_business --> approved
    awaiting_business --> awaiting_review: approvals expired
    approved --> awaiting_review: approvals expired
    approved --> executing
    executing --> executed
    executing --> execution_failed
    executing --> approved: window closed
    executed --> rolled_back
    awaiting_review --> rejected
    awaiting_business --> rejected
    rejected --> draft: edit
    checks_failed --> draft: edit
    dry_run_failed --> draft: edit
    execution_failed --> draft: edit
    rolled_back --> [*]
    executed --> [*]

States

State	Words	Words when it is your turn	Tone	Notes
draft	Draft	Draft: submit when ready	quiet	private to the requester
checking	Running checks		quiet	private to the requester
checks_failed	Checks failed	Checks failed: edit to fix	fail	private to the requester
dry_run_pending	Waiting for the dry run		quiet
dry_running	Dry run in progress		quiet
dry_run_failed	Dry run failed	Dry run failed: edit to fix	fail
awaiting_review	Waiting for DBA review	Waiting for your review	act
awaiting_business	Waiting for business approval	Waiting for your approval	act
approved	Approved, ready to run	Approved, ready for you to run	act
executing	Running on the target		quiet
executed	Executed		ink
execution_failed	Execution failed, nothing changed		fail
rejected	Rejected		fail
cancelled	Cancelled		quiet	final
rolled_back	Rolled back		quiet	final

Transitions

From	Event	To	Caused by
draft	submit	checking	the requester submits the values (Submit for review)
checking	checks_passed	dry_run_pending	the static checks pass at submit
checking	checks_failed	checks_failed	a check at error level fails at submit
dry_run_pending	dry_run_start	dry_running	the executor starts the dry run
dry_running	dry_run_ok	awaiting_review	the dry run succeeds (rolled back, within max_rows)
dry_running	dry_run_failed	dry_run_failed	the dry run fails, or affects more rows than max_rows
dry_run_failed	retry_dry_run	dry_run_pending	defined in the state machine and not used: a failed dry run is retried by editing the request and submitting it again
awaiting_review	reject	rejected	a reviewer or approver rejects
awaiting_business	business_approve	approved	the business approvals the policy asks for are complete
awaiting_business	reject	rejected	a reviewer or approver rejects
awaiting_business	approval_expired	awaiting_review	the approvals are older than the approval lifetime
approved	approval_expired	awaiting_review	the approvals are older than the approval lifetime
approved	execute	executing	the requester asks to execute (Execute on the target)
executing	execute_ok	executed	the executor commits the change
executing	execute_failed	execution_failed	the execution fails and is rolled back
executing	execute_deferred	approved	the execution window closed before the executor touched the target
executed	rolled_back	rolled_back	a rollback request of this request executed
awaiting_review	tech_approve	awaiting_business, or approved when the environment's policy needs no business approval	the technical approvals the policy asks for are complete
checks_failed, dry_run_failed, awaiting_review, awaiting_business, approved, execution_failed, rejected	edit	draft	the requester edits: a new revision, approvals cleared
draft, checking, checks_failed, dry_run_pending, dry_running, dry_run_failed, awaiting_review, awaiting_business, approved, execution_failed, rejected	cancel	cancelled	the requester cancels (Cancel request)

A rollback request (kind rollback) cannot be edited; it can be cancelled.