Merge pull request #66 from pascalinthecloud/65-add-terraform-output-of-schematic_id

feat: add output for Talos image schematic ID

Author: pascalinthecloud

README.md

@@ -4,6 +4,19 @@ A Terraform module for provisioning a Kubernetes cluster on Proxmox using Talos
 
 Feel free to contact me, open an issue, or contribute to the project. Your feedback and contributions are always welcome! 🤓
 
+## Geting kubeconfig & talosconfig
+```bash
+terraform output --raw kubeconfig > cluster.kubeconfig
+terraform output --raw talosconfig > cluster.talosconfig
+```
+
+## Upgrading Talos cluster
+First we need get the schematic id from the outputs and use that for upgrading the cluster in order to keep the extensions. 
+```bash
+talosctl upgrade --image factory.talos.dev/installer/<SCHEMATIC_ID>:v1.9.3 --preserve
+```
+The preserve option is only needed when wanting to keep files/directories on Talos nodes (for example when using Longhorn/Rook...)
+
 ## Example
 
 ```hcl
@@ -136,6 +149,7 @@ module "k8s_cluster_override" {
 |------|-------------|
 | <a name="output_kubeconfig"></a> [kubeconfig](#output\_kubeconfig) | Kubernetes kubeconfig for the cluster |
 | <a name="output_talos_cluster_health"></a> [talos\_cluster\_health](#output\_talos\_cluster\_health) | Health status of the Talos cluster, can be used for other ressources to depend on |
+| <a name="output_talos_image_schematic_id"></a> [talos\_image\_schematic\_id](#output\_talos\_image\_schematic\_id) | ID of the Talos image schematic |
 | <a name="output_talosconfig"></a> [talosconfig](#output\_talosconfig) | Talos configuration file for the cluster |
 
 ## Repo Activity

examples/main.description

@@ -1,4 +1,17 @@
 # terraform-proxmox-talos-cluster
 A Terraform module for provisioning a Kubernetes cluster on Proxmox using Talos Linux. This module automates node creation, Talos configuration, and Proxmox integration, offering a secure, lightweight, and efficient environment for homelabs or production use. It simplifies the Kubernetes setup and management process.
 
-Feel free to contact me, open an issue, or contribute to the project. Your feedback and contributions are always welcome! 🤓
+Feel free to contact me, open an issue, or contribute to the project. Your feedback and contributions are always welcome! 🤓
+
+## Geting kubeconfig & talosconfig
+```bash
+terraform output --raw kubeconfig > cluster.kubeconfig
+terraform output --raw talosconfig > cluster.talosconfig
+```
+
+## Upgrading Talos cluster
+First we need get the schematic id from the outputs and use that for upgrading the cluster in order to keep the extensions. 
+```bash
+talosctl upgrade --image factory.talos.dev/installer/<SCHEMATIC_ID>:v1.9.3 --preserve
+```
+The preserve option is only needed when wanting to keep files/directories on Talos nodes (for example when using Longhorn/Rook...)

outputs.tf

@@ -20,3 +20,8 @@ output "talos_cluster_health" {
   description = "Health status of the Talos cluster, can be used for other ressources to depend on"
   value       = data.talos_cluster_health.this
 }
+
+output "talos_image_schematic_id" {
+  description = "ID of the Talos image schematic"
+  value       = talos_image_factory_schematic.this.id
+}