> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deployment status

export const ONLINE_TOOLTIP = {
  tip: "Device is connected to Miru's servers",
  cta: "Learn more",
  href: "/learn/devices/overview#status"
};

A deployment tracks its state with three independent statuses: a [target status](#target-status), an [activity status](#activity-status), and an [error status](#error-status). The activity and error statuses are merged into a single [status](#status).

## Status

The status is a merged property of the `activity status` and `error status` fields, with error states taking precedence over activity states when errors are present.

So, if the error status is `none`, then the status is simply the activity status. If the error status is not `none`, then the status is the error status.

Below are examples of status values for different activities and error states.

| Activity Status | Error Status | Status     |
| --------------- | ------------ | ---------- |
| `staged`        | `none`       | `staged`   |
| `deployed`      | `none`       | `deployed` |
| `queued`        | `retrying`   | `retrying` |
| `removing`      | `none`       | `removing` |
| `archived`      | `failed`     | `failed`   |

## Target status

The target status is the desired state of a deployment. There are three possible target statuses.

| Target Status | Description                                                               |
| ------------- | ------------------------------------------------------------------------- |
| `staged`      | Deployment doesn't want to be deployed, but may be deployed in the future |
| `deployed`    | Deployment wants to be delivered to its device                            |
| `archived`    | Deployment no longer wants to be deployed; it can never be deployed again |

**With Staging**

If a deployment is staged before being deployed, the diagram below shows the valid transitions between target statuses.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/target-status-with-staging.light.svg" alt="Deployment target status with staging" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/target-status-with-staging.dark.svg" alt="Deployment target status with staging" className="hidden dark:block" />

**Without Staging**

Of course, many deployments skip staging and deploy immediately (such as those deployed from a device's [config editor](/cfg-mgmt/deploy/config-editor)). The diagram below shows the valid transitions between target statuses for a deployment that is immediately deployed.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/target-status-no-staging.light.svg" alt="Deployment target status without staging" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/target-status-no-staging.dark.svg" alt="Deployment target status without staging" className="hidden dark:block" />

**One-Time Use**

As you can see, the target status can only move *forward*, never backwards.

Once a deployment's target status has been set to `deployed`, it can never be set to `staged` again.  Similarly, once a deployment's target status has been set to `archived`, it can never be set to `deployed` again.

This is intentional—deployments are one-time use. Once a deployment has been deployed, it cannot be redeployed. You must create a new deployment with identical content to roll back.

## Activity status

The activity status is the *last known* state of a deployment.

We use *the last known state* intentionally—poor network connectivity can prevent devices from immediately syncing their activity state with the cloud. In practice, this isn't too common. However, it's still a critical point to keep in mind.

There are six possible activity states for a deployment.

| Activity Status | Description                                                                                                                                                                            |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `staged`        | Deployment has been created and is ready to be deployed                                                                                                                                |
| `drifted`       | Deployment has [drifted](/cfg-mgmt/deploy/staging-area#deployment-drift) and needs to be reviewed                                                                                      |
| `queued`        | Deployment is waiting for the device to be <Tooltip tip={ONLINE_TOOLTIP.tip} cta={ONLINE_TOOLTIP.cta} href={ONLINE_TOOLTIP.href}>online</Tooltip> so it can be delivered to the device |
| `deployed`      | Deployment has been delivered to the device, and its configurations are available for consumption                                                                                      |
| `removing`      | Deployment's configurations are being removed from the device                                                                                                                          |
| `archived`      | Deployment is available for historical reference, but can never be deployed again                                                                                                      |

**With Staging**

When a deployment is [staged](/cfg-mgmt/deploy/staging-area) before being deployed, its lifecycle has two phases: a **review phase** and a **deployment phase**.

During the review phase, a staged deployment may [drift](/cfg-mgmt/deploy/staging-area#deployment-drift) if the underlying release changes. A drifted deployment transitions to `drifted` and must either be restaged or archived.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-review.light.svg" alt="Deployment activity status during review phase" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-review.dark.svg" alt="Deployment activity status during review phase" className="hidden dark:block" />

Once the deployment is approved, it enters the deployment phase. The deployment is queued for delivery to the device, delivered, and eventually removed and archived.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-staging.light.svg" alt="Deployment activity status during deployment phase" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-staging.dark.svg" alt="Deployment activity status during deployment phase" className="hidden dark:block" />

**Without Staging**

Deployments which are immediately deployed and skip the `staged` state have a simpler lifecycle. They simply go through the primary deployment lifecycle from `queued` to `archived`, passing through `removing` when being taken off the device.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-no-staging.light.svg" alt="Deployment activity status without staging" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/activity-status-no-staging.dark.svg" alt="Deployment activity status without staging" className="hidden dark:block" />

**One-Time Use**

As with the target status, activity states can only progress forward since deployments are one-time.

## Error status

The error status is the *last known* error state of a deployment. Again, we use *the last known state* intentionally—poor network connectivity can prevent devices from immediately syncing their error state to the cloud.

The error status is independent of the activity and target statuses. The error status does not imply any particular activity or target state, and vice versa. The error status is only concerned with errors encountered during deployment.

There are three possible error states for a deployment.

| Error Status | Description                                                                                             |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| `none`       | There are no errors with the deployment                                                                 |
| `retrying`   | A non-fatal error has been encountered; the agent is retrying to fulfill the deployment's target status |
| `failed`     | A fatal error has been encountered; the deployment is (or will be) removed from the device and archived |

Below are the valid transitions between error states.

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/error-lifecycle.light.svg" alt="Deployment error status lifecycle" className="block dark:hidden" />

<img src="https://assets.mirurobotics.com/docs/v04/images/deployments/error-lifecycle.dark.svg" alt="Deployment error status lifecycle" className="hidden dark:block" />

Deployments start in the `none` error state. If no errors are encountered, the deployment remains in the `none` error state for the duration of its existence.

**Non-Fatal Errors**

If a non-fatal error is encountered, the deployment transitions to the `retrying` error state. Non-fatal errors include unexpected network drops, sudden power cycles, and similar events.

If the agent recovers the deployment from the error, the deployment transitions back to the `none` error state once the deployment's target status is reached.

On the other hand, as long as the agent is unable to recover the deployment, the deployment remains in the `retrying` error state. The agent continually attempts to reach the deployment's target status, using exponential backoff to prevent resource throttling.

If the deployment is stuck in the `retrying` error state, try replacing or archiving the deployment to allow the agent to start fresh.

**Fatal Errors**

If a fatal error is encountered, the deployment transitions to the `failed` error state, is removed from the device, and marked as `archived`.