Merge pull request #30 from uc-cdis/feat/GPE-795

adding a Helm quickstart guide to manifest service

README.md

@@ -63,3 +63,8 @@ If you want to run this service locally, fill out the config.json file with the
 And then GET and POST to http://localhost:5000/
 
 You'll need AWS credentials in your environment to run this locally.
+
+### Quickstart with Helm
+
+You can now deploy individual services via Helm!
+Please refer to the Helm quickstart guide HERE (https://github.com/uc-cdis/manifestservice/blob/master/docs/quickstart_helm.md)

docs/quickstart_helm.md

@@ -0,0 +1,43 @@
+## Quickstart with Helm
+
+If you are looking to deploy all Gen3 services, that can be done via the Gen3 Helm chart.
+Instructions for deploying all Gen3 services with Helm can be found [here](https://github.com/uc-cdis/gen3-helm#readme).
+
+To deploy the manifestservice service:
+```bash
+helm repo add gen3 https://helm.gen3.org
+helm repo update
+helm upgrade --install gen3/manifestservice
+```
+These commands will add the Gen3 helm chart repo and install the manifestservice service to your Kubernetes cluster.
+
+Deploying manifestservice this way will use the defaults that are defined in this [values.yaml file](https://github.com/uc-cdis/gen3-helm/blob/master/helm/manifestservice/values.yaml)
+
+You can learn more about these values by accessing the manifestservice [README.md](https://github.com/uc-cdis/gen3-helm/blob/master/helm/manifestservice/README.md)
+
+If you would like to override any of the default values, simply copy the above values.yaml file into a local file and make any changes needed.
+
+You can then supply your new values file with the following command:
+```bash
+helm upgrade --install gen3/manifestservice -f values.yaml
+```
+
+If you are using Docker Build to create new images for testing, you can deploy them via Helm by replacing the .image.repository value with the name of your local image.
+You will also want to set the .image.pullPolicy to "never" so kubernetes will look locally for your image.
+Here is an example:
+```bash
+image:
+  repository: <image name from docker image ls>
+  pullPolicy: Never
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: ""
+```
+
+Re-run the following command to update your helm deployment to use the new image:
+```bash
+helm upgrade --install gen3/manifestservice
+```
+
+You can also store your images in a local registry. Kind and Minikube are popular for their local registries:
+- https://kind.sigs.k8s.io/docs/user/local-registry/
+- https://minikube.sigs.k8s.io/docs/handbook/registry/#enabling-insecure-registries