Merge branch 'feat/es7' of github.com:uc-cdis/gen3-helm into feat/es7

README.md

@@ -117,6 +117,9 @@ NOTE: Gen3 helm charts are currently not used in production by CTDS, but we are
 
 For local development you must be connected to a kubernetes cluster. As referenced above in the section `Kubernetes cluster` we recommend using [Rancher Desktop](https://rancherdesktop.io/) as Kubernetes on your local machine, especially on M1 Mac's. You also get ingress and other benefits out of the box.
 
+> **Warning**
+> If you are using Rancher Desktop you need to increase the vm.max_map_count as outlined [here](https://docs.rancherdesktop.io/how-to-guides/increasing-open-file-limit/)
+
 1. Clone the repository
 2. Navigate to the `gen3-helm/helm/gen3` directory and run `helm dependency update`
 3. Navigate to the back to the `gen3-helm` directory and create your values.yaml file. See the `TL;DR` section for a minimal example.

docs/portal/prebuild-portal.md

@@ -15,7 +15,7 @@ This documentation will provide instructions on how to set up a static Gen3 Port
 
 Setup the configuration locally on your machine.
 
-The dockerfile expects your portal configuration under the configurations folder. See exapmle for `dev.planx-pla.net` 
+The dockerfile expects your portal configuration under the configurations folder. See example for `dev.planx-pla.net` 
 
 ```
 configurations
@@ -36,14 +36,21 @@ https://<hostname>/api/v0/submission/_dictionary/_all
 **Hint:** both of these are served via sheepdog service
 
 
-Use the provided Dockerfile as a template for building your container.
+Use the provided Dockerfile as a template for building your container. Update:
+```
+ARG PORTAL_HOSTNAME=<hostname>
+```
 
 Build your container using the following command inside the same folder as the Dockerfile: 
 
 ```
 docker build -t <image_name>:<image_tag> .
 ```
 
+If you are using localhost, you will need to add the `--network="host"` option in the above command, e.g:
+```
+docker build -t <image_name>:<image_tag> . --network="host"
+```
 Push the container to your repository using the command: 
 
 ```
@@ -54,6 +61,26 @@ Update the image and tag in the Gen3 Portal configuration to use the new contain
 
 Note: Make sure to replace the <image_name> with the actual name you want to give to your image.
 
+Update or create the `values.yaml`, for example:
+```
+global:
+  dev: true
+  hostname: localhost
+
+portal:
+  image: 
+    repository: <image_name> 
+    tag: <image_tag>
+  resources:
+    requests:
+      cpu: 0.2
+      memory: 500Mi
+```
+
+Update helm charts
+```
+helm upgrade --install dev gen3/gen3  -f values.yaml
+```
 # Conclusion:
 Using a static Gen3 Data Portal can significantly improve the performance of the Gen3 Portal by pre-running the WebPack build and creating static files, which are then served using nginx.