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:
| Cluster API v1beta1 (v1.4) | Cluster API v1beta1 (v1.5) | Cluster API v1beta1 (v1.6) | |
|---|---|---|---|
| CAPMOX v1alpha1 (v0.1) | ✓ | ✓ | ☓ |
| CAPMOX v1alpha1 (v0.2) | ☓ | ✓ | ✓ |
| CAPMOX v1alpha1 (v0.3) | ☓ | ✓ | ✓ |
| CAPMOX v1alpha1 (v0.4) | ☓ | ✓ | ✓ |
(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:
Security
We take security seriously. Please read our security policy for information on how to report security issues.
Directories
¶
| 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
|
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
main is the main package for the Cluster API Proxmox Provider.
|
main is the main package for the Cluster API Proxmox Provider. |
|
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. |
|
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. |
|
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. |
|
scope
Package scope defines the capmox scopes used for reconciliation.
|
Package scope defines the capmox scopes used for reconciliation. |
|
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 |
Click to show internal directories.
Click to hide internal directories.