From 43016db80107a67e5de635a690da58867fb2c811 Mon Sep 17 00:00:00 2001 From: Ciara Hatcher <67052777+LumosViridi@users.noreply.github.com> Date: Wed, 10 Jul 2024 06:54:27 -0500 Subject: [PATCH] Support for Kubernetes via Terraform and Manifests (#5721) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Support for Kubernetes via Terraform and Manifests Adding basic support for the following Kubernetes resources - persistent volume - server - database - persistent volume claim - server - database - deployment - server - database - ingress - server - service - server - database - secret - server --------- Co-authored-by: Félix Malfait --- packages/twenty-docker/k8s/README.md | 113 ++++++++++++ .../k8s/manifests/deployment-db.yaml | 54 ++++++ .../k8s/manifests/deployment-server.yaml | 82 +++++++++ .../twenty-docker/k8s/manifests/ingress.yaml | 24 +++ .../twenty-docker/k8s/manifests/pv-db.yaml | 11 ++ .../k8s/manifests/pv-server.yaml | 12 ++ .../twenty-docker/k8s/manifests/pvc-db.yaml | 13 ++ .../k8s/manifests/pvc-server.yaml | 13 ++ .../k8s/manifests/service-db.yaml | 18 ++ .../k8s/manifests/service-server.yaml | 19 ++ .../k8s/terraform/deployment-db.tf | 90 ++++++++++ .../k8s/terraform/deployment-server.tf | 169 ++++++++++++++++++ .../twenty-docker/k8s/terraform/ingress.tf | 30 ++++ packages/twenty-docker/k8s/terraform/main.tf | 36 ++++ .../twenty-docker/k8s/terraform/namespace.tf | 9 + packages/twenty-docker/k8s/terraform/pv-db.tf | 19 ++ .../twenty-docker/k8s/terraform/pv-server.tf | 19 ++ .../twenty-docker/k8s/terraform/pvc-db.tf | 15 ++ .../twenty-docker/k8s/terraform/pvc-server.tf | 15 ++ .../twenty-docker/k8s/terraform/secret.tf | 15 ++ .../twenty-docker/k8s/terraform/service-db.tf | 18 ++ .../k8s/terraform/service-server.tf | 19 ++ .../twenty-docker/k8s/terraform/variables.tf | 24 +++ .../self-hosting/cloud-providers.mdx | 14 +- 24 files changed, 849 insertions(+), 2 deletions(-) create mode 100644 packages/twenty-docker/k8s/README.md create mode 100644 packages/twenty-docker/k8s/manifests/deployment-db.yaml create mode 100644 packages/twenty-docker/k8s/manifests/deployment-server.yaml create mode 100644 packages/twenty-docker/k8s/manifests/ingress.yaml create mode 100644 packages/twenty-docker/k8s/manifests/pv-db.yaml create mode 100644 packages/twenty-docker/k8s/manifests/pv-server.yaml create mode 100644 packages/twenty-docker/k8s/manifests/pvc-db.yaml create mode 100644 packages/twenty-docker/k8s/manifests/pvc-server.yaml create mode 100644 packages/twenty-docker/k8s/manifests/service-db.yaml create mode 100644 packages/twenty-docker/k8s/manifests/service-server.yaml create mode 100644 packages/twenty-docker/k8s/terraform/deployment-db.tf create mode 100644 packages/twenty-docker/k8s/terraform/deployment-server.tf create mode 100644 packages/twenty-docker/k8s/terraform/ingress.tf create mode 100644 packages/twenty-docker/k8s/terraform/main.tf create mode 100644 packages/twenty-docker/k8s/terraform/namespace.tf create mode 100644 packages/twenty-docker/k8s/terraform/pv-db.tf create mode 100644 packages/twenty-docker/k8s/terraform/pv-server.tf create mode 100644 packages/twenty-docker/k8s/terraform/pvc-db.tf create mode 100644 packages/twenty-docker/k8s/terraform/pvc-server.tf create mode 100644 packages/twenty-docker/k8s/terraform/secret.tf create mode 100644 packages/twenty-docker/k8s/terraform/service-db.tf create mode 100644 packages/twenty-docker/k8s/terraform/service-server.tf create mode 100644 packages/twenty-docker/k8s/terraform/variables.tf diff --git a/packages/twenty-docker/k8s/README.md b/packages/twenty-docker/k8s/README.md new file mode 100644 index 000000000000..df1cde709784 --- /dev/null +++ b/packages/twenty-docker/k8s/README.md @@ -0,0 +1,113 @@ +# README + +## Overview + +This repository contains Kubernetes manifests and Terraform files to help you deploy and manage the TwentyCRM application. The files are located in the `packages/twenty-docker/k8s` directory. + +## Prerequisites + +Before using these files, ensure you have the following installed and configured on your system: + +- Kubernetes cluster (e.g., Minikube, EKS, GKE) +- kubectl +- Terraform +- Docker + +## Setup Instructions + +### Step 1: Clone the Repository + +Clone the repository to your local machine: + +``` bash +git clone https://github.com/twentyhq/twenty.git +cd twentycrm/packages/twenty-docker/k8s +``` + +### Step 2: Customize the Manifests and Terraform Files + +**Important:** These files require customization for your specific implementation. Update the placeholders and configurations according to your environment and requirements. + +### Step 3: Deploy with Terraform + +1. Navigate to the Terraform directory: + + ```bash + cd terraform + ``` + +2. Initialize Terraform: + + ```bash + terraform init + ``` + +3. Plan the deployment: + + ```bash + terraform plan + ``` + +4. Apply the deployment: + + ```bash + terraform apply + ``` + +## OR + +### Step 3: Deploy with Kubernetes Manifests + +1. Navigate to the Kubernetes manifests directory: + + ```bash + cd ../k8s + ``` + +2. Create Server Secret + + ``` bash + kubectl create secret generic -n twentycrm tokens --from-literal accessToken=changeme --from-literal loginToken="changeme" --from-literal refreshToken="changeme" --from-literal fileToken="changeme" + ``` + +3. Apply the manifests: + + ```bash + kubectl apply -f . + ``` + +## Customization + +### Kubernetes Manifests + +- **Namespace:** Update the `namespace` in the manifests as needed. +- **Resource Limits:** Adjust the resource limits and requests according to your application's requirements. +- **Environment Variables:** Configure server tokens in the `Secret` command above. + +### Terraform Files + +- **Variables:** Update the variables in the `variables.tf` file to match your environment. +- **Locals:** Update the locals in the `main.tf` file to match your environment. +- **Providers:** Ensure the provider configurations (e.g., AWS, GCP) are correct for your setup. +- **Resources:** Modify the resource definitions as needed to fit your infrastructure. + +## Troubleshooting + +### Common Issues + +- **Connectivity:** Ensure your Kubernetes cluster is accessible and configured correctly. +- **Permissions:** Verify that you have the necessary permissions to deploy resources in your cloud provider. +- **Resource Limits:** Adjust resource limits if you encounter issues related to insufficient resources. + +### Logs and Debugging + +- Use `kubectl logs` to check the logs of your Kubernetes pods. +- Use `terraform show` and `terraform state` to inspect your Terraform state and configurations. + +## Conclusion + +This setup provides a basic structure for deploying the TwentyCRM application using Kubernetes and Terraform. Ensure you thoroughly customize the manifests and Terraform files to suit your specific needs. For any issues or questions, please refer to the official documentation of Kubernetes and Terraform or seek support from your cloud provider. + +--- + +Feel free to contribute and improve this repository by submitting pull requests or opening issues. Happy deploying! diff --git a/packages/twenty-docker/k8s/manifests/deployment-db.yaml b/packages/twenty-docker/k8s/manifests/deployment-db.yaml new file mode 100644 index 000000000000..8d9dec9df404 --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/deployment-db.yaml @@ -0,0 +1,54 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app: twentycrm-db + name: twentycrm-db + namespace: twentycrm +spec: + progressDeadlineSeconds: 600 + replicas: 1 + strategy: + rollingUpdate: + maxSurge: 1 + maxUnavailable: 1 + type: RollingUpdate + selector: + matchLabels: + app: twentycrm-db + template: + metadata: + labels: + app: twentycrm-db + spec: + volumes: + - name: twentycrm-db-data + persistentVolumeClaim: + claimName: twentycrm-db-pvc + containers: + - env: + - name: POSTGRES_PASSWORD + value: "twenty" + - name: BITNAMI_DEBUG + value: "true" + - image: twentycrm/twenty-postgres:latest + imagePullPolicy: Always + name: twentycrm + ports: + - containerPort: 5432 + name: tcp + protocol: TCP + resources: + requests: + memory: "256Mi" + cpu: "250m" + limits: + memory: "1024Mi" + cpu: "1000m" + stdin: true + tty: true + volumeMounts: + - mountPath: /bitnami/postgresql + name: twentycrm-db-data + dnsPolicy: ClusterFirst + restartPolicy: Always diff --git a/packages/twenty-docker/k8s/manifests/deployment-server.yaml b/packages/twenty-docker/k8s/manifests/deployment-server.yaml new file mode 100644 index 000000000000..cf740722f55e --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/deployment-server.yaml @@ -0,0 +1,82 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app: twentycrm-server + name: twentycrm-server + namespace: twentycrm +spec: + progressDeadlineSeconds: 600 + replicas: 1 + strategy: + rollingUpdate: + maxSurge: 1 + maxUnavailable: 1 + type: RollingUpdate + selector: + matchLabels: + app: twentycrm-server + template: + metadata: + labels: + app: twentycrm-server + spec: + volumes: + - name: twentycrm-server-data + persistentVolumeClaim: + claimName: twentycrm-server-pvc + containers: + - env: + - name: PORT + value: 3000 + - name: SERVER_URL + value: "https://crm.example.com:443" + - name: PG_DATABASE_URL + value: "postgres://twenty:twenty@twenty-db.twentycrm.svc.cluster.local/default" + - name: ENABLE_DB_MIGRATIONS + value: "true" + - name: SIGN_IN_PREFILLED + value: "true" + - name: STORAGE_TYPE + value: "local" + - name: ACCESS_TOKEN_SECRET + valueFrom: + secretKeyRef: + name: tokens + key: accessToken + - name: LOGIN_TOKEN_SECRET + valueFrom: + secretKeyRef: + name: tokens + key: loginToken + - name: REFRESH_TOKEN_SECRET + valueFrom: + secretKeyRef: + name: tokens + key: refreshToken + - name: FILE_TOKEN_SECRET + valueFrom: + secretKeyRef: + name: tokens + key: fileToken + - image: twentycrm/twenty:latest + imagePullPolicy: Always + name: twentycrm + ports: + - containerPort: 3000 + name: http-tcp + protocol: TCP + resources: + requests: + memory: "256Mi" + cpu: "250m" + limits: + memory: "1024Mi" + cpu: "1000m" + stdin: true + tty: true + volumeMounts: + - mountPath: /app/.local-storage + name: twentycrm-server-data + dnsPolicy: ClusterFirst + restartPolicy: Always diff --git a/packages/twenty-docker/k8s/manifests/ingress.yaml b/packages/twenty-docker/k8s/manifests/ingress.yaml new file mode 100644 index 000000000000..19663f7a4f51 --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/ingress.yaml @@ -0,0 +1,24 @@ +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: twentycrm + namespace: twentycrm + annotations: + nginx.ingress.kubernetes.io/configuration-snippet: | + more_set_headers "X-Forwarded-For $http_x_forwarded_for"; + nginx.ingress.kubernetes.io/force-ssl-redirect: "false" + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/backend-protocol: "HTTP" +spec: + ingressClassName: nginx + rules: + - host: crm.example.com + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: twentycrm-server + port: + name: http-tcp diff --git a/packages/twenty-docker/k8s/manifests/pv-db.yaml b/packages/twenty-docker/k8s/manifests/pv-db.yaml new file mode 100644 index 000000000000..9caa4ca4d919 --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/pv-db.yaml @@ -0,0 +1,11 @@ +apiVersion: v1 +kind: PersistentVolume +metadata: + name: twentycrm-db-pv +spec: + storageClassName: default + capacity: + storage: 10Gi + accessModes: + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain diff --git a/packages/twenty-docker/k8s/manifests/pv-server.yaml b/packages/twenty-docker/k8s/manifests/pv-server.yaml new file mode 100644 index 000000000000..721de7d5668a --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/pv-server.yaml @@ -0,0 +1,12 @@ +apiVersion: v1 +kind: PersistentVolume +metadata: + name: twentycrm-server-pv + namespace: twentycrm +spec: + storageClassName: default + capacity: + storage: 10Gi + accessModes: + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain diff --git a/packages/twenty-docker/k8s/manifests/pvc-db.yaml b/packages/twenty-docker/k8s/manifests/pvc-db.yaml new file mode 100644 index 000000000000..146596ea1050 --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/pvc-db.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: twentycrm-db-pvc + namespace: twentycrm +spec: + storageClassName: default + volumeName: twentycrm-db-pv + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 10Gi diff --git a/packages/twenty-docker/k8s/manifests/pvc-server.yaml b/packages/twenty-docker/k8s/manifests/pvc-server.yaml new file mode 100644 index 000000000000..f265057cf569 --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/pvc-server.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: twentycrm-server-pvc + namespace: twentycrm +spec: + storageClassName: default + volumeName: twentycrm-server-pv + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 10Gi diff --git a/packages/twenty-docker/k8s/manifests/service-db.yaml b/packages/twenty-docker/k8s/manifests/service-db.yaml new file mode 100644 index 000000000000..bb0e38df6d6d --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/service-db.yaml @@ -0,0 +1,18 @@ +apiVersion: v1 +kind: Service +metadata: + name: twentycrm-db + namespace: twentycrm +spec: + internalTrafficPolicy: Cluster + ports: + - port: 5432 + protocol: TCP + targetPort: 5432 + selector: + app: twentycrm-db + sessionAffinity: ClientIP + sessionAffinityConfig: + clientIP: + timeoutSeconds: 10800 + type: ClusterIP diff --git a/packages/twenty-docker/k8s/manifests/service-server.yaml b/packages/twenty-docker/k8s/manifests/service-server.yaml new file mode 100644 index 000000000000..7fcc869a6edc --- /dev/null +++ b/packages/twenty-docker/k8s/manifests/service-server.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: twentycrm-server + namespace: twentycrm +spec: + internalTrafficPolicy: Cluster + ports: + - name: http-tcp + port: 3000 + protocol: TCP + targetPort: 3000 + selector: + app: twentycrm-server + sessionAffinity: ClientIP + sessionAffinityConfig: + clientIP: + timeoutSeconds: 10800 + type: ClusterIP diff --git a/packages/twenty-docker/k8s/terraform/deployment-db.tf b/packages/twenty-docker/k8s/terraform/deployment-db.tf new file mode 100644 index 000000000000..c2a5a64b11a2 --- /dev/null +++ b/packages/twenty-docker/k8s/terraform/deployment-db.tf @@ -0,0 +1,90 @@ +resource "kubernetes_deployment" "twentycrm_db" { + metadata { + name = "${local.twentycrm_app_name}-db" + namespace = kubernetes_namespace.twentycrm.metadata.0.name + labels = { + app = "${local.twentycrm_app_name}-db" + } + } + + spec { + replicas = 1 + selector { + match_labels = { + app = "${local.twentycrm_app_name}-db" + } + } + + strategy { + type = "RollingUpdate" + rolling_update { + max_surge = "1" + max_unavailable = "1" + } + } + + template { + metadata { + labels = { + app = "${local.twentycrm_app_name}-db" + } + } + + spec { + # security_context { + # fs_group = 0 + # } + container { + image = local.twentycrm_db_image + name = local.twentycrm_app_name + stdin = true + tty = true + security_context { + allow_privilege_escalation = true + } + + env { + name = "POSTGRES_PASSWORD" + value = "twenty" + } + env { + name = "BITNAMI_DEBUG" + value = true + } + + port { + container_port = 5432 + protocol = "TCP" + } + + resources { + requests = { + cpu = "250m" + memory = "256Mi" + } + limits = { + cpu = "1000m" + memory = "1024Mi" + } + } + + volume_mount { + name = "nfs-twentycrm-db-data" + mount_path = "/bitnami/postgresql" + } + } + + volume { + name = "nfs-twentycrm-db-data" + + persistent_volume_claim { + claim_name = "nfs-twentycrm-db-data-pvc" + } + } + + dns_policy = "ClusterFirst" + restart_policy = "Always" + } + } + } +} diff --git a/packages/twenty-docker/k8s/terraform/deployment-server.tf b/packages/twenty-docker/k8s/terraform/deployment-server.tf new file mode 100644 index 000000000000..13a4d30bf708 --- /dev/null +++ b/packages/twenty-docker/k8s/terraform/deployment-server.tf @@ -0,0 +1,169 @@ +resource "kubernetes_deployment" "twentycrm_server" { + metadata { + name = "${local.twentycrm_app_name}-server" + namespace = kubernetes_namespace.twentycrm.metadata.0.name + labels = { + app = "${local.twentycrm_app_name}-server" + } + } + + spec { + replicas = 1 + selector { + match_labels = { + app = "${local.twentycrm_app_name}-server" + } + } + + strategy { + type = "RollingUpdate" + rolling_update { + max_surge = "1" + max_unavailable = "1" + } + } + + template { + metadata { + labels = { + app = "${local.twentycrm_app_name}-server" + } + } + + spec { + container { + image = local.twentycrm_server_image + name = local.twentycrm_app_name + stdin = true + tty = true + + security_context { + allow_privilege_escalation = true + privileged = true + run_as_user = 1000 + } + + env { + name = "PORT" + value = "3000" + } + env { + name = "DEBUG_MODE" + value = false + } + + env { + name = "SERVER_URL" + value = "https://crm.example.com:443" + } + + env { + name = "FRONT_BASE_URL" + value = "https://crm.example.com:443" + } + + env { + name = "BACKEND_SERVER_URL" + value = "https://crm.example.com:443" + } + + env { + name = "PG_DATABASE_URL" + value = "postgres://twenty:twenty@twentycrm-db.twentycrm.svc.cluster.local/default" + } + + env { + name = "ENABLE_DB_MIGRATIONS" + value = "true" + } + + env { + name = "SIGN_IN_PREFILLED" + value = "true" + } + + env { + name = "STORAGE_TYPE" + value = "local" + } + + env { + name = "ACCESS_TOKEN_SECRET" + value_from { + secret_key_ref { + name = "tokens" + key = "accessToken" + } + } + } + + env { + name = "LOGIN_TOKEN_SECRET" + value_from { + secret_key_ref { + name = "tokens" + key = "loginToken" + } + } + } + + env { + name = "REFRESH_TOKEN_SECRET" + value_from { + secret_key_ref { + name = "tokens" + key = "refreshToken" + } + } + } + + env { + name = "FILE_TOKEN_SECRET" + value_from { + secret_key_ref { + name = "tokens" + key = "fileToken" + } + } + } + + port { + container_port = 3000 + protocol = "TCP" + } + + resources { + requests = { + cpu = "250m" + memory = "256Mi" + } + limits = { + cpu = "1000m" + memory = "1024Mi" + } + } + + volume_mount { + name = "nfs-twentycrm-server-data" + mount_path = "/app/.local-storage" + } + } + + volume { + name = "nfs-twentycrm-server-data" + + persistent_volume_claim { + claim_name = "nfs-twentycrm-server-data-pvc" + } + } + + dns_policy = "ClusterFirst" + restart_policy = "Always" + } + } + } + depends_on = [ + kubernetes_deployment.twentycrm_db, + kubernetes_secret.twentycrm_tokens + ] +} diff --git a/packages/twenty-docker/k8s/terraform/ingress.tf b/packages/twenty-docker/k8s/terraform/ingress.tf new file mode 100644 index 000000000000..4276333b7f54 --- /dev/null +++ b/packages/twenty-docker/k8s/terraform/ingress.tf @@ -0,0 +1,30 @@ +resource "kubernetes_ingress" "twentycrm" { + wait_for_load_balancer = true + metadata { + name = "${local.twentycrm_app_name}-ingress" + namespace = kubernetes_namespace.twentycrm.metadata.0.name + annotations = { + "kubernetes.io/ingress.class" = "nginx" + "nginx.ingress.kubernetes.io/configuration-snippet" = < This document is maintained by the community. It might contain issues. -Feel free to join our discord if you need assistance. +## Kubernetes via Terraform and Manifests + +Community-led documentation for Kubernetes deployment is available (here)[https://github.com/twentyhq/twenty/tree/main/packages/twenty-docker/k8s] + ## Render +Community-led, might not be up to date + [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/twentyhq/twenty) -## RepoCloud + +## RepoCloud + +Community-led, might not be up to date [![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=259) ## Azure Container Apps +Community-led, might not be up to date + ### About Hosts Twenty CRM using Azure Container Apps.