documentation in progress

2024-12-11 22:48:46 +00:00
parent 0f4c16f811
commit 89e8f53564
1 changed files with 38 additions and 37 deletions
@@ -2,43 +2,44 @@

 ## Variable

-* 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 
+***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" })
+not in use anymore

 ### Name
 Name of the Deployment 
@@ -132,7 +133,7 @@ Use the built-in continuous integration in GitLab.
 - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
 - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

-***
+---

 # Editing this README