Skip to content

joevizcara/terraform-proxmox

Repository files navigation

Managing Proxmox VE via Terraform and GitOps

This program enables a declarative, IaC method of provisioning multiple resources in a Proxmox Virtual Environment.

Deployment

  1. Clone this GitLab/Hub repository.

  2. Go to the GitLab Project/Repository > Settings > CI/CD > Runner > Create project runner, mark Run untagged jobs and click Create runner.

  3. On Step 1, copy the runner authentication token, store it somewhere and click View runners.

  4. On the PVE Web UI, right-click on the target Proxmox node and click Shell.

  5. Execute this command in the PVE shell.

bash <(curl -s https://gitlab.com/joevizcara/terraform-proxmox/-/raw/master/prep.sh)

Caution

The content of this shell script can be examined before executing it. It can be executed on a virtualized Proxmox VE to observe what it does. It will create a privileged PAM user to authenticate via an API token. It creates a small LXC environment for GitLab Runner to manage the Proxmox resources. Because of the API limitations between the Terraform provider and PVE, it will necessitate to add the SSH public key from the LXC to the authorized keys of the PVE node to write the cloud-init configuration YAML files to the local Snippets datastore. It will also add a few more data types that can be accepeted in the local datastore (e.g. Snippets, Import). Consider enabling two-factor authentication on GitLab if this is to be applied on a real environment.

  1. Go to GitLab Project/Repository > Settings > CI/CD > Variables > Add variable:

Key: PM_API_TOKEN_SECRET
Value: the token secret value from credentials.txt

  1. If this repository is cloned locally, adjust the values of the .tf files to conform with the PVE onto which this will be deployed.

Note

The Terraform provider resgistry is bpg/proxmox for reference. git push signals will trigger the GitLab Runner and will apply the infrastructure changes.

  1. If the first job stage succeeded, go to GitLab Project/Repository > Build > Jobs and click Run ▶️ button of the apply infra job.

  2. If the second job stage succeeded, go to the PVE WUI to start the new VMs to test or configure.

Note

To configure the VMs, go to PVE WUI and right-click the gitlab-runner LXC and click Console. The GitLab Runner LXC credentials are in the credentials.txt. Inside the console, do ssh k3s@<ip-address-of-the-VM>. They can be converted into Templates, converted into an HA cluster, etc. The IP addresses are declared in variables.tf.

Diagramme

diagramme

About

Creating and Managing Proxmox Virtual Environment using IaC and GitOps (Terraform and GitLab Runner)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published