Merge remote-tracking branch 'origin/main' into main

Author: PJEstrada

README.md

@@ -1,2 +1,67 @@
 # diffgram-helm
 Helm Chart for DIffgram
+
+# Pre-requisites
+
+### TLS Ceritificates
+1. If you want to have TLS connections, please make sure you have a domain available and access to the name servers so you can modify the records to point to the IP addresses of the ingress.
+
+`helm repo add jetstack https://charts.jetstack.io`
+
+`helm install cert-manager --namespace default jetstack/cert-manager --set installCRDs=true`
+
+2. Now edit the values.yaml of Diffgram’s helm chart and change the following keys:
+ - **diffgramDomain:** set it to the domain you own.
+ - **useCertManager:** set this to true. This will allow the certificate issue to be created so you can automatically get a TLS certificate for your domain with let’s encrypt.
+
+3. Reinstall the helm chart
+
+
+`helm upgrade diffgram -f diffgram/new_updated_values_from_above_step.yaml`
+
+4. After a few minutes you should be able to see the issuer and the certificate generated. You can confirm this by running:
+`kubectl describe issuer letsencrypt-prod`
+
+# Installation
+`helm install diffgram ./diffgram`
+
+You can substitute `./diffgram` with whatever the path to this repo is on your local machine. Also feel free to install on any other namespace.
+
+Future versions will provide a repo to download the chart without cloning from github.
+
+# Main Structure
+When deploying this chart there are 5 main components to be aware of:
+
+**1. default-service:** This is the service in charge for most of the API calls and data management. Both for the SDK and for the Frontend UI.
+**2. walrus-service:** This is a long running service for CPU intensive processing. Things like video, splitting, huge files copying and other maintainance tasks are performed on this service
+**3. frontend-service:** Static VueJS frontend for accessing Diffgram.
+**4. db-service:** A PostgresSQL database, we usually recommend linking an external managed cloud service like AWS RDS, GCP SQL Service, or Azure Managed SQL Service.
+**5. ingress:** A Nginx ingress controller for accessing all the services. This is the entry point and router to all the above services.
+
+
+# Configurations:
+The following are some of the most important configurations of the values.yaml in the helm chart. Please feel free to contact us if you have any questions on any of the configurations.
+## 4.1 Database Settings
+**1. dbSettings.dbProvider:** Set this to “rds”
+
+**2. dbSettings.rdsEndpoint:** Set this to your RDS instance endpoint, so diffgram can use it as the database.
+
+**3. dbSettings.dbProvider:** Set this to “rds”
+
+**4, dbSettings.dbUser:** Set this to the postgres user you want to use with Diffgram.
+
+**5. dbSettings.dbName:** Set this to Postgres Database name you want to create the tables on
+
+**6. dbSettings.dbPassword:** Set this to RDS instance’s password
+
+## 4.2 Diffgram Configuration Settings
+**1. diffgramSecrets.DIFFGRAM_AWS_ACCESS_KEY_ID:** Set this to your AWS credentials access key. Make sure the account has permissions to the S3 bucket you’ll use as static storage.
+
+**2. diffgramSecrets.DIFFGRAM_AWS_ACCESS_KEY_SECRET:** Set this to your AWS credentials secret. Make sure the account has permissions to the S3 bucket you’ll use as static storage.
+
+**3. diffgramSettings.DIFFGRAM_S3_BUCKET_NAME:** Set this to your S3’s bucket name for static file storage.
+
+**4. diffgramSettings.ML__DIFFGRAM_S3_BUCKET_NAME:** Set this to your S3’s bucket name for static file storage.
+
+
+