โ€‹
Overview

Integrating your Mac or Linux machine to VESSL allows you to use your personal machines as a Kubernetes-backed single-node cluster and optimize your laptop for ML.

  • Launch training jobs in seconds on VESSLโ€™s easy-to-use web interface or CLI, without writing YAML or scrappy scripts.
  • Build a baseline model on your laptop and transition seamlessly to VESSL Cloud to scale your model.
  • Keep track of your hardware and runtime environments together with vessl.log.

VESSL Clustersโ€™ single-line CLI command automatically checks, installs, and configures all dependencies such as Kubernetes, and connects your laptop to VESSL.

โ€‹
Step-by-step Guide

There is an ongoing ๐Ÿ”— issue related to Kubernetes hostname containing capital letters. Please make sure your machineโ€™s hostname is in lowercase.

โ€‹
1. Prerequisites

You should first have Docker, Helm, and VESSL SDK installed on your machine.

โ€‹
Install Docker and Helm

Install Docker and Helm. If you are on Mac and have Homebrew installed, the easiest way is to brew install. Check out the ๐Ÿ”— Docker and ๐Ÿ”— Helm installation guides for more details.

brew install docker

brew install helm

You should have Docker running in the background with your account logged in while using your laptop with VESSL Clusters.

โ€‹
Set up the VESSL environment

Set up a VESSL environment on your laptop and grant access. Refer to our docs on VESSL Client for more detailed setup guides.

pip install vessl

vessl configure

โ€‹
2. VESSL integration

The following single-line command connects your Mac.

vessl cluster create --name '[CLUSTER_NAME_HERE]' --mode single

The most common flags used with vessl cluster create commands are as follows. Check out our docs on VESSL CLI for additional flags.

  • --name โ€” Define your cluster name
  • --mode single โ€” Specifies that are installing a single-node cluster.
  • --help โ€” See additional command options.

The command will automatically check dependencies and ask you to install Kubernetes. This process will take a few minutes. Proceed by entering y.

If you have Kubernetes installed on your machine, the command will then ask you to install VESSL agent on the Kubernetes cluster. Enter y and proceed.

By this point, you have successfully completed the integration.

โ€‹
3. Confirm integration

Confirm your integration using the list command which returns all the clusters available in your Organization.

vessl cluster list

Finally, try running a training job on your laptop. Your first run may take a few minutes to get the Docker images installed on your device.

Windows support for single-node cluster integration is currently in beta. Cluster usage and status monitoring may be limited for Windows machines.

Creating a Run with YAMLAWS