Skip to content

Commit

Permalink
Merge branch 'main' into feat/ui-liveness-readiness
Browse files Browse the repository at this point in the history
  • Loading branch information
rbraeunlich authored Jan 11, 2024
2 parents 86ab1f7 + 57b7ce6 commit 149a6a7
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 17 deletions.
14 changes: 8 additions & 6 deletions HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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.20.0-beta5 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.20.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET

```

Expand All @@ -50,14 +50,14 @@ _Notes for mac users with minikube:_
```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.20.0-beta5 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.20.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```

**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.20.0-beta5
helm upgrade devlake devlake/devlake --version=0.20.0-beta6
```

### 2.3 Uninstall
Expand Down Expand Up @@ -176,23 +176,25 @@ Some useful parameters for the chart, you could also check them in 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.extraLabels | extra labels for lake's deployment template | {} |
| lake.securityContext | pod security context values | {} |
| lake.containerSecurityContext | container security context values | {} |
| lake.livenessProbe | container livenessprobe | see Values.yaml |
| lake.readinessProbe | container readinessProbe | {} |
| lake.deployment.extraLabels | extra labels for lake's deployment metadata | {} |
| 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.extraLabels | extra labels for ui's deployment template | {} |
| ui.securityContext | pod security context values | {} |
| ui.containerSecurityContext | container security context values | {} |
| ui.livenessProbe | container livenessprobe | see Values.yaml |
| ui.readinessProbe | container readinessProbe | {} |
| ui.deployment.extraLabels | extra labels for ui's deployment metadata | {} |
| service.type | Service type for exposed service | NodePort |
| service.uiPort | Node port for config ui | 32001 |
| service.ingress.enabled | If enable ingress | false |
Expand Down Expand Up @@ -295,4 +297,4 @@ helm install devlake devlake/devlake \

## 6 Troubleshooting

If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ helm install devlake devlake/devlake --set lake.encryptionSecret.secret=$ENCRYPT
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.20.0-beta5 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.20.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

If you are using minikube inside your mac, please use the following command to forward the port:
Expand Down Expand Up @@ -71,14 +71,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.20.0-beta5 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.20.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```

**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.20.0-beta5
helm upgrade devlake devlake/devlake --version=0.20.0-beta6
```

## Uninstall
Expand Down
7 changes: 3 additions & 4 deletions charts/devlake/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,13 @@ keywords:
type: application

# Chart version
version: 0.20.0-beta5.1
version: 0.20.0-beta6

# devlake version
appVersion: v0.20.0-beta5

appVersion: v0.20.0-beta6

dependencies:
- condition: grafana.enabled
name: grafana
version: "6.56.6"
repository: "https://grafana.github.io/helm-charts"
repository: "https://grafana.github.io/helm-charts"
6 changes: 6 additions & 0 deletions charts/devlake/templates/deployments.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ metadata:
name: {{ include "devlake.fullname" . }}-ui
labels:
{{- include "devlake.labels" . | nindent 4 }}
{{- with .Values.ui.deployment.extraLabels }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: 1
selector:
Expand Down Expand Up @@ -110,6 +113,9 @@ metadata:
name: {{ include "devlake.fullname" . }}-lake
labels:
{{- include "devlake.labels" . | nindent 4 }}
{{- with .Values.lake.deployment.extraLabels }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: 1
selector:
Expand Down
16 changes: 12 additions & 4 deletions charts/devlake/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# replica count
replicaCount: 1
imageTag: v0.20.0-beta5
imageTag: v0.20.0-beta6

#the common environments for all pods except grafana, grafana needs to be set in grafana section seperately
commonEnvs:
Expand Down Expand Up @@ -63,7 +63,7 @@ mysql:

# init containers for mysql if have
initContainers: []

# resources config for mysql if have
resources: {}

Expand Down Expand Up @@ -147,7 +147,7 @@ grafana:
url: ""
image:
repository: devlake.docker.scarf.sh/apache/devlake-dashboard
tag: v0.20.0-beta5
tag: v0.20.0-beta6
adminPassword: ""
grafana.ini:
server:
Expand All @@ -158,7 +158,9 @@ grafana:
#keep grafana timezone same as other pods, which is set by .Values.commonEnvs.TZ
env:
TZ: "UTC"

persistence:
enabled: true
size: 4Gi

lake:
image:
Expand Down Expand Up @@ -216,6 +218,9 @@ lake:

readinessProbe: {}

deployment:
extraLabels: {}

ui:
image:
repository: devlake.docker.scarf.sh/apache/devlake-config-ui
Expand Down Expand Up @@ -269,6 +274,9 @@ ui:

readinessProbe: { }

deployment:
extraLabels: {}

# alpine image for some init containers
alpine:
image:
Expand Down

0 comments on commit 149a6a7

Please sign in to comment.