docs(zitadel): add optional to postgres_volume_options variable descr…

…iption

modules/zitadel/README.md

@@ -57,7 +57,7 @@ Secure authentication management for your application. Customize as you grow, wi
 | <a name="input_network_aliases"></a> [network\_aliases](#input\_network\_aliases) | (Optional) Aliases (alternative hostnames) for this service on all specified networks. Other containers on the same network can use either the service name or this alias to connect to one of the service's containers. See https://docs.docker.com/compose/compose-file/compose-file-v3/#aliases for more information. | `list(string)` | `[]` | no |
 | <a name="input_networks"></a> [networks](#input\_networks) | (Optional) The networks attached to this service | `set(string)` | `[]` | no |
 | <a name="input_ports"></a> [ports](#input\_ports) | (Optional) The ports to expose on the swarm for the service.<br><br>    ports = [{<br>      target\_port    = The port inside the container.<br>      name           = A random name for the port.<br>      protocol       = Represents the protocol of a port: tcp, udp or sctp. Defaults to 'tcp'.<br>      publish\_mode   = Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to 'ingress'.<br>      published\_port = The port on the swarm hosts.<br>    }] | <pre>list(object({<br>    target_port    = number,<br>    name           = optional(string),<br>    protocol       = optional(string, "tcp"),<br>    publish_mode   = optional(string, "ingress")<br>    published_port = optional(number),<br>  }))</pre> | `[]` | no |
-| <a name="input_postgresql"></a> [postgresql](#input\_postgresql) | Configuration for the PostgreSQL service to be used with Zitadel.<br><br>    - custom\_image: (Optional) The docker image name excluding the image tag.<br>    - image\_tag: (Optional) The image tag of the docker image. Defaults to: latest.<br>    - args: (Optional) The arguments to pass to the docker image.<br>    - env: (Optional) The environmental variables to pass to the docker image.<br>    - mounts: (Optional) Mounts of this docker service.<br>    - labels: (Optional) Labels to add to the service and container.<br>    - constraints: (Optional) The container placement constraints.<br>    - limit: (Optional) The resources limit of service, memory unit is MB.<br>    - reservation: (Optional) The resource reservation of service, memory unit is MB.<br>    - restart\_policy: (Optional) Restart policy for containers.<br>    - auth: (Optional) The authentication for a private docker registry.<br>    - healthcheck: (Optional) Healthcheck configuration for the container.<br>    - postgres\_volume\_options: The PostgreSQL data volume driver with its options. | <pre>object({<br>    custom_image = optional(string, null)<br>    image_tag    = optional(string, "latest")<br>    args         = optional(list(string), null)<br>    env          = optional(map(string), null)<br>    mounts = optional(set(object({<br>      target    = string<br>      type      = string<br>      read_only = optional(bool, false)<br>      source    = optional(string)<br>      tmpfs_options = optional(object({<br>        mode       = optional(number)<br>        size_bytes = optional(number)<br>      }), null)<br>      volume_options = optional(object({<br>        driver_name    = optional(string)<br>        driver_options = optional(map(string))<br>        labels         = optional(map(string))<br>        no_copy        = optional(bool)<br>      }), {})<br>    })), [])<br>    labels      = optional(map(string), {})<br>    constraints = optional(set(string), [])<br>    limit = optional(object({<br>      cores  = optional(number)<br>      memory = optional(number)<br>    }), null)<br>    reservation = optional(object({<br>      cores  = optional(number)<br>      memory = optional(number)<br>      generic_resources = optional(object({<br>        discrete_resources_spec = optional(set(string))<br>        named_resources_spec    = optional(set(string))<br>      }))<br>    }), null)<br>    restart_policy = optional(object({<br>      condition    = optional(string, "any")<br>      delay        = optional(string, "5s")<br>      max_attempts = optional(number, 0)<br>      window       = optional(string, "5s")<br>      }), {<br>      condition    = "any"<br>      delay        = "5s"<br>      max_attempts = 0<br>      window       = "5s"<br>    })<br>    auth = optional(object({<br>      server_address = optional(string)<br>      username       = string<br>      password       = string<br>    }), null)<br>    healthcheck = optional(object({<br>      test         = list(string)<br>      interval     = optional(string, "0s")<br>      timeout      = optional(string, "0s")<br>      retries      = optional(number, 0)<br>      start_period = optional(string, "0s")<br>    }), null)<br>    postgres_volume_options = optional(object({<br>      driver_name    = optional(string)<br>      driver_options = optional(map(string))<br>      labels         = optional(map(string))<br>      no_copy        = optional(bool)<br>    }), {})<br>  })</pre> | <pre>{<br>  "args": null,<br>  "auth": null,<br>  "constraints": [],<br>  "custom_image": null,<br>  "env": null,<br>  "healthcheck": null,<br>  "image_tag": "latest",<br>  "labels": {},<br>  "limit": null,<br>  "mounts": [],<br>  "postgres_volume_options": {<br>    "driver_name": "local",<br>    "driver_options": {},<br>    "labels": {}<br>  },<br>  "reservation": null,<br>  "restart_policy": {<br>    "condition": "any",<br>    "delay": "5s",<br>    "max_attempts": 0,<br>    "window": "5s"<br>  }<br>}</pre> | no |
+| <a name="input_postgresql"></a> [postgresql](#input\_postgresql) | Configuration for the PostgreSQL service to be used with Zitadel.<br><br>    - custom\_image: (Optional) The docker image name excluding the image tag.<br>    - image\_tag: (Optional) The image tag of the docker image. Defaults to: latest.<br>    - args: (Optional) The arguments to pass to the docker image.<br>    - env: (Optional) The environmental variables to pass to the docker image.<br>    - mounts: (Optional) Mounts of this docker service.<br>    - labels: (Optional) Labels to add to the service and container.<br>    - constraints: (Optional) The container placement constraints.<br>    - limit: (Optional) The resources limit of service, memory unit is MB.<br>    - reservation: (Optional) The resource reservation of service, memory unit is MB.<br>    - restart\_policy: (Optional) Restart policy for containers.<br>    - auth: (Optional) The authentication for a private docker registry.<br>    - healthcheck: (Optional) Healthcheck configuration for the container.<br>    - postgres\_volume\_options (Optional): The PostgreSQL data volume driver with its options. | <pre>object({<br>    custom_image = optional(string, null)<br>    image_tag    = optional(string, "latest")<br>    args         = optional(list(string), null)<br>    env          = optional(map(string), null)<br>    mounts = optional(set(object({<br>      target    = string<br>      type      = string<br>      read_only = optional(bool, false)<br>      source    = optional(string)<br>      tmpfs_options = optional(object({<br>        mode       = optional(number)<br>        size_bytes = optional(number)<br>      }), null)<br>      volume_options = optional(object({<br>        driver_name    = optional(string)<br>        driver_options = optional(map(string))<br>        labels         = optional(map(string))<br>        no_copy        = optional(bool)<br>      }), {})<br>    })), [])<br>    labels      = optional(map(string), {})<br>    constraints = optional(set(string), [])<br>    limit = optional(object({<br>      cores  = optional(number)<br>      memory = optional(number)<br>    }), null)<br>    reservation = optional(object({<br>      cores  = optional(number)<br>      memory = optional(number)<br>      generic_resources = optional(object({<br>        discrete_resources_spec = optional(set(string))<br>        named_resources_spec    = optional(set(string))<br>      }))<br>    }), null)<br>    restart_policy = optional(object({<br>      condition    = optional(string, "any")<br>      delay        = optional(string, "5s")<br>      max_attempts = optional(number, 0)<br>      window       = optional(string, "5s")<br>      }), {<br>      condition    = "any"<br>      delay        = "5s"<br>      max_attempts = 0<br>      window       = "5s"<br>    })<br>    auth = optional(object({<br>      server_address = optional(string)<br>      username       = string<br>      password       = string<br>    }), null)<br>    healthcheck = optional(object({<br>      test         = list(string)<br>      interval     = optional(string, "0s")<br>      timeout      = optional(string, "0s")<br>      retries      = optional(number, 0)<br>      start_period = optional(string, "0s")<br>    }), null)<br>    postgres_volume_options = optional(object({<br>      driver_name    = optional(string)<br>      driver_options = optional(map(string))<br>      labels         = optional(map(string))<br>      no_copy        = optional(bool)<br>    }), {})<br>  })</pre> | <pre>{<br>  "args": null,<br>  "auth": null,<br>  "constraints": [],<br>  "custom_image": null,<br>  "env": null,<br>  "healthcheck": null,<br>  "image_tag": "latest",<br>  "labels": {},<br>  "limit": null,<br>  "mounts": [],<br>  "postgres_volume_options": {<br>    "driver_name": "local",<br>    "driver_options": {},<br>    "labels": {}<br>  },<br>  "reservation": null,<br>  "restart_policy": {<br>    "condition": "any",<br>    "delay": "5s",<br>    "max_attempts": 0,<br>    "window": "5s"<br>  }<br>}</pre> | no |
 | <a name="input_reservation"></a> [reservation](#input\_reservation) | (Optional) The resource reservation for the Zitadel service, memory unit is MB. | <pre>object({<br>    cores  = optional(number)<br>    memory = optional(number)<br>    generic_resources = optional(object({<br>      discrete_resources_spec = optional(set(string))<br>      named_resources_spec    = optional(set(string))<br>    }))<br>  })</pre> | `null` | no |
 | <a name="input_restart_policy"></a> [restart\_policy](#input\_restart\_policy) | (Optional) Restart policy for containers.<br><br>    restart\_policy = {<br>      condition    = Condition for restart; possible options are "none" which does not automatically restart, "on-failure" restarts on non-zero exit, "any" (default) restarts regardless of exit status.<br>      delay        = Delay between restart attempts (default is 5s) (ms\|s\|m\|h).<br>      max\_attempts = How many times to attempt to restart a container before giving up (default: 0, i.e. never give up). If the restart does not succeed within the configured window, this attempt doesn't count toward the configured max\_attempts value. For example, if max\_attempts is set to '2', and the restart fails on the first attempt, more than two restarts must be attempted.<br>      window       = The time window used to evaluate the restart policy (default value is 5s, 0 means unbounded) (ms\|s\|m\|h).<br>    } | <pre>object({<br>    condition    = optional(string, "any")<br>    delay        = optional(string, "5s")<br>    max_attempts = optional(number, 0)<br>    window       = optional(string, "5s")<br>  })</pre> | <pre>{<br>  "condition": "any",<br>  "delay": "5s",<br>  "max_attempts": 0,<br>  "window": "5s"<br>}</pre> | no |
 | <a name="input_secret_map"></a> [secret\_map](#input\_secret\_map) | (Optional) Similar to the secrets variable but allows for docker secret creation from terraform resources.<br><br>    secret\_map = {<br>      key = {<br>        file\_name   = Represents the final filename in the filesystem.<br>        secret\_id   = ID of the specific secret that we're referencing.<br>        file\_gid    = Represents the file GID. Defaults to '0'.<br>        file\_mode   = Represents represents the FileMode of the file. Defaults to '0o444'.<br>        file\_uid    = Represents the file UID. Defaults to '0'.<br>        secret\_name = Name of the secret that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID.<br>      }<br>    } | <pre>map(object({<br>    file_name = string<br>    # secret_id   = string # secret will be created and we take that resource id<br>    file_gid    = optional(string, "0")<br>    file_mode   = optional(number, 0444)<br>    file_uid    = optional(string, "0")<br>    secret_name = optional(string, null)<br>    secret_data = string<br>  }))</pre> | `{}` | no |

modules/zitadel/variables.tf

@@ -492,7 +492,7 @@ variable "postgresql" {
     - restart_policy: (Optional) Restart policy for containers.
     - auth: (Optional) The authentication for a private docker registry.
     - healthcheck: (Optional) Healthcheck configuration for the container.
-    - postgres_volume_options: The PostgreSQL data volume driver with its options.
+    - postgres_volume_options (Optional): The PostgreSQL data volume driver with its options.
   EOT
   default = {
     custom_image = null