mirror of https://github.com/lingble/twenty.git synced 2025-11-06 07:37:56 +00:00

Files

Thomas Mol ba2ee0da72 Refactor Redis connections to use Redis URL - closes #7421 (#7736 )

Closes #7421

This pull request consolidates Redis connection parameters into a single
`REDIS_URL` environment variable across various configuration files and
code modules. The most important changes include updates to environment
variable files, Docker and Kubernetes configurations, and code modules
to utilize the new `REDIS_URL` format.

### Environment Variable Updates:
*
[`packages/twenty-docker/.env.example`](diffhunk://#diff-f4b5e7acc0dde630eafb2228390ca56bd56db0d183582be6433a9ee808088a4cL8-R8):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.
*
[`packages/twenty-server/.env.example`](diffhunk://#diff-c06e244338b33286ea90221635809785352a971de53f647ea65650124ae74ad2L53-R53):
Replaced `REDIS_HOST`, `REDIS_PORT`, `REDIS_USERNAME`, and
`REDIS_PASSWORD` with `REDIS_URL`.
*
[`packages/twenty-server/.env.test`](diffhunk://#diff-def44a08e699c9deca2f72c9f87951de5d33d9ccf5621eab2f34978df8ad0954L16-R16):
Replaced `REDIS_HOST`, `REDIS_PORT`, `REDIS_USERNAME`, and
`REDIS_PASSWORD` with `REDIS_URL`.

### Docker and Kubernetes Configuration Updates:
*
[`packages/twenty-docker/docker-compose.yml`](diffhunk://#diff-545fb51ad66f93f727bb8f8b375dc6858b33348d91d5e51ad931fb0bbc1affeeL28-R28):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL` in multiple
service definitions.
[[1]](diffhunk://#diff-545fb51ad66f93f727bb8f8b375dc6858b33348d91d5e51ad931fb0bbc1affeeL28-R28)
[[2]](diffhunk://#diff-545fb51ad66f93f727bb8f8b375dc6858b33348d91d5e51ad931fb0bbc1affeeL62-R61)
*
[`packages/twenty-docker/k8s/manifests/deployment-server.yaml`](diffhunk://#diff-91623ed4e8b2088947cfa9a5dad76b6013e8db0c150d84347a215fa9ad78bf04L44-R45):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.
*
[`packages/twenty-docker/k8s/manifests/deployment-worker.yaml`](diffhunk://#diff-8532debd131ce168a2527fa6a9be6405792178576ee47e2eef0cd9f3ff4a8f8cL43-R44):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.
*
[`packages/twenty-docker/k8s/terraform/deployment-server.tf`](diffhunk://#diff-b4c468660ab00bd03589d0d47502c477ca83f7d876ff196534880b02ba46dce0L64-R65):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.
*
[`packages/twenty-docker/k8s/terraform/deployment-worker.tf`](diffhunk://#diff-e5d6a1f68d5391e2120aef6261f22f905aa1ce0a567e31b21a27d44f313eaecaL62-R63):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.

### Code Module Updates:
*
[`packages/twenty-server/src/engine/core-modules/cache-storage/cache-storage.module-factory.ts`](diffhunk://#diff-06e787a7c8a48022d5909b5df9b8c6ca192521cf32f51d7f561cee937bed6678L23-R35):
Replaced `REDIS_HOST` and `REDIS_PORT` with `REDIS_URL`.
*
[`packages/twenty-server/src/engine/core-modules/environment/environment-variables.ts`](diffhunk://#diff-26ce615693b053eda02aa48aa2e30400381a2588dcb08d4a9dc3b0bf5bdd6fe7L378-R384):
Added validation for `REDIS_URL`.
*
[`packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts`](diffhunk://#diff-7bd644d28bdd86c159c1d71242753df5d5acd91c73c6e60b2e35caa53ed3836bR6):
Replaced `REDIS_HOST`, `REDIS_PORT`, `REDIS_USERNAME`, and
`REDIS_PASSWORD` with `REDIS_URL`.
[[1]](diffhunk://#diff-7bd644d28bdd86c159c1d71242753df5d5acd91c73c6e60b2e35caa53ed3836bR6)
[[2]](diffhunk://#diff-7bd644d28bdd86c159c1d71242753df5d5acd91c73c6e60b2e35caa53ed3836bL35-R41)

### Documentation Updates:
*
[`packages/twenty-website/src/content/developers/self-hosting/self-hosting-var.mdx`](diffhunk://#diff-c4cc78a3ce18b6edb10f1aee8990271e1d2796a8c06c1c6ae3b68db8d52278a3L37-R37):
Updated documentation to reflect the change to `REDIS_URL`.
*
[`packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx`](diffhunk://#diff-c7d757829f6128e1f47aa1955bde561292dce558280511fab66281afa99042a5R102-R112):
Added upgrade instructions for the new `REDIS_URL` variable.

---------

Co-authored-by: Weiko <corentin@twenty.com>
Co-authored-by: Charles Bochet <charles@twenty.com>

2024-10-16 17:17:44 +02:00

.terraform-docs.yml

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

deployment-db.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

deployment-redis.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

deployment-server.tf

Refactor Redis connections to use Redis URL - closes #7421 (#7736 )

2024-10-16 17:17:44 +02:00

deployment-worker.tf

Refactor Redis connections to use Redis URL - closes #7421 (#7736 )

2024-10-16 17:17:44 +02:00

ingress.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

main.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

namespace.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

pv-db.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

pv-docker-data.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

pv-server.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

pvc-db.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

pvc-docker-data.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

pvc-server.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

README.md

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

secret.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

service-db.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

service-redis.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

service-server.tf

Lumosviridi v20 kubernetes updates (#6356 )

2024-08-08 13:55:45 +02:00

variables.tf

Updating terraform and k8s files adding redis... (#7425 )

2024-10-07 10:23:42 +02:00

README.md

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 -c ./.terraform-docs.yml .`

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

Requirements

Name	Version
terraform	>= 1.9.2
kubernetes	>= 2.32.0
random	>= 3.6.3

Providers

Name	Version
kubernetes	>= 2.32.0
random	>= 3.6.3

Resources

Name	Type
kubernetes_deployment.twentycrm_db	resource
kubernetes_deployment.twentycrm_redis	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.docker_data	resource
kubernetes_persistent_volume.server	resource
kubernetes_persistent_volume_claim.db	resource
kubernetes_persistent_volume_claim.docker_data	resource
kubernetes_persistent_volume_claim.server	resource
kubernetes_secret.twentycrm_tokens	resource
kubernetes_service.twentycrm_db	resource
kubernetes_service.twentycrm_redis	resource
kubernetes_service.twentycrm_server	resource
random_bytes.this	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_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_docker_data_mount_path	TwentyCRM mount path for servers application data. Defaults to '/app/docker-data'.	`string`	`"/app/docker-data"`	no
twentycrm_docker_data_pv_capacity	Storage capacity provisioned for server persistent volume.	`string`	`"10Gi"`	no
twentycrm_docker_data_pv_path	Local path to use to store the physical volume if using local storage on nodes.	`string`	`""`	no
twentycrm_docker_data_pvc_requests	Storage capacity reservation for server persistent volume claim.	`string`	`"10Gi"`	no
twentycrm_namespace	Namespace for all TwentyCRM resources	`string`	`"twentycrm"`	no
twentycrm_redis_image	TwentyCRM image for Redis deployment. This defaults to latest.	`string`	`"redis/redis-stack-server:latest"`	no
twentycrm_redis_replicas	Number of replicas for the TwentyCRM Redis deployment. This defaults to 1.	`number`	`1`	no
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
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