Skip to content

kodal/cluster-api-provider-vmwaredesktop

Repository files navigation

Cluster API Provider Vmware Desktop (Workstation, Fusion)

Description

The Cluster API Provider Vmware Desktop (CAVD) provides a way to declaratively create and manage cluster on Vmware Desktop with vmrest, in a Kubernetes-native way. It extends the Kubernetes API with Custom Resource Definitions (CRDs) allowing you to interact with clusters in the same fashion you interact with workload.

Getting Started

Prerequisites

  • Understanding Cluster API Quick Start
  • Vmware Desktop Hypervisor (Workstation or Fusion, tested only with Fusion)
  • Prepared Virtual Machine by image-builder with build-node-ova-local- or factory-talos Cloud/Vmware (only amd64 supports by Talos)
  • Running vmrest Doc

Required env variables

# Example
VMREST_URL="http://host.docker.internal:8697/api" # http://localhost:8697/api vmrest url
VMREST_USERNAME="user"
VMREST_PASSWORD="password"
TEMPLATE_VM_ID="LIVK1CGKIC5J71SNTC711F7O9TR3BDDQ" # VM ID from vmrest/api/vms prepared with defined kubernetes version

Available template flavors --flavor

  • flannel
  • talos

License

Copyright 2025.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Cluster API Infrastructure Provider for VMWare Desktop (VMWare Fusion, VMWare Workstation)

Topics

Resources

License

Stars

Watchers

Forks

Packages