Skip to content

Getting Started

Tip

This guide assumes you have a Proxmox VE cluster up and running. If you don't have one, you can follow the official guide to install Proxmox VE.

Requirements

  • Kubernetes cluster with version 1.16+
  • Helm 3+
  • Proxmox VE with version 6.3+

Installation

Install Kubemox with Helm

helm repo add kubemox https://alperencelik.github.io/helm-charts/

helm install kubemox alperencelik/kubemox --set \
    proxmox.endpoint="https://<PROXMOX_HOSTNAME" \
    proxmox.insecureSkipTLSVerify=false \
    proxmox.username="<PROXMOX_USERNAME>" \
    proxmox.password="<PROXMOX_PASSWORD>"

Tip

You can use also tokenID and secret instead of username and password. proxmox.tokenID="" \ proxmox.secret=""

Warning

If you are using self-signed certificates, you should set proxmox.insecureSkipTLSVerify to true.

Warning

Make sure that the user you specified has the necessary permissions to create Proxmox VE resources.

Clone from the source

  • You can also clone the repository and run the operator locally with Make.
git clone https://github.com/alperencelik/kubemox.git
make install ## Install CRDs
export PROXMOX_ENDPOINT="https://<PROXMOX_HOSTNAME>"
export PROXMOX_USERNAME="<PROXMOX_USERNAME>"
export PROXMOX_PASSWORD="<PROXMOX_PASSWORD>"
export PROXMOX_INSECURE_SKIP_TLS_VERIFY=false
make run ## Run the operator locally with the current kubeconfig
  • You can download the Tilt binary from here. Update the Tiltfile with your Proxmox VE credentials.
tilt up

Creating your first Proxmox resource

You can create different Proxmox resources using the Kubemox CRDs. For more information, you can check the Custom Resources. Example resource manifests can be found in the examples directory.