easylinux/proxmox-tofu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #14 from max-pfeiffer/improvement/docs

Browse Source 
Made docs better understandable, hopefully
This commit is contained in:
Max Pfeiffer
2026-01-16 07:48:24 +01:00
committed by GitHub
parent 080795be8e f209cda1ea
commit de5767c78c
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -23,10 +23,10 @@ You need to have installed on your local machine:
* [kubectl](https://kubernetes.io/docs/reference/kubectl/) (for testing and cluster interaction) * [kubectl](https://kubernetes.io/docs/reference/kubectl/) (for testing and cluster interaction)
## Provisioning ## Provisioning
The project is grouped in three sections: The project is grouped into three sections:
* proxmox: provisioning of virtual machines, operating systems and Kubernetes cluster * proxmox: provisioning of virtual machines, operating system and Kubernetes cluster
* kubernetes: provisioning of Kubernetes cluster resources * kubernetes: provisioning of Kubernetes resources in the running Kubernetes cluster
* argocd: provisioning of Kubernetes resources using GitOps, can be installed with `install_argocd_app_of_apps` flag * argocd: provisioning of Kubernetes resources using GitOps approach, can be configured with `install_argocd_app_of_apps` flag
This way you can choose to only provision the cluster itself or/and provision Kubernetes resources and bootstrap This way you can choose to only provision the cluster itself or/and provision Kubernetes resources and bootstrap
also [ArgoCD](https://argoproj.github.io/cd/). also [ArgoCD](https://argoproj.github.io/cd/).
@@ -35,13 +35,13 @@ You will have an [ArgoCD](https://argoproj.github.io/cd/) instance running in th
install your applications using the GitOps approach. Have a look at `install_argocd_app_of_apps` and the related install your applications using the GitOps approach. Have a look at `install_argocd_app_of_apps` and the related
configuration variables for further options. configuration variables for further options.
The main idea is to configure the Kubernetes cluster and also the [ArgoCD](https://argoproj.github.io/cd/) bootstrap with infrastructure as code The main idea is to provision the Kubernetes cluster and bootstrap [ArgoCD](https://argoproj.github.io/cd/) with infrastructure as code
using [OpenTofu](https://opentofu.org/). So it can be rolled out very quickly and consistently. All other Kubernetes resources are then using [OpenTofu](https://opentofu.org/). So it can be rolled out very quickly and consistently. All other Kubernetes resources are then
provisioned using a git repository via the GitOps approach. installed with [ArgoCD](https://argoproj.github.io/cd/) using a git repository.
Usually you want to keep your cluster infrastructure and [ArgoCD](https://argoproj.github.io/cd/) bootstrap separate from your Kubernetes resources. Usually you want to keep your Kubernetes cluster infrastructure and the Kubernetes resources in a separate repositories.
That way you have everything decoupled and migrate to a new cluster infrastructure more easily. I added the `argocd` That way you have everything decoupled, and you can migrate your applications to a new cluster infrastructure more easily.
directory mainly for demonstration purposes. I added the Kubernetes resources in the `argocd` directory mainly for demonstration purposes.
### Proxmox VE ### Proxmox VE
First step is to provision the Proxmox part: create a `configuration.auto.tfvars` file based on the example and First step is to provision the Proxmox part: create a `configuration.auto.tfvars` file based on the example and
@@ -119,6 +119,8 @@ You can grab the [ArgoCD](https://argoproj.github.io/cd/) initial admin password
```shell ```shell
$ kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath='{.data.password}' | base64 -d $ kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath='{.data.password}' | base64 -d
``` ```
ArgoCD web user interface should be up and running by now. You can access it in your web browser on
http://argocd.local if you didn't change the defaults or under the domain you configured with `argocd_domain`.
## Roadmap ## Roadmap
Proxmox part: Proxmox part: