cluster-api-provider-proxmox

module

v0.8.1 Latest Latest Go to latest Published: Apr 16, 2026 License: Apache-2.0

README ¶

Kubernetes Cluster API Provider for Proxmox Virtual Environment - CAPMOX

Overview

The Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management. Cluster API Provider for Proxmox VE is a concrete implementation of Cluster API for Proxmox VE.

Launching a Kubernetes cluster on Proxmox VE

Check out the quickstart guide for launching a cluster on Proxmox VE.

Compatibility with Cluster API and Kubernetes Versions

This provider's versions are compatible with the following versions of Cluster API:

CAPMOX v1alpha2 (current)

Cluster API v1beta2

	CAPI v1.11
CAPMOX v0.8	✓

CAPMOX v1alpha1 (obsolete)

Cluster API v1beta1

	CAPI v1.4	CAPI v1.5	CAPI v1.6	CAPI v1.7	CAPI v1.8	CAPI v1.9	CAPI v1.10
CAPMOX v0.1	✓	✓	☓	☓	☓	☓	☓
CAPMOX v0.2	☓	✓	✓	☓	☓	☓	☓
CAPMOX v0.3	☓	✓	✓	✓	☓	☓	☓
CAPMOX v0.4	☓	✓	✓	✓	☓	☓	☓
CAPMOX v0.5	☓	☓	✓	✓	☓	☓	☓
CAPMOX v0.6	☓	☓	☓	✓	✓	☓	☓
CAPMOX v0.7	☓	☓	☓	☓	✓	✓	✓

(See Kubernetes support matrix of Cluster API versions).

Documentation

Further documentation is available in the /docs directory.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Slack channel

Security

We take security seriously. Please read our security policy for information on how to report security issues.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api
v1alpha1 Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io +k8s:conversion-gen=github.com/ionos-cloud/cluster-api-provider-proxmox/api/v1alpha2	Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io +k8s:conversion-gen=github.com/ionos-cloud/cluster-api-provider-proxmox/api/v1alpha2
v1alpha2 Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io	Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
cmd main is the main package for the Cluster API Proxmox Provider.	main is the main package for the Cluster API Proxmox Provider.
convert command Package main implements the convert CLI tool.	Package main implements the convert CLI tool.
internal
controller Package controller implements controller types.	Package controller implements controller types.
inject Package inject implements cloud-init ISO inject logic.	Package inject implements cloud-init ISO inject logic.
service/scheduler Package scheduler implements scheduling algorithms for Proxmox VMs.	Package scheduler implements scheduling algorithms for Proxmox VMs.
service/taskservice Package taskservice implement logic related to Proxmox Task.	Package taskservice implement logic related to Proxmox Task.
service/vmservice Package vmservice implement Proxmox vm logic.	Package vmservice implement Proxmox vm logic.
tlshelper Package tlshelper wraps loading and modifying the root-CA store for use in tls.Config	Package tlshelper wraps loading and modifying the root-CA store for use in tls.Config
webhook Package webhook contains webhooks for the custom resources.	Package webhook contains webhooks for the custom resources.
pkg
cloudinit Package cloudinit implements kubeadm cloudinit functionality.	Package cloudinit implements kubeadm cloudinit functionality.
consts Package consts contains global consts.	Package consts contains global consts.
convert Package convert provides YAML conversion for CAPMOX v1alpha1→v1alpha2 and CAPI v1beta1→v1beta2 resources.	Package convert provides YAML conversion for CAPMOX v1alpha1→v1alpha2 and CAPI v1beta1→v1beta2 resources.
errors Package capmoxerrors defines error types and constants for the Proxmox provider.	Package capmoxerrors defines error types and constants for the Proxmox provider.
ignition Package ignition implements an enricher for Ignition configs.	Package ignition implements an enricher for Ignition configs.
kubernetes/ipam Package ipam contains helper functions to create, update and delete ipam related resources in a Kubernetes cluster	Package ipam contains helper functions to create, update and delete ipam related resources in a Kubernetes cluster
proxmox Package proxmox defines Proxmox Client interface.	Package proxmox defines Proxmox Client interface.
proxmox/goproxmox Package goproxmox implements a client for Proxmox resource lifecycle management.	Package goproxmox implements a client for Proxmox resource lifecycle management.
proxmox/proxmoxtest
scope Package scope defines the capmox scopes used for reconciliation.	Package scope defines the capmox scopes used for reconciliation.
types Package types provides common types used in cloudinit & ignition.	Package types provides common types used in cloudinit & ignition.
test
helpers Package helpers provides helper functions to run integration tests by pre-populating the required settings for envtest and loading required crds from different modules	Package helpers provides helper functions to run integration tests by pre-populating the required settings for envtest and loading required crds from different modules