mirror of
https://github.com/optim-enterprises-bv/turnk8s.git
synced 2025-10-30 01:43:04 +00:00
8ecd7d3867
Separated workflow for main and other branches 1. From now on, the workflow defined in "pr_cluster_workflow.yaml" will be triggered on config.yaml changes. This can be used for PR testing. 2. Draft PRs are created when the source branch has logical modifications. Normal PRs are used for cluster management. 3.In the case of Draft PRs, which are for logical modifications, if a cluster is required, then the name of the cluster should adhere to the following convention "turnk8s-<PR_NUMBER>". 4. In the case of normal PRs, which are for cluster management, no cluster should be present in the config.yaml file matching the following cluster name regex turnk8s-.*
72 lines
3.5 KiB
Markdown
72 lines
3.5 KiB
Markdown
## Introduction
|
|
|
|
**turnk8s** is a toolset for On-Prem, turnkey Kubernetes deployments based on [Talos Linux](https://www.talos.dev) and [Proxmox](https://www.proxmox.com).
|
|
|
|
|
|
## Before using turnk8s
|
|
|
|
You must fork turnk8s, set up a self-hosted GitHub runner inside your infrastructure, and create infrastructure-specific environmental variables. See the list of the repository's environmental variables.
|
|
- ARGOCD_ADMIN_PASSWORD - Used as ArgoCD web interface password.
|
|
- NETRIS_CONTROLLER_LOGIN - [Your Netris controller login](https://www.netris.io/docs/en/latest/tutorials/installing-netris-controller.html)
|
|
- NETRIS_CONTROLLER_PASSWORD - [Your Netris controller password](https://www.netris.io/docs/en/latest/tutorials/installing-netris-controller.html)
|
|
- PROXMOX_IP - Proxmox host IP address
|
|
- PROXMOX_TOKEN_ID - [Proxmox api token id](https://www.netris.io/docs/en/latest/tutorials/installing-netris-controller.html)
|
|
- PROXMOX_TOKEN_SECRET - [Proxmox api token secret](https://www.netris.io/docs/en/latest/tutorials/installing-netris-controller.html)
|
|
- TF_API_TOKEN - [Terraform cloud API token](https://developer.hashicorp.com/terraform/tutorials/automation/github-actions)
|
|
- TOKEN_GITHUB - GitHub token
|
|
|
|
Please note that the GitHub token should have repository creation privileges.
|
|
|
|
## Using turnk8s
|
|
|
|
Adhering to GitOps, you can manage all the clusters with the `config.yaml` configuration file. turnk8s ensures that the `config.yaml` represents the state of your running clusters.
|
|
<details>
|
|
<summary>Click here to see the structure of config.yaml file:</summary>
|
|
|
|
```yaml
|
|
turnk8s-cluster:
|
|
versions:
|
|
talos: v1.7.1
|
|
k8s: v1.30.0
|
|
controlplane:
|
|
cpu_cores: 2
|
|
memory: 4096
|
|
disk_size: 20
|
|
worker_nodes:
|
|
cpu_cores: 2
|
|
memory: 4096
|
|
disk_size: 20
|
|
```
|
|
</details>
|
|
|
|
|
|
### Creating a Cluster
|
|
You can create one or many clusters at once. All you need to do is add the turnk8s cluster configurations to the config.yaml file and push it to your turnk8s.
|
|
Please note that you need Proxmox hosts deployed and available for your GitHub runner and Netris controller and softgate nodes available for your Kubernetes cluster pods.
|
|
|
|
Configuration parameters:
|
|
* **the main key is the cluster name:(Required)** - A unique cluster name
|
|
* **versions.talos:(Required)** - Talos Linux version: Supported versions are v1.7.1, v1.7.0, v1.6.7
|
|
* **versions.k8s:(Required)** - Kubernetes version: Supported versions are v1.30.0, v1.29.3
|
|
* **controlplane.cpu_cores:(Required)** - controlplane node cores :(min 2)
|
|
* **controlplane.memory:(Required)** - controlpalne node RAM (min 2048)
|
|
* **controlplane.disk_size:(Required)** - controlplane node disk size:(min 10)
|
|
* **worker_nodes.cpu_cores:(Required)** - worker node cores:(min 1)
|
|
* **worker_nodes.memory:(Required)** - worker node RAM:(min 2048)
|
|
* **worker_nodes.disk_size:(Required)** - worker node disk size:(min 10)
|
|
|
|
Pushing config.yaml triggers a GitHub actions workflow. The Kubernetes configuration files and the Kubernetes services repo URL are shown on the summary page when the workflow is complete.
|
|
|
|
<img width="1883" alt="Screenshot 2024-05-24 at 17 11 48" src="https://github.com/infraheads/turnk8s/assets/10867292/38771d9f-c3bc-4427-b6e4-5b747f06dab1">
|
|
|
|
|
|
|
|
### Destroying a Cluster
|
|
To destroy a cluster, you must remove the cluster configuration from the `config.yaml` file and push it to your turnk8s repository.
|
|
|
|
## Kubectl
|
|
|
|
Download the kubeconfig file from the summary page, unzip it, and export its path to the `KUBECONFIG` variable.
|
|
<br>
|
|
Try `kubectl get nodes` to check if Kubernetes is running.
|