Skip to content

Latest commit

 

History

History
246 lines (183 loc) · 14.9 KB

HelmSetup.md

File metadata and controls

246 lines (183 loc) · 14.9 KB
Raw
title description sidebar_position
Install via Helm
The steps to install Apache DevLake via Helm for Kubernetes
2

1 Prerequisites

  • Helm >= 3.6.0
  • Kubernetes >= 1.19.0

2 Quick Start

Check https://github.com/apache/incubator-devlake-helm-chart to contribute!

2.1 Install

To install the chart 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

Visit your devlake from the node port (32001 by default): http://YOUR-NODE-IP:32001.

Notes for mac users with minikube:

  • forward the port: kubectl port-forward svc/devlake-ui 4000:4000
  • access config-ui: http://YOUR-NODE-IP:4000/
  • access Grafana dashboard: click the dashboard button in config-ui, or visit http://YOUR-NODE-IP:4000/grafana/

2.2 Update

if you upgrade from 0.17* to 0.18*, please copy the ENCODE_KEY value from /app/config/.env of the pod devlake-lake-0, and replace <ENCRYPTION_SECRET> of below upgrade cmd

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

2.3 Uninstall

To uninstall/delete the devlake release:

helm uninstall devlake

3 Example Deployments

3.1 Deploy with NodePort

Conditions:

  • IP Address of Kubernetes node: 192.168.0.6
  • Want to visit devlake with port 30000.
ENCRYPTION_SECRET=$(openssl rand -base64 2000 | tr -dc 'A-Z' | fold -w 128 | head -n 1)
helm install devlake devlake/devlake --set service.uiPort=30000 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET

After deployed, visit devlake: http://192.168.0.6:30000

3.2 Deploy with Ingress

Conditions:

  • I have already configured default ingress for the Kubernetes cluster
  • I want to use http://devlake.example.com for visiting devlake
ENCRYPTION_SECRET=$(openssl rand -base64 2000 | tr -dc 'A-Z' | fold -w 128 | head -n 1)
helm install devlake devlake/devlake --set "ingress.enabled=true,ingress.hostname=devlake.example.com,lake.encryptionSecret.secret=$ENCRYPTION_SECRET"

After deployed, visit devlake: http://devlake.example.com, and grafana at http://devlake.example.com/grafana

3.3 Deploy with Ingress (Https)

Conditions:

  • I have already configured ingress(class: nginx) for the Kubernetes cluster, and the https using 8443 port.
  • I want to use https://devlake-0.example.com:8443 for visiting devlake.
  • The https certificates are generated by letsencrypt.org, and the certificate and key files: cert.pem and key.pem

First, create the secret:

kubectl create secret tls ssl-certificate --cert cert.pem --key secret.pem

Then, deploy the devlake:

ENCRYPTION_SECRET=$(openssl rand -base64 2000 | tr -dc 'A-Z' | fold -w 128 | head -n 1)
helm install devlake devlake/devlake \
    --set "ingress.enabled=true,ingress.enableHttps=true,ingress.hostname=devlake-0.example.com" \
    --set "ingress.className=nginx,ingress.httpsPort=8443" \
    --set "ingress.tlsSecretName=ssl-certificate"
    --set "lake.encryptionSecret.secret=$ENCRYPTION_SECRET"

After deployed, visit devlake: https://devlake-0.example.com:8443, and grafana at https://devlake-0.example.com:8443/grafana

4 Parameters

Some useful parameters for the chart, you could also check them in values.yaml

Parameter Description Default
replicaCount Replica Count for devlake, currently not used 1
imageTag The version tag for all images see Values.yaml
envs The common envs for all pods []
mysql.useExternal If use external mysql server, set true false
mysql.externalServer External mysql server address 127.0.0.1
mysql.externalPort External mysql server port 3306
mysql.username username for mysql merico
mysql.password password for mysql merico
mysql.database database for mysql lake
mysql.rootPassword root password for mysql admin
mysql.storage.class storage class for mysql's volume ""
mysql.storage.size volume size for mysql's data 5Gi
mysql.image.repository repository for mysql's image mysql
mysql.image.tag image tag for mysql's image 8
mysql.image.pullPolicy pullPolicy for mysql's image IfNotPresent
mysql.extraLabels extra labels for mysql's statefulset {}
mysql.securityContext pod security context values {}
mysql.containerSecurityContext container security context values {}
grafana dashboard, datasource, etc. settings for grafana, installed by grafana official chart
lake.image.repository repository for lake's image apache/devlake
lake.image.pullPolicy pullPolicy for lake's image Always
lake.port the port of devlake backend 8080
lake.envs initial envs for lake see Values.yaml
lake.encryptionSecret.secretName the k8s secret name for ENCRYPTION_SECRET ""
lake.encryptionSecret.secret the secret for ENCRYPTION_SECRET ""
lake.encryptionSecret.autoCreateSecret whether let the helm chart create the secret true
lake.extraLabels extra labels for lake's statefulset {}
lake.securityContext pod security context values {}
lake.containerSecurityContext container security context values {}
ui.image.repository repository for ui's image apache/devlake-config-ui
ui.image.pullPolicy pullPolicy for ui's image Always
ui.basicAuth.enabled If the basic auth in ui is enabled false
ui.basicAuth.user The user name for the basic auth "admin"
ui.basicAuth.password The password for the basic auth "admin"
ui.basicAuth.autoCreateSecret If let the helm chart create the secret true
ui.basicAuth.secretName The basic auth secret name ""
ui.extraLabels extra labels for ui's statefulset {}
ui.securityContext pod security context values {}
ui.containerSecurityContext container security context values {}
service.type Service type for exposed service NodePort
service.uiPort Node port for config ui 32001
service.ingress.enabled If enable ingress false
service.ingress.enableHttps If enable https false
service.ingress.className Name for ingressClass. leave empty for using default ""
service.ingress.hostname The hostname/domainname for ingress localhost
service.ingress.prefix The prefix for endpoints, currently not used /
service.ingress.tlsSecretName The secret name for tls's certificate for https ""
service.ingress.httpPort The http port for ingress 80
service.ingress.httpsPort The https port for ingress 443
option.database The database type, valids: mysql mysql
option.connectionSecretName The database connection details secret name "devlake-mysql-auth"
option.autoCreateSecret If let the helm chart create the secret true

5 FAQ

  1. Can I use a managed Cloud database service instead of running database in docker?

Yes, it just set useExternal value to true while you deploy devlake with helm chart. Below we'll use MySQL on AWS RDS as an example.

a. (Optional) Create a MySQL instance on AWS RDS following this doc, skip this step if you'd like to use an existing instance b. Proviede below values while install from helm:

- `mysql.useExternal`: this should be `true`
- `mysql.externalServer`: use your RDS instance's IP address or domain name.
- `mysql.externalPort`: use your RDS instance's database port.
- `mysql.username`: use your `username` for access RDS instance's DB
- `mysql.password`: use your `password` for access RDS instance's DB
- `mysql.database`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`

Here is the example:

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 \
  --set mysql.useExternal=true \
  --set mysql.externalServer=db.example.com \
  --set mysql.externalPort=3306 \
  --set mysql.username=admin \
  --set mysql.password=password_4_admin \
  --set mysql.database=devlake
  --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
  1. Can I use a secret to store the database connection details?

Yes, to do so, you need to have a secret in your Kubernetes Cluster that contains the following values:

  • MYSQL_USER: The user to connect to your DB.
  • MYSQL_PASSWORD: The password to connect to your DB.
  • MYSQL_DATABASE: The database to connect to your DB.
  • MYSQL_ROOT_PASSWORD: The root password to connect to your DB.
  • DB_URL: mysql://username:password@dbserver:port/database?charset=utf8mb4&parseTime=True

The secret name needs to be the same as the value option.connectionSecretName

  1. Can I use an external Grafana instead of running built-in Grafana?

Yes, the devlake helm chart supports using an external Grafana. You can set the following values while installing from helm:

  • grafana.useExternal: this should be true
  • grafana.externalUrl: use your Grafana's URL, e.g. https://grafana.example.com

Here is the example:

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 \
  --set grafana.useExternal=true \
  --set grafana.externalUrl=https://grafana.example.com
  --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET

6 Troubleshooting

If you run into any problem, please check the Troubleshooting or create an issue