README.md

SaladCloud Virtual Kubelet Provider

Salad's Virtual Kubelet (VK) provider for SaladCloud enables running Kubernetes (K8s) pods as SaladCloud Container Group deployments. This prototype is currently in development, and not production ready yet. If you are interested, please reach out to us to discuss your specific needs.

How it Works

The SaladCloud Virtual Kubelet Provider creates a virtual node in your K8s cluster.

To the K8s API, it looks like a real node. However, when you schedule a pod on the virtual node, a container group deployment is created using the SaladCloud API instead of running the pod on a node in the K8s cluster. The container group deployment runs the pod on a remote, GPU-enabled node on the SaladCloud network.

Demo

This was used in a presentation at KubeCon2023, the script and pod spec file for the QR code workload are in the demo directory.

Development

Follow the steps below to get started with local development.

Prerequisites

• Git
• Go
• Docker Desktop with a local Kubernetes cluster

Getting Started

1. Clone the repository.

   git clone https://github.com/SaladTechnologies/virtual-kubelet-saladcloud.git

2. Restore the dependencies.

   go mod download
   go mod verify

3. Build the project.

   make build

4. Run the project in foreground.

   ./bin/virtual-kubelet --sce-api-key {apiKey} --sce-project-name {projectName} --sce-organization-name {organizationName}

or

4. Run the project in K8s via Helm.

helm install \
   --create-namespace \
   --namespace saladcloud \
   --set salad.apiKey=${apiKey} \
   --set salad.organizationName=${organizationName} \
   --set salad.projectName=${projectName} \
   --set provider.image.tag=${imageTag} \
   saladcloud-node \
   ./charts/virtual-kubelet