From 41b4c6897cd61f8f7bbfc26d130150f135e1fefd Mon Sep 17 00:00:00 2001
From: clyhtsuriva <aimeric@adjutor.xyz>
Date: Sat, 8 Feb 2025 20:20:02 +0100
Subject: opentofu: add types and descriptions to modules' variables

---
 opentofu/modules/ansible_provisioner/main.tf      | 12 -----------
 opentofu/modules/ansible_provisioner/variables.tf | 26 +++++++++++++++++++++++
 2 files changed, 26 insertions(+), 12 deletions(-)
 create mode 100644 opentofu/modules/ansible_provisioner/variables.tf

(limited to 'opentofu/modules/ansible_provisioner')

diff --git a/opentofu/modules/ansible_provisioner/main.tf b/opentofu/modules/ansible_provisioner/main.tf
index cac666d..0de288e 100644
--- a/opentofu/modules/ansible_provisioner/main.tf
+++ b/opentofu/modules/ansible_provisioner/main.tf
@@ -1,15 +1,3 @@
-variable "vm_ip" {
-  default = null
-}
-
-variable "inventory_file_path" {
-  default = null
-}
-
-variable "vm_username" {}
-variable "ssh_private_key_path" {}
-variable "ansible_playbook_path" {}
-
 resource "null_resource" "ansible_provisioner" {
   triggers = {
     ip_or_inventory = coalesce(var.vm_ip, var.inventory_file_path)  # Choose based on what is provided
diff --git a/opentofu/modules/ansible_provisioner/variables.tf b/opentofu/modules/ansible_provisioner/variables.tf
new file mode 100644
index 0000000..0d15d01
--- /dev/null
+++ b/opentofu/modules/ansible_provisioner/variables.tf
@@ -0,0 +1,26 @@
+variable "vm_ip" {
+  type        = string
+  default     = null
+  description = "The IP address of the VM to provision. Either this or `inventory_file_path` must be provided."
+}
+
+variable "inventory_file_path" {
+  type        = string
+  default     = null
+  description = "The path to the Ansible inventory file. Either this or `vm_ip` must be provided."
+}
+
+variable "vm_username" {
+  type        = string
+  description = "The username to use for SSH access to the VM."
+}
+
+variable "ssh_private_key_path" {
+  type        = string
+  description = "The path to the private SSH key for accessing the VM."
+}
+
+variable "ansible_playbook_path" {
+  type        = string
+  description = "The path to the Ansible playbook to execute."
+}
-- 
cgit v1.2.3