From 0f4c16f8113b748b9a5c233db3856d887524bf58 Mon Sep 17 00:00:00 2001
From: pierre <pierre@geeraert.eu>
Date: Wed, 11 Dec 2024 22:43:00 +0000
Subject: [PATCH] documentation in progress

---
 README.md | 83 ++++++++++++++++++++++++-------------------------------
 1 file changed, 36 insertions(+), 47 deletions(-)

diff --git a/README.md b/README.md
index f27dfc5..52868e8 100644
--- a/README.md
+++ b/README.md
@@ -2,55 +2,44 @@
 
 ## Variable
 
-```
-variable "kubernetes" {
-  type = map(object({
-    name  = optional(string)
-    image = string
-    pvc = optional(map(object({
-      name       = string
-      pvc        = optional(bool, false)
-      config_map = optional(bool, false)
-      host_path  = optional(string)
-      pvc_size   = optional(string)
-      mount_path = string
-    })))
-    #secret = optional(map(string))
-    environment = optional(map(object({
-      name  = optional(string)
-      value = optional(string)
-      value_from = optional(object({
-        secret_key_ref = object({
-          name = string
-          key  = optional(string, null)
-        })
-      }))
-      #      secret_name = optional(string)
-    })))
-    replicas               = optional(number, 1)
-    namespace              = optional(string)
-    service_port           = optional(number)
-    service_name           = optional(string)
-    liveness_tcp_socket    = optional(number)
-    liveness_http_get      = optional(string)
-    liveness_http_get_path = optional(string)
-    database               = optional(map(string))
-    redis                  = optional(map(string))
-    enabled                = optional(bool, true)
-    secret_ref             = optional(list(string))
-    config_map_ref          = optional(list(string))
-    requirements = optional(map(string), {
-      limits-cpu      = "800m"
-      limits-memory   = "500Mi"
-      requests-cpu    = "200m"
-      requests-memory = "200Mi"
-    })
-    environment_variables = optional(map(string), { name = "value" })
-  }))
+* name  = optional(string)
+*    image = string
+*    pvc = optional(map(object({
+*      name       = string
+*      pvc        = optional(bool, false)
+*      config_map = optional(bool, false)
+*      host_path  = optional(string)
+*      pvc_size   = optional(string)
+*      mount_path = string
+*    environment = optional(map(object({
+*      name  = optional(string)
+*      value = optional(string)
+*      value_from = optional(object({
+*        secret_key_ref = object({
+*          name = string
+*          key  = optional(string, null)
+*        })
+*      }))
+*    replicas               = optional(number, 1)
+*    namespace              = optional(string)
+*    service_port           = optional(number)
+*    service_name           = optional(string)
+*    liveness_tcp_socket    = optional(number)
+*    liveness_http_get      = optional(string)
+*    liveness_http_get_path = optional(string)
+*    database               = optional(map(string))
+*    redis                  = optional(map(string))
+*    enabled                = optional(bool, true)
+*    secret_ref             = optional(list(string))
+*    config_map_ref          = optional(list(string))
+*    requirements = optional(map(string), {
+*      limits-cpu      = "800m"
+*      limits-memory   = "500Mi"
+*      requests-cpu    = "200m"
+*      requests-memory = "200Mi"
+*    environment_variables = optional(map(string), { name = "value" })
 
-}
 
-```
 ### Name
 Name of the Deployment 
 Not required , the object name will be used if not specified