Plan States

Plans can be in these states:

  1. APPROVED

    The plan has been created, but is not yet running.

  2. RUNNING

    The plan is currently executing.

  3. SUCCEEDED

    The plan has completed successfully.

  4. INTERRUPTED

    A RUNNING plan has been manually interrupted, using the interrupt command in the CLI.

  5. INTERRUPT REQUESTED

    A plan has been manually interrupted, but is still processing the interrupt request. A plan may have to cleanup or reverse steps take during plan execution to be sure that the store remains in a consistent state.

  6. ERROR

    A RUNNING plan has encountered a problem, and has ended without successfully completing.

  7. CANCELED

    An INTERRUPTED or ERROR plan has been terminated using the CLI. To cancel a plan using the CLI, use the cancel command.

Plans in INTERRUPTED, INTERRUPT REQUESTED or ERROR state can be retried using the the plan execute command. Retrying may be an appropriate approach when the underlying problem was transient or has been rectified. Plans that are retried simply re-execute the same steps. Each step is idempotent, and can be safely repeated.

Note that Storage Nodes and Replication Nodes may encounter errors which are detected by the Admin Console and are displayed in an error dialog before the plan has processed the information. Because of that, the user may learn of the error while the Admin service still considers the plan to be RUNNING and active. The plan eventually sees the error and transitions to an ERROR state.