twenty/packages/twenty-docker/k8s/terraform/README.md
Ciara Hatcher c3bf94e4cc
Lumosviridi v20 kubernetes updates (#6356)
Updates for v20+ and misc terraform bug fixes. Also refactored to use
terraform variables instead of locals which helps with readability and
ease of use for new users.

Terraform validation is currently passing:
![Screenshot 2024-07-21 at 13 18
37](https://github.com/user-attachments/assets/02aadc2d-d3f6-4e8b-9315-64e25191d9e6)

Additionally added [terraform-docs](https://terraform-docs.io/) to
generate a more helpful README for terraform specific configuration.

Raw K8s manifests were updated with changes for v20+ as well.

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2024-08-08 13:55:45 +02:00

6.8 KiB

TwentyCRM Terraform Docs

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 .

To make configuration changes to how this doc is generated, see ./.terraform-docs.yml

Requirements

Name Version
terraform >= 1.9.2
kubernetes >= 2.31.0

Providers

Name Version
kubernetes >= 2.31.0

Resources

Name Type
kubernetes_deployment.twentycrm_db resource
kubernetes_deployment.twentycrm_server resource
kubernetes_deployment.twentycrm_worker resource
kubernetes_ingress.twentycrm resource
kubernetes_namespace.twentycrm resource
kubernetes_persistent_volume.db resource
kubernetes_persistent_volume.server resource
kubernetes_persistent_volume_claim.db resource
kubernetes_persistent_volume_claim.server resource
kubernetes_secret.twentycrm_tokens resource
kubernetes_service.twentycrm_db resource
kubernetes_service.twentycrm_server resource

Inputs

Name Description Type Default Required
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
twentycrm_pgdb_admin_password TwentyCRM password for postgres database. string n/a yes
twentycrm_token_accessToken TwentyCRM access Token string n/a yes
twentycrm_token_fileToken TwentyCRM file Token string n/a yes
twentycrm_token_loginToken TwentyCRM login Token string n/a yes
twentycrm_token_refreshToken TwentyCRM refresh Token string n/a yes
twentycrm_app_name A friendly name prefix to use for every component deployed. string "twentycrm" no
twentycrm_db_image TwentyCRM image for database deployment. This defaults to latest. string "twentycrm/twenty-postgres:latest" no
twentycrm_db_pv_capacity Storage capacity provisioned for database persistent volume. string "10Gi" no
twentycrm_db_pv_path Local path to use to store the physical volume if using local storage on nodes. string "" no
twentycrm_db_pvc_requests Storage capacity reservation for database persistent volume claim. string "10Gi" no
twentycrm_db_replicas Number of replicas for the TwentyCRM database deployment. This defaults to 1. number 1 no
twentycrm_namespace Namespace for all TwentyCRM resources string "twentycrm" no
twentycrm_server_data_mount_path TwentyCRM mount path for servers application data. Defaults to '/app/docker-data'. string "/app/docker-data" no
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
twentycrm_server_pv_capacity Storage capacity provisioned for server persistent volume. string "10Gi" no
twentycrm_server_pv_path Local path to use to store the physical volume if using local storage on nodes. string "" no
twentycrm_server_pvc_requests Storage capacity reservation for server persistent volume claim. string "10Gi" no
twentycrm_server_replicas Number of replicas for the TwentyCRM server deployment. This defaults to 1. number 1 no
twentycrm_worker_replicas Number of replicas for the TwentyCRM worker deployment. This defaults to 1. number 1 no