mirror of https://github.com/twentyhq/twenty.git synced 2024-12-25 13:02:15 +03:00

History

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
..
manifests	Lumosviridi v20 kubernetes updates (#6356 )	2024-08-08 13:55:45 +02:00
terraform	Lumosviridi v20 kubernetes updates (#6356 )	2024-08-08 13:55:45 +02:00
README.md	Support for Kubernetes via Terraform and Manifests (#5721 )	2024-07-10 13:54:27 +02:00

README.md

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:

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

Navigate to the Terraform directory:
```
cd terraform
```
Initialize Terraform:
```
terraform init
```
Plan the deployment:
```
terraform plan
```
Apply the deployment:
```
terraform apply
```

OR

Step 3: Deploy with Kubernetes Manifests

Navigate to the Kubernetes manifests directory:
```
cd ../k8s
```

Create Server Secret

kubectl create secret generic -n twentycrm tokens --from-literal accessToken=changeme --from-literal loginToken="changeme" --from-literal refreshToken="changeme" --from-literal fileToken="changeme"

Apply the manifests:
```
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!