Skip to content

Commit

Permalink
adding a link to the helm quickstart guide from the main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EliseCastle23 committed Mar 20, 2023
1 parent 0570e0a commit 2a769f8
Showing 1 changed file with 1 addition and 41 deletions.
42 changes: 1 addition & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,44 +67,4 @@ You'll need AWS credentials in your environment to run this locally.
### Quickstart with Helm

You can now deploy individual services via 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
Please refer to the Helm quickstart guide HERE (https://github.com/uc-cdis/manifestservice/blob/master/docs/quickstart_helm.md)

0 comments on commit 2a769f8

Please sign in to comment.