packages/twenty-docker/k8s/terraform/README.md
This file was generated by terraform-docs, for more information on how to install, configure, and use visit their website.
To update this README.md after changes to the Terraform code in this folder, run: terraform-docs -c ./.terraform-docs.yml .`
To make configuration changes to how this doc is generated, see ./.terraform-docs.yml
| Name | Version |
|---|---|
| <a name="requirement_terraform"></a> terraform | >= 1.9.2 |
| <a name="requirement_kubernetes"></a> kubernetes | >= 2.32.0 |
| <a name="requirement_random"></a> random | >= 3.6.3 |
| Name | Version |
|---|---|
| <a name="provider_kubernetes"></a> kubernetes | >= 2.32.0 |
| <a name="provider_random"></a> random | >= 3.6.3 |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| <a name="input_twentycrm_app_hostname"></a> twentycrm_app_hostname | The protocol, DNS fully qualified hostname, and port used to access TwentyCRM in your environment. Ex: https://crm.example.com:443 | string | n/a | yes |
| <a name="input_twentycrm_pgdb_admin_password"></a> twentycrm_pgdb_admin_password | TwentyCRM password for postgres database. | string | n/a | yes |
| <a name="input_twentycrm_app_name"></a> twentycrm_app_name | A friendly name prefix to use for every component deployed. | string | "twentycrm" | no |
| <a name="input_twentycrm_db_image"></a> twentycrm_db_image | TwentyCRM image for database deployment. This defaults to latest. | string | "twentycrm/twenty-postgres-spilo:latest" | no |
| <a name="input_twentycrm_db_pv_capacity"></a> twentycrm_db_pv_capacity | Storage capacity provisioned for database persistent volume. | string | "10Gi" | no |
| <a name="input_twentycrm_db_pv_path"></a> twentycrm_db_pv_path | Local path to use to store the physical volume if using local storage on nodes. | string | "" | no |
| <a name="input_twentycrm_db_pvc_requests"></a> twentycrm_db_pvc_requests | Storage capacity reservation for database persistent volume claim. | string | "10Gi" | no |
| <a name="input_twentycrm_db_replicas"></a> twentycrm_db_replicas | Number of replicas for the TwentyCRM database deployment. This defaults to 1. | number | 1 | no |
| <a name="input_twentycrm_docker_data_mount_path"></a> twentycrm_docker_data_mount_path | TwentyCRM mount path for servers application data. Defaults to '/app/docker-data'. | string | "/app/docker-data" | no |
| <a name="input_twentycrm_docker_data_pv_capacity"></a> twentycrm_docker_data_pv_capacity | Storage capacity provisioned for server persistent volume. | string | "10Gi" | no |
| <a name="input_twentycrm_docker_data_pv_path"></a> twentycrm_docker_data_pv_path | Local path to use to store the physical volume if using local storage on nodes. | string | "" | no |
| <a name="input_twentycrm_docker_data_pvc_requests"></a> twentycrm_docker_data_pvc_requests | Storage capacity reservation for server persistent volume claim. | string | "10Gi" | no |
| <a name="input_twentycrm_namespace"></a> twentycrm_namespace | Namespace for all TwentyCRM resources | string | "twentycrm" | no |
| <a name="input_twentycrm_redis_image"></a> twentycrm_redis_image | TwentyCRM image for Redis deployment. This defaults to latest. | string | "redis/redis-stack-server:latest" | no |
| <a name="input_twentycrm_redis_replicas"></a> twentycrm_redis_replicas | Number of replicas for the TwentyCRM Redis deployment. This defaults to 1. | number | 1 | no |
| <a name="input_twentycrm_server_data_mount_path"></a> twentycrm_server_data_mount_path | TwentyCRM mount path for servers application data. Defaults to '/app/packages/twenty-server/.local-storage'. | string | "/app/packages/twenty-server/.local-storage" | no |
| <a name="input_twentycrm_server_image"></a> twentycrm_server_image | TwentyCRM server image for the server deployment. This defaults to latest. This value is also used for the workers image. | string | "twentycrm/twenty:latest" | no |
| <a name="input_twentycrm_server_pv_capacity"></a> twentycrm_server_pv_capacity | Storage capacity provisioned for server persistent volume. | string | "10Gi" | no |
| <a name="input_twentycrm_server_pv_path"></a> twentycrm_server_pv_path | Local path to use to store the physical volume if using local storage on nodes. | string | "" | no |
| <a name="input_twentycrm_server_pvc_requests"></a> twentycrm_server_pvc_requests | Storage capacity reservation for server persistent volume claim. | string | "10Gi" | no |
| <a name="input_twentycrm_server_replicas"></a> twentycrm_server_replicas | Number of replicas for the TwentyCRM server deployment. This defaults to 1. | number | 1 | no |
| <a name="input_twentycrm_worker_replicas"></a> twentycrm_worker_replicas | Number of replicas for the TwentyCRM worker deployment. This defaults to 1. | number | 1 | no |