You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by ab...@apache.org on 2023/07/14 09:28:50 UTC
[incubator-devlake-website] branch main updated: update the parameters of helm install (#581)
This is an automated email from the ASF dual-hosted git repository.
abeizn 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 3f1b845f24 update the parameters of helm install (#581)
3f1b845f24 is described below
commit 3f1b845f24ed1623407b2dc320a3ea5f2780028f
Author: ZhangNing10 <13...@users.noreply.github.com>
AuthorDate: Fri Jul 14 17:28:46 2023 +0800
update the parameters of helm install (#581)
---
docs/GettingStarted/HelmSetup.md | 119 ++++++++++++++++++---------------------
1 file changed, 55 insertions(+), 64 deletions(-)
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index f887c8e782..1ee3cd37c9 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -40,7 +40,6 @@ To install the chart with release name `devlake`,follow these steps:
```shell
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
```
@@ -151,69 +150,61 @@ After deployed, visit devlake: https://devlake-0.example.com:8443, and grafana a
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.image.repository | repository for grafana's image | apache/devlake-dashboard |
-| grafana.image.pullPolicy | pullPolicy for grafana's image | Always |
-| grafana.useExternal | If use external grafana server | false |
-| grafana.externalUrl | external grafana server if use external | "" |
-| grafana.extraLabels | extra labels for grafana's statefulset | {} |
-| grafana.securityContext | pod security context values | {} |
-| grafana.containerSecurityContext | container security context values | {} |
-| grafana.oauthEnabled | enable oauth for grafana | false |
-| grafana.oauthConfig | a list of env vars used for oauth | {} |
-| 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.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.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 | "" |
-| awsCognitoAuth.enabled | use AWS cognito for authentication | false |
-| awsCognitoAuth.awsAuthRegion | aws Cognito auth region | "" |
-| awsCognitoAuth.awsAuthUserPoolID | aws Cognito user pool ID | "" |
-| awsCognitoAuth.awsAuthUserPoolWebClientID | aws Cognito web client ID for the user pool | "" |
+| 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 |
+
## FAQ