[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
  • Service Revision
  • Actions on the Revision List
  1. USER GUIDE
  2. Serve
  3. Serve Web Workflow

Service Revisions

PreviousService LogsNextService Rollouts

Last updated 1 year ago

Service Revision

In VESSL, a Revision holds important information about how an inference server works. It's like a recipe that includes details about the model used, the resources it needs, how it can automatically adjust itself, and where it's accessible. Since models can change over time, VESSL encourages to manage revisions make it easy to manage different setups and go back to older ones if needed.

To start a new Revision, go to the list of Revisions and click on "New revision."

When you click "New revision," you'll see a page where you can set up the new Revision. This is where you tell VESSL which model to use, how much power it needs, whether it should grow or shrink automatically, and how people will connect to it.

Here, you add some notes about what this Revision is for:

  • Metadata: Metadata of the revision.

    • Message: Write a short message explaining what this Revision is meant for.

  • Deployment Spec: Resource requirements and configuration for the Revision.

    • Resource: CPU, RAM, and GPU resources to allocate to the Revision.

    • Docker Image: The Docker Image to use for the Revision.

    • Start Command: The command to run inside the container. This is like running a command in the terminal on your computer.

    • Environment Variables: Environment variables to inject into the container.

    • Port: The port to expose from the container. For example, if you're using a BentoML model server, you'll want to expose port 3000 and use the HTTP protocol to access the service endpoint.

  • Advanced Options: Additional configuration for the Revision.

    • Autoscaling: Automatically scale the Revision up or down based on demand.

      • Min: The minimum number of replicas to keep running.

      • Max: The maximum number of replicas to scale out.

      • Target metric: The metric to use for scaling up or down.

        • CPU: The CPU usage of the Revision.

        • Memory: The memory usage of the Revision.

        • GPU: The GPU usage of the Revision.

    • Launch this revision immediately: Start the Revision as soon as it's created.

Actions on the Revision List

Once you create a Revision, you can see basic information about the Revision in the list of revisions and quickly perform actions needed for service operation.

Actions on the Revision list are as follows:

  • Start: Deploy the Revision to the cluster immediately according to the current settings.

  • Stop: Immediately stop the Revision that is deployed and running.

  • Scale: Adjust the number of replicas of the deployed and running Revision.

  • Reproduce: Create a new Revision with the same settings as the selected Revision.

  • Delete: Delete the selected Revision.

Volume Mount: You can mount datasets, model files, code, and more as folders for use in Revision. For more information, please see

Service Account Name: The Kubernetes service account to connect to the container. This is commonly used with , , to control what cloud resources the container can access.

the documentation
AWS IRSA
GKE Workload Identity
New Revision
Revision Metadata
Revision Deployment Spec
Revision Advanced Options
Revision Actions