[DEV] VESSL Docs
  • Welcome to VESSL Docs!
  • GETTING STARTED
    • Overview
    • Quickstart
    • End-to-end Guides
      • CLI-driven Workflow
      • SDK-driven Workflow
  • USER GUIDE
    • Organization
      • Creating an Organization
      • Organization Settings
        • Add Members
        • Set Notifications
        • Configure Clusters
        • Add Integrations
        • Billing Information
    • Project
      • Creating a Project
      • Project Overview
      • Project Repository & Project Dataset
    • Clusters
      • Cluster Integrations
        • Fully Managed Cloud
        • Personal Laptops
        • On-premise Clusters
        • Private Cloud (AWS)
      • Cluster Monitoring
      • Cluster Administration
        • Resource Specs
        • Access Control
        • Quotas and Limits
        • Remove Cluster
    • Dataset
      • Adding New Datasets
      • Managing Datasets
      • Tips & Limitations
    • Experiment
      • Creating an Experiment
      • Managing Experiments
      • Experiment Results
      • Distributed Experiments
      • Local Experiments
    • Model Registry
      • Creating a Model
      • Managing Models
    • Sweep
      • Creating a Sweep
      • Sweep Results
    • Workspace
      • Creating a Workspace
      • Exploring Workspaces
      • SSH Connection
      • Downloading / Attaching Datasets
      • Running a Server Application
      • Tips & Limitations
      • Building Custom Images
    • Serve
      • Quickstart
      • Serve Web Workflow
        • Monitoring Dashboard
        • Service Logs
        • Service Revisions
        • Service Rollouts
      • Serve YAML Workflow
        • YAML Schema Reference
    • Commons
      • Running Spot Instances
      • Volume Mount
  • API REFERENCE
    • What is the VESSL CLI/SDK?
    • CLI
      • Getting Started
      • vessl run
      • vessl cluster
      • vessl dataset
      • vessl experiment
      • vessl image
      • vessl model
      • vessl organization
      • vessl project
      • vessl serve
      • vessl ssh-key
      • vessl sweep
      • vessl volume
      • vessl workspace
    • Python SDK
      • Integrations
        • Keras
        • TensorBoard
      • Utilities API
        • configure
        • vessl.init
        • vessl.log
          • vessl.Image
          • vessl.Audio
        • vessl.hp.update
        • vessl.progress
        • vessl.upload
        • vessl.finish
      • Dataset API
      • Experiment API
      • Cluster API
      • Image API
      • Model API
        • Model Serving API
      • Organization API
      • Project API
      • Serving API
      • SSH Key API
      • Sweep API
      • Volume API
      • Workspace API
    • Rate Limits
  • TROUBLESHOOTING
    • GitHub Issues
    • VESSL Flare
Powered by GitBook
On this page
  • Overview
  • List all servings
  • Create a revision
  • List all revisions
  • Show current status and information about a revision
  • Update auto scaler config for a specific revision
  • Terminate a specific revision
  • Show current status of the gateway of serving
  • Update gateway
  1. API REFERENCE
  2. CLI

vessl serve

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.

Previousvessl projectNextvessl ssh-key

Last updated 1 year ago