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

vessl serve list

Create a YAML file

vessl serve create-yaml [SERVICE_NAME] [OPTIONS]
OptionDescription
-k, --api-keyAsks you the organization secret to use for API key of your service.

Create a revision (and launch)

vessl serve create [OPTIONS]
OptionDescription
-f, --filePath to YAML file for creating service.
-l, --launchWhether to launch the service after creating.
-a, --set-current-activeWhether to set the current service as active, Steps: 1. launches the revision 2. enables the endpoint 3. stops other revisions
--forceWhether to force the creation of service with aborting ongoing rollout if exists.

Update a traffic split for a service

vessl serve update [OPTIONS]
OptionDescription
--serviceName of service.
-n, `—numberNumber of revision. You can pass multiple.
-w, --weightThe 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]
OptionDescription
--serviceName of service.

Show current status and information about a revision

vessl serve revision show [OPTION]
OptionDescription
--serviceName of service.
-n, --numberNumber of revision.

Terminate a specific revision

vessl serve revision terminate [OPTION]
OptionDescription
--serviceName of service.
-n, --numberNumber of revision.

Show current status of the gateway of service

vessl serve gateway show [OPTION]
OptionDescription
--serviceName of service.

Update gateway

vessl serve gateway update [OPTION]
OptionDescription
--serviceName of service.
-f, --filePath to YAML file for service revision defition.

Deprecated

(Deprecated) Create a revision

vessl serve revision create [OPTIONS]
OptionDescription
--servingName of serving.
-f, --filePath to YAML file for creating serving revision.
-g, --update-gatewayWhether to update gateway so that it points to this revision.
-G, --no-update-gatewayWhether to update gateway so that is points to this revision.
-e, --enable-gateway-if-offWhen updating gateway, whether to enable the gateway if it is currently off.
--update-gateway-weightWhen updating gateway, the amount of traffic that should be directed to this revision. (In percentage)
--update-gateway-portWhen updating gateway, the port to receive the traffic; This port must be defined in serving first.

(Deprecated) Update auto scaler config for a specific revision

vessl serve revision update-autoscaler-config [OPTION]
OptionDescription
--servingName of serving.
-n, --numberNumber of revision.
--min-replicasThe minimum number of replicas that autoscaler will set.
--max-replicasThe maximum number of replicas that autoscaler will set.