Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 4.18 KB

README.md

File metadata and controls

101 lines (72 loc) · 4.18 KB
Raw

Apache Incubator DevLake Helm Chart

Thanks to @matrixji who initiated all content in apache/incubator-devlake, this repo is copied from directory deployment/helm in repo apache/incubator-devlake! Also thanks to @lshmouse, @shubham-cmyk and @SnowMoon-Dev for the contribution for devlake helm deployment.

Install

  1. Install the latest stable version with release name devlake
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake
  1. Install the latest development version with release name devlake:
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
ENCRYPTION_SECRET=$(openssl rand -base64 2000 | tr -dc 'A-Z' | fold -w 128 | head -n 1)
helm install devlake devlake/devlake --version=0.18.0-beta1 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET

If you are using minikube inside your mac, please use the following command to forward the port:

kubectl port-forward service/devlake-ui  30090:4000

and open another terminal:

kubectl port-forward service/devlake-grafana  30091:3000

Then you can visit: config-ui by url http://YOUR-NODE-IP:30090 grafana by url http://YOUR-NODE-IP:30091

Upgrade

Note: If you're upgrading from DevLake v0.17.x or earlier versions to v0.18.x or later versions:

  1. Copy the ENCODE_KEY value from /app/config/.env of the lake pod (e.g. devlake-lake-0), and replace the <ENCRYPTION_SECRET> in the upgrade command below.

  2. You may encounter the below error when upgrading because the built-in grafana has been replaced by the official grafana dependency. So you may need to delete the grafana deployment first.

Error: UPGRADE FAILED: cannot patch "devlake-grafana" with kind Deployment: Deployment.apps "devlake-grafana" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/instance":"devlake", "app.kubernetes.io/name":"grafana"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable

helm repo update
helm upgrade --install devlake devlake/devlake --version=0.18.0-beta1 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>

Uninstall

To uninstall/delete the devlake release:

helm uninstall devlake

Original pr in apache/incubator-devlake

https://github.com/apache/incubator-devlake/pulls?q=is%3Apr+helm+is%3Aclosed

How to upgrade helm chart after releasing new devlake images

  1. In values.yaml, change {{ imageTag }} to current image tag
  2. In chart.yaml, change {{ version }}, {{ appVersion }} to current image tag
  3. If we want to release a new chart without new release of devlake, we should increase both chart version and image tag.
    • For example, right now both versions are 0.16.1-beta1, if we make change on chart, we should set chart-version to 0.16.1-beta1, also, we need to crate new images for devlake with tag 0.16.1-beta1
  4. If we release any new image for devlake, we just need to set a new version for chart.

Original pr in apache/incubator-devlake

https://github.com/apache/incubator-devlake/pulls?q=is%3Apr+helm+is%3Aclosed

More

You could find more examples and details in HelmSetup.md