Overview

Run vessl service --help to view list of commands, or vessl service [COMMAND] --help to view individual command instructions.

When required options are not provided by the user, it will automatically enter interactive mode (and prompt user to select from given options)

List all services

vessl service list

Read service

vessl service read [OPTIONS]
OptionDescription
--serviceName of service.
-d, --detailWhether to show details about each revision.

Create a revision (and launch)

vessl service create [OPTIONS]
OptionDescription
-f, --filePath to YAML file for creating service.
--from-hubModel key to be found in VESSL Hub. This will automatically create a revision, without having to directly provide a YAML file.
-s, --service-nameName of service, either from existing or new 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.
--serverlessWhether to set service to serverless mode.

Terminate a specific revision

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

Update autoscaling options for a specific revision

vessl service scale [OPTIONS]
OptionDescription
--serviceName of service.
-n, --numberNumber of revision.
--minMinimum number of replicas.
--maxMaximum number of replicas.
--targetTarget resource utilization.
--metricMetric for autoscaling: ‘cpu’, ‘nvidia.com/gpu’, ‘memory’.

Update traffic split for a service

vessl service split-traffic [OPTIONS]
OptionDescription
--serviceName of service.
-n, --numberNumber of revision. You can pass multiple.
-w, --weightPercentage of traffic that should be directed to this revision. The sum of traffics should be exactly 100.

Create a YAML file

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

Deprecated

(Deprecated) Update traffic split for a service

vessl serve update [OPTIONS]
OptionDescription
--serviceName of service.
-n, --numberNumber of revision. You can pass multiple.
-w, --weightPercentage of traffic that should be directed to this revision. The sum of traffics should be exactly 100.

(Deprecated) List all revisions

vessl serve revision list [OPTIONS]
OptionDescription
--serviceName of service.

(Deprecated) Show current status and information about a revision

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

(Deprecated) Terminate a specific revision

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

(Deprecated) Show current status of the gateway of service

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