| --- |
| title: vessl serve |
| version: EN |
| --- |
| |
| ### Overview |
|
|
| Run `vessl serve --help` to view list of commands, or `vessl serve [COMMAND] --help` to view individual command instructions. |
|
|
| Run `vessl serve revision --help` to view list of commands, or `vessl serve revision [COMMAND] --help` to view individual command instructions. |
|
|
| Run `vessl serve gateway --help` to view list of commands, or `vessl serve gateway [COMMAND] --help` to view individual command instructions. |
|
|
| ### List all servings |
|
|
| ``` |
| vessl serve list |
| ``` |
|
|
| ### Create a revision |
|
|
| ``` |
| vessl serve revision create [OPTIONS] |
| ``` |
|
|
| | Option | Description | |
| | ------------------------------- | ------------------------------------------------------------------------------------------------------ | |
| | `--serving` | Name of serving. | |
| | `-f`, `--file` | Path to YAML file for creating serving revision. | |
| | `-g`, `--update-gateway` | Whether to update gateway so that it points to this revision. | |
| | `-G`, `--no-update-gateway` | Whether to update gateway so that is points to this revision. | |
| | `-e`, `--enable-gateway-if-off` | When updating gateway, whether to enable the gateway if it is currently off. | |
| | `--update-gateway-weight` | When updating gateway, the amount of traffic that should be directed to this revision. (In percentage) | |
| | `--update-gateway-port` | When updating gateway, the port to receive the traffic; This port must be defined in serving first. | |
|
|
| ### List all revisions |
|
|
| ``` |
| vessl serve revision list [OPTIONS] |
| ``` |
|
|
| | Option | Description | |
| | ----------- | ---------------- | |
| | `--serving` | Name of serving. | |
|
|
| ### Show current status and information about a revision |
|
|
| ``` |
| vessl serve revision show [OPTION] |
| ``` |
|
|
| | Option | Description | |
| | ---------------- | ------------------- | |
| | `--serving` | Name of serving. | |
| | `-n`, `--number` | Number of revision. | |
|
|
| ### Update auto scaler config for a specific revision |
|
|
| ``` |
| vessl serve revision update-autoscaler-config [OPTION] |
| ``` |
|
|
| | Option | Description | |
| | ---------------- | ---------------------------------------------------------| |
| | `--serving` | Name of serving. | |
| | `-n`, `--number` | Number of revision. | |
| | `--min-replicas` | The minimum number of replicas that autoscaler will set. | |
| | `--max-replicas` | The maximum number of replicas that autoscaler will set. | |
|
|
| ### Terminate a specific revision |
|
|
| ``` |
| vessl serve revision terminate [OPTION] |
| ``` |
|
|
| | Option | Description | |
| | ---------------- | ------------------- | |
| | `--serving` | Name of serving. | |
| | `-n`, `--number` | Number of revision. | |
|
|
|
|
| ### Show current status of the gateway of serving |
|
|
| ``` |
| vessl serve gateway show [OPTION] |
| ``` |
|
|
| | Option | Description | |
| | ----------- | ---------------- | |
| | `--serving` | Name of serving. | |
|
|
| ### Update gateway |
|
|
| ``` |
| vessl serve gateway update [OPTION] |
| ``` |
|
|
| | Option | Description | |
| | -------------- | ------------------------------------------------ | |
| | `--serving` | Name of serving. | |
| | `-f`, `--file` | Path to YAML file for serving revision defition. | |
|
|
