Skip to content

Commit dbd96a5

Browse files
committed
Add docs for resource statuses
1 parent 7463408 commit dbd96a5

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Resource Statuses
2+
3+
## Statuses
4+
5+
| Status | Meaning |
6+
|----------------------|---|
7+
| ready | Resource is ready |
8+
| pending | Resource is waiting for another resource to be ready, or its workload is initializing |
9+
| running, ingesting,<br>aggregating, transforming,<br>generating, training | Resource is being created |
10+
| error | Resource was not created due to an error; run `cortex logs <name>` to view the logs |
11+
| skipped | Resource was not created due to an error in another resource in the same workload |
12+
| terminated | Resource was terminated |
13+
| upstream error | Resource was not created due to an error in one of its dependencies |
14+
| upstream termination | Resource was not created because one of its dependencies was terminated |
15+
| compute unavailable | Resource's workload could not start due to insufficient memory or CPU in the cluster |
16+
17+
## API statuses
18+
19+
| Status | Meaning |
20+
|----------------------|---|
21+
| ready | API is deployed and ready to serve prediction requests |
22+
| pending | API is waiting for another resource to be ready, or is initializing |
23+
| updating | API is performing a rolling update |
24+
| update pending | API will be updated when the new model is ready; a previous version of this API is ready |
25+
| stopping | API is stopping |
26+
| stopped | API is stopped |
27+
| error | API was not created due to an error; run `cortex logs <name>` to view the logs |
28+
| skipped | API was not created due to an error in another resource |
29+
| update skipped | API was not updated due to an error in another resource; a previous version of this API is ready |
30+
| upstream error | API was not created due to an error in one of its dependencies; a previous version of this API may be ready |
31+
| upstream termination | API was not created because one of its dependencies was terminated; a previous version of this API may be ready |
32+
| compute unavailable | API could not start due to insufficient memory or CPU in the cluster; some replicas may be ready |

docs/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ Deployment started
323323
324324
The first deployment may take some extra time as Cortex's dependencies are downloaded.
325325
326-
You can get an overview of the deployment using `cortex get`:
326+
You can get an overview of the deployment using `cortex get` (see [resource statuses](applications/resources/statuses.md) for the meaning of each status):
327327
328328
```
329329
$ cortex get

docs/summary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
* [Models](applications/resources/models.md)
2525
* [APIs](applications/resources/apis.md)
2626
* [Constants](applications/resources/constants.md)
27+
* [Resource Statuses](applications/resources/statuses.md)
2728

2829
### Implementations
2930

0 commit comments

Comments
 (0)