Skip to content

Commit da27ae2

Browse files
author
PJEstrada
authored
Update Information On Minikube setup
1 parent 57472b0 commit da27ae2

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# diffgram-helm
22
Helm Chart for DIffgram
33

4-
# A. Pre-requisites
4+
5+
Full Tutorial on Azure: https://medium.com/diffgram/tutorial-installing-diffgram-on-azure-aks-b9447685e271
6+
7+
# How to Install:
8+
9+
## A. Pre-requisites
510

611
### Ingress Controller
712
If you are using minikube make sure you've done:
@@ -39,9 +44,17 @@ imagePullCredentials:
3944

4045

4146
### TLS Ceritificates
42-
For Minikube, follow this guide:
47+
#### Using minikube (For local testing)
48+
Install Cert Manager
49+
`helm repo add jetstack https://charts.jetstack.io`
50+
51+
`helm install cert-manager --namespace default jetstack/cert-manager --set installCRDs=true`
52+
53+
Default domain on diffgram is: `example.com` so make sure you add that to your local hosts file:
54+
55+
`echo "$(minikube ip) example.com" | sudo tee -a /etc/hosts`
4356

44-
https://minikube.sigs.k8s.io/docs/tutorials/custom_cert_ingress/ (Required the https://github.com/FiloSottile/mkcert Library)
57+
#### Using cert-manager
4558

4659
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.
4760

@@ -61,13 +74,17 @@ https://minikube.sigs.k8s.io/docs/tutorials/custom_cert_ingress/ (Required the h
6174
4. After a few minutes you should be able to see the issuer and the certificate generated. You can confirm this by running:
6275
`kubectl describe issuer letsencrypt-prod`
6376

64-
# B. Installation
77+
## B. Installation
6578
`git clone https://github.com/diffgram/diffgram-helm/`
6679

6780
`helm install diffgram ./diffgram-helm --create-namespace`
6881

6982
If you don't change anything on `values.yaml`. You will have the namespace `default` created on your cluster
7083

84+
Note: if on Minikube: run `echo "$(minikube ip) example.com" | sudo tee -a /etc/hosts`
85+
86+
To point minikube to domain example.com (or whatever domain you have set in the `diffgramDomain` inside `values.yaml`
87+
7188
### Values to Change in `values.yaml`
7289
Check section D. to see required values.
7390

@@ -77,7 +94,7 @@ You can substitute `./diffgram-helm` with whatever the path to this repo is on y
7794

7895
Future versions will provide a repo to download the chart without cloning from github.
7996

80-
# C. Main Structure
97+
## C. Main Structure
8198
When deploying this chart there are 5 main components to be aware of:
8299

83100
**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.
@@ -91,7 +108,7 @@ When deploying this chart there are 5 main components to be aware of:
91108
**5. ingress:** A Nginx ingress controller for accessing all the services. This is the entry point and router to all the above services.
92109

93110

94-
# D. Configurations:
111+
## D. Configurations:
95112
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.
96113
## 4.1 Database Settings
97114
**1. dbSettings.dbProvider:** Set this to “rds”, "azure", or "local" depending on your DB managed service.
@@ -116,7 +133,7 @@ The following are some of the most important configurations of the values.yaml i
116133

117134
**4. diffgramSettings.ML__DIFFGRAM_S3_BUCKET_NAME:** Set this to your S3’s bucket name for static file storage.
118135

119-
# E. Common Issues:
136+
## E. Common Issues:
120137

121138
1. My Helm Chart gets stuck during install and the timesout with
122139

0 commit comments

Comments
 (0)