Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: upgrade to v0.18.1-beta1 #180

Closed
wants to merge 1 commit into from
Closed

feat: upgrade to v0.18.1-beta1 #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 61 additions & 62 deletions HelmSetup.md
View file
Open in desktop
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.19.0-beta1 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.18.1-beta1 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

Visit your devlake from the node port (32001 by default): http://YOUR-NODE-IP:32001.
Expand All @@ -49,14 +49,14 @@ _Notes for mac users with minikube:_

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta1 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.18.1-beta1 --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.19.0-beta1
helm upgrade devlake devlake/devlake --version=0.18.1-beta1
```

### 2.3 Uninstall
Expand Down Expand Up @@ -132,65 +132,64 @@ 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 | {TZ: "UTC"} |
| 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.type | storage type, pvc or hostpath | pvc |
| mysql.storage.class | storage class for mysql's volume | "" |
| mysql.storage.size | volume size for mysql's data | 5Gi |
| mysql.storage.hostPath | the host path if mysql.storage.type is hostpath | /devlake/mysql/data |
| 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 | {} |
| mysql.service.type | mysql service type | ClusterIP |
| mysql.service.nodePort | specify mysql nodeport | "" |
| 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 |

| 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 | {TZ: "UTC"} |
| 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.type | storage type, pvc or hostpath | pvc |
| mysql.storage.class | storage class for mysql's volume | "" |
| mysql.storage.size | volume size for mysql's data | 5Gi |
| mysql.storage.hostPath | the host path if mysql.storage.type is hostpath | /devlake/mysql/data |
| 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 | {} |
| mysql.service.type | mysql service type | ClusterIP |
| mysql.service.nodePort | specify mysql nodeport | "" |
| 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 |

---

Expand Down
Loading
Loading