You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,24 @@
2
2
Helm Chart for DIffgram
3
3
4
4
# Pre-requisites
5
+
### Setting Up the Docker Registry Key:
6
+
7
+
To install the helm chart you will need to receive a GCR key with the permissions from
8
+
the Diffgram team to fetch our images.
9
+
10
+
Please Contact us if you want to get one here: https://diffgram.com/contact
11
+
12
+
Once you have your GCR Key please set it in the `values.yaml` file, specifically inside the
13
+
key `imagePullCredentials.gcrCredentials`.
14
+
15
+
16
+
```
17
+
imagePullCredentials:
18
+
# The service account with permissions to pull from the GCR Repository. [Should be Provided by Diffgram Team.]
19
+
gcrCredentials: <YOUR KEY GOES HERE>
20
+
```
21
+
22
+
5
23
6
24
### TLS Ceritificates
7
25
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.
@@ -33,16 +51,20 @@ Future versions will provide a repo to download the chart without cloning from g
33
51
When deploying this chart there are 5 main components to be aware of:
34
52
35
53
**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.
54
+
36
55
**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
56
+
37
57
**3. frontend-service:** Static VueJS frontend for accessing Diffgram.
58
+
38
59
**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.
60
+
39
61
**5. ingress:** A Nginx ingress controller for accessing all the services. This is the entry point and router to all the above services.
40
62
41
63
42
64
# Configurations:
43
65
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.
44
66
## 4.1 Database Settings
45
-
**1. dbSettings.dbProvider:** Set this to “rds”
67
+
**1. dbSettings.dbProvider:** Set this to “rds”, "azure", or "local" depending on your DB managed service.
46
68
47
69
**2. dbSettings.rdsEndpoint:** Set this to your RDS instance endpoint, so diffgram can use it as the database.
0 commit comments