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 services
Create a YAML file
vessl serve create-yaml [SERVICE_NAME] [OPTIONS]
| Option | Description |
|---|
-k, --api-key | Asks you the organization secret to use for API key of your service. |
Create a revision (and launch)
vessl serve create [OPTIONS]
| Option | Description |
|---|
-f, --file | Path to YAML file for creating service. |
-l, --launch | Whether to launch the service after creating. |
-a, --set-current-active | Whether to set the current service as active, Steps: 1. launches the revision 2. enables the endpoint 3. stops other revisions |
--force | Whether to force the creation of service with aborting ongoing rollout if exists. |
Update a traffic split for a service
vessl serve update [OPTIONS]
| Option | Description |
|---|
--service | Name of service. |
-n, `—number | Number of revision. You can pass multiple. |
-w, --weight | The amount of traffic that should be directed to this revision. (In percentage) The sum of traffics should be exactly 100. |
List all revisions
vessl serve revision list [OPTIONS]
| Option | Description |
|---|
--service | Name of service. |
vessl serve revision show [OPTION]
| Option | Description |
|---|
--service | Name of service. |
-n, --number | Number of revision. |
Terminate a specific revision
vessl serve revision terminate [OPTION]
| Option | Description |
|---|
--service | Name of service. |
-n, --number | Number of revision. |
Show current status of the gateway of service
vessl serve gateway show [OPTION]
| Option | Description |
|---|
--service | Name of service. |
Update gateway
vessl serve gateway update [OPTION]
| Option | Description |
|---|
--service | Name of service. |
-f, --file | Path to YAML file for service revision defition. |
Deprecated
(Deprecated) Create a revision
vessl serve revision create [OPTIONS]
| Option | Description |
|---|
--serving | Name of service. |
-f, --file | Path to YAML file for creating service 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 service first. |
(Deprecated) Update auto scaler config for a specific revision
vessl serve revision update-autoscaler-config [OPTION]
| Option | Description |
|---|
--serving | Name of service. |
-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. |
