Skip to content

Commit

Permalink
adjust to v0.19.0-beta3 (#655)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhangNing10 authored Oct 8, 2023
1 parent dbeafe3 commit 8ee4fbc
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/GettingStarted/DockerComposeSetup.md
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.19.0-beta1) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta3) 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 Expand Up @@ -51,7 +51,7 @@ Note 1: **Back up your Grafana dashboards** before upgrading if you have modifie
Note 2: **If you're upgrading from DevLake v0.17.x or earlier versions to v0.18.x or later versions**, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET via .env file or environment variable in docker-compose.yml

1. Run `docker-compose down` to stop services;
2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta1).
2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta3).
3. Use the new `docker-compose.yml` and `env.example` to replace the old `docker-compose.yml` and `.env`; Or if you have modified/customized values in the old files, compare the new files with the old ones, adjust the old files according to the new ones.
4. If upgrading from earlier versions to v0.18.0+, set the ENCRYPTION_SECRET environment variable in docker-compose.yml or .env file, refer to above Note 2.
5. Run `docker-compose up -d` to start DevLake services.
Expand Down
6 changes: 3 additions & 3 deletions docs/GettingStarted/HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ 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
helm install devlake devlake/devlake --version=0.19.0-beta1 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.19.0-beta3 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```
And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -82,14 +82,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```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.19.0-beta3 --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.19.0-beta3
```

### Uninstall
Expand Down
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.19.0-beta1) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta3) 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 Expand Up @@ -51,7 +51,7 @@ Note 1: **Back up your Grafana dashboards** before upgrading if you have modifie
Note 2: **If you're upgrading from DevLake v0.17.x or earlier versions to v0.18.x or later versions**, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET via .env file or environment variable in docker-compose.yml

1. Run `docker-compose down` to stop services;
2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta1).
2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.19.0-beta3).
3. Use the new `docker-compose.yml` and `env.example` to replace the old `docker-compose.yml` and `.env`; Or if you have modified/customized values in the old files, compare the new files with the old ones, adjust the old files according to the new ones.
4. If upgrading from earlier versions to v0.18.0+, set the ENCRYPTION_SECRET environment variable in docker-compose.yml or .env file, refer to above Note 2.
5. Run `docker-compose up -d` to start DevLake services.
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v0.19/GettingStarted/HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ 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
helm install devlake devlake/devlake --version=0.19.0-beta1 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.19.0-beta3 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```
And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -82,14 +82,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```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.19.0-beta3 --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.19.0-beta3
```

### Uninstall
Expand Down

0 comments on commit 8ee4fbc

Please sign in to comment.