diff --git a/README.md b/README.md index 3001190..d35c897 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,22 @@ [![License](https://img.shields.io/github/license/SaladTechnologies/virtual-kubelet-saladcloud)](./LICENSE) [![CI Workflow](https://github.com/SaladTechnologies/virtual-kubelet-saladcloud/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/SaladTechnologies/virtual-kubelet-saladcloud/actions/workflows/ci.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/SaladTechnologies/virtual-kubelet-saladcloud)](https://goreportcard.com/report/github.com/SaladTechnologies/virtual-kubelet-saladcloud) +
+ SaladCloud Virtual Kubelet Provider +
+ Salad's Virtual Kubelet (VK) provider for SaladCloud enables running Kubernetes (K8s) pods as container group deployments. +## How it Works + +The SaladCloud Virtual Kubelet Provider creates a _virtual node_ in your K8s cluster. + +
+ architecture diagram of the SaladCloud Virtual Kubelet Provider +
+ +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. + ## Development Follow the steps below to get started with local development. diff --git a/images/saladcloud-virtual-kubelet-architecture.png b/images/saladcloud-virtual-kubelet-architecture.png new file mode 100644 index 0000000..fe299ba Binary files /dev/null and b/images/saladcloud-virtual-kubelet-architecture.png differ diff --git a/images/saladcloud-virtual-kubelet-banner.png b/images/saladcloud-virtual-kubelet-banner.png new file mode 100644 index 0000000..59674c7 Binary files /dev/null and b/images/saladcloud-virtual-kubelet-banner.png differ