Skip to content

Commit 68399a5

Browse files
[serve] update deployment status docs (#51610)
## Why are these changes needed? Update the list of possible deployment statuses in the docs. ## Related issue number <!-- For example: "Closes #1234" --> --------- Signed-off-by: Cindy Zhang <cindyzyx9@gmail.com> Co-authored-by: akyang-anyscale <alexyang@anyscale.com>
1 parent 7eb8d91 commit 68399a5

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/source/serve/monitoring.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,13 @@ deployments:
9898
* `message`: Provides context on the current status.
9999
* `deployment_timestamp`: A UNIX timestamp of when Serve received the last `serve deploy` request. The timestamp is calculated using the `ServeController`'s local clock.
100100
* `deployments`: A list of entries representing each deployment's status. Each entry maps a deployment's name to three fields:
101-
* `status`: A Serve deployment has three possible statuses:
101+
* `status`: A Serve deployment has six possible statuses:
102102
* `"UPDATING"`: The deployment is updating to meet the goal state set by a previous `deploy` request.
103-
* `"HEALTHY"`: The deployment achieved the latest requests goal state.
104-
* `"UNHEALTHY"`: The deployment has either failed to update, or has updated and has become unhealthy afterwards. This condition may be due to an error in the deployment's constructor, a crashed replica, or a general system or machine error.
103+
* `"HEALTHY"`: The deployment is healthy and running at the target replica count.
104+
* `"UNHEALTHY"`: The deployment has updated and has become unhealthy afterwards. This condition may be due to replicas failing to upscale, replicas failing health checks, or a general system or machine error.
105+
* `"DEPLOY_FAILED"`: The deployment failed to start or update. This condition is likely due to an error in the deployment's constructor.
106+
* `"UPSCALING"`: The deployment (with autoscaling enabled) is upscaling the number of replicas.
107+
* `"DOWNSCALING"`: The deployment (with autoscaling enabled) is downscaling the number of replicas.
105108
* `replica_states`: A list of the replicas' states and the number of replicas in that state. Each replica has five possible states:
106109
* `STARTING`: The replica is starting and not yet ready to serve requests.
107110
* `UPDATING`: The replica is undergoing a `reconfigure` update.

0 commit comments

Comments
 (0)