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

update to v0.18.0-beta7 #630

Merged
merged 1 commit into from
Aug 24, 2023
Merged

update to v0.18.0-beta7 #630

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
2 changes: 1 addition & 1 deletion docs/GettingStarted/DockerComposeSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1

## Launch DevLake

1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta6) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta7) into a folder.
2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s).
3. Generate a secure encryption key using a method such as OpenSSL. For example, run the following command to generate a 128-character string consisting of uppercase letters:

Expand Down
17 changes: 10 additions & 7 deletions docs/GettingStarted/HelmSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +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. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone"
3. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone",grafana.env.TZ="your timezone"

4. 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.18.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.18.0-beta7 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -81,14 +80,14 @@ grafana by url `http://YOUR-NODE-IP:30091`

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.18.0-beta7 --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.18.0-beta6
helm upgrade devlake devlake/devlake --version=0.18.0-beta7
```

### Uninstall
Expand Down Expand Up @@ -164,22 +163,26 @@ 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 | [] |
| 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 |
Expand Down Expand Up @@ -212,7 +215,7 @@ Some useful parameters for the chart, you could also check them in values.yaml
| 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.connectionSecretName | The database connection details secret name | devlake-mysql-auth |
| option.autoCreateSecret | If let the helm chart create the secret | true |


Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v0.18/GettingStarted/DockerComposeSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1

## Launch DevLake

1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta6) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta7) into a folder.
2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s).
3. Generate a secure encryption key using a method such as OpenSSL. For example, run the following command to generate a 128-character string consisting of uppercase letters:

Expand Down
16 changes: 10 additions & 6 deletions versioned_docs/version-v0.18/GettingStarted/HelmSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +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. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone"
3. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone",grafana.env.TZ="your timezone"

4. 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.18.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.18.0-beta7 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -80,14 +80,14 @@ grafana by url `http://YOUR-NODE-IP:30091`

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.18.0-beta7 --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.18.0-beta6
helm upgrade devlake devlake/devlake --version=0.18.0-beta7
```

### Uninstall
Expand Down Expand Up @@ -163,22 +163,26 @@ 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 | [] |
| 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 |
Expand Down Expand Up @@ -211,7 +215,7 @@ Some useful parameters for the chart, you could also check them in values.yaml
| 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.connectionSecretName | The database connection details secret name | devlake-mysql-auth |
| option.autoCreateSecret | If let the helm chart create the secret | true |


Expand Down