This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 8d77a534f1 Adjust the HelmSetup.md for version 0.18 (#556)
8d77a534f1 is described below
commit 8d77a534f1e088fc45b2c035f6d84b543ba597b6
Author: ZhangNing10 <[email protected]>
AuthorDate: Tue Jul 4 16:24:57 2023 +0800
Adjust the HelmSetup.md for version 0.18 (#556)
Co-authored-by: abeizn <[email protected]>
---
docs/GettingStarted/HelmSetup.md | 40 ++++++++++++++++++++++++----------------
1 file changed, 24 insertions(+), 16 deletions(-)
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index c5ab71570b..f936ef3f89 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -34,12 +34,14 @@ To install the chart with release name `devlake`,follow
these steps:
**Please make sure to keep the ENCRYPTION_SECRET safe as it is used to
encrypt sensitive information in the database, such as personal access tokens
and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt
this sensitive information.**
+
3. Install the chart by running the following commands:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
- helm install devlake devlake/devlake --version=0.17.0-beta10
+ 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
```
And visit your devlake from the node port (32001 by default).
@@ -66,9 +68,10 @@ grafana by url `http://YOUR-NODE-IP:30091`
### 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
```shell
helm repo update
-helm upgrade --install devlake devlake/devlake --version=0.17.0-beta11
+helm upgrade devlake devlake/devlake --version=0.18.0-beta1 --set
lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```
### Uninstall
@@ -89,7 +92,8 @@ Conditions:
- Want to visit devlake with port 30000.
```
-helm install devlake devlake/devlake --set service.uiPort=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
@@ -102,7 +106,8 @@ Conditions:
- I want to use http://devlake.example.com for visiting devlake
```
-helm install devlake devlake/devlake --set
"ingress.enabled=true,ingress.hostname=devlake.example.com"
+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" --set
lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```
After deployed, visit devlake: http://devlake.example.com, and grafana at
http://devlake.example.com/grafana
@@ -124,10 +129,12 @@ 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
@@ -140,6 +147,7 @@ Some useful parameters for the chart, you could also check
them in values.yaml
| ----------------------------------------- |
---------------------------------------------------- | ------------------------
|
| 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 |
@@ -164,13 +172,12 @@ Some useful parameters for the chart, you could also
check them in values.yaml
| grafana.containerSecurityContext | container security context
values | {} |
| grafana.oauthEnabled | enable oauth for grafana
| false |
| grafana.oauthConfig | a list of env vars used for
oauth | {} |
-| lake.storage.class | storage class for lake's volume
| "" |
-| lake.storage.size | volume size for lake's data
| 100Mi |
| lake.image.repository | repository for lake's image
| apache/devlake |
| lake.image.pullPolicy | pullPolicy for lake's image
| Always |
-| lake.loggingDir | log dir for the lake server
| /app/logs |
-| lake.loggingLevel | log level for the lake server
| info |
-| lake.dotenv | initial configurations for
injecting to lake's .env | see Values.yaml |
+| 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.extraLabels | extra labels for lake's
statefulset | {} |
| lake.securityContext | pod security context values
| {} |
| lake.containerSecurityContext | container security context
values | {} |
@@ -179,9 +186,7 @@ Some useful parameters for the chart, you could also check
them in values.yaml
| 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.useSecret | If use secret instead of
configmap for basic auth | false |
-| ui.basicAuth.autoCreateSecret | If let the helm chart create the
secret | true |
-| ui.basicAuth.secretName | The basic auth secret name
| devlake-auth |
+| 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 | {} |
@@ -195,11 +200,8 @@ Some useful parameters for the chart, you could also check
them in values.yaml
| 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.localtime | The hostpath for mount as
/etc/localtime | /etc/localtime |
| option.database | The database type, valids: mysql
| mysql |
-| option.useConnectionDetailsSecret | If use secret instead of
configmap for db connection | false |
-| option.connectionSecretName | The database connection details
secret name | devlake-db-connection |
-| option.autoCreateSecret | If let the helm chart create the
secret | true |
+| option.connectionSecretName | The database connection details
secret name | "" |
| awsCognitoAuth.enabled | use AWS cognito for
authentication | false |
| awsCognitoAuth.awsAuthRegion | aws Cognito auth region
| "" |
| awsCognitoAuth.awsAuthUserPoolID | aws Cognito user pool ID
| "" |
@@ -226,6 +228,7 @@ 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 \
@@ -233,6 +236,8 @@ helm install devlake devlake/devlake \
--set mysql.username=admin \
--set mysql.password=password_4_admin \
--set mysql.database=devlake
+ --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
+
```
2. Can I use a secret to store the database connection details?
@@ -259,9 +264,12 @@ 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
+
```
## Troubleshooting
