You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2023/05/08 13:35:15 UTC
[incubator-devlake-website] branch main updated: docs: back up dashboards before upgrade (#518)
This is an automated email from the ASF dual-hosted git repository.
yumeng 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 c7970afc09 docs: back up dashboards before upgrade (#518)
c7970afc09 is described below
commit c7970afc09a98622af4bc0b06d40c9c55157d182
Author: Louis.z <lo...@gmail.com>
AuthorDate: Mon May 8 21:35:11 2023 +0800
docs: back up dashboards before upgrade (#518)
Co-authored-by: Startrekzky <ka...@merico.dev>
---
docs/GettingStarted/DockerComposeSetup.md | 4 +++-
docs/GettingStarted/HelmSetup.md | 4 +++-
versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md | 6 +++---
versioned_docs/version-v0.16/GettingStarted/HelmSetup.md | 4 +++-
versioned_docs/version-v0.17/GettingStarted/DockerComposeSetup.md | 6 ++++--
versioned_docs/version-v0.17/GettingStarted/HelmSetup.md | 6 ++++--
6 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/docs/GettingStarted/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md
index b967a350c5..17a9e5124b 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -27,9 +27,11 @@ sidebar_position: 1
## Upgrade to a newer version
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
+
1. Run `docker-compose down` to stop services;
2. Open file "docker-compose.yml". Change the image tags of "grafana", "devlake" and "config-ui" to the new version, and save;
-3. Run `docker-compose up -d` start DevLake services.
+3. Run `docker-compose up -d` to start DevLake services.
Please check the [upgrade doc](Upgrade.md) for more information.
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index 5bb9dd4a86..6625d88073 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -43,7 +43,9 @@ Then you can visit:
Config UI URL `http://YOUR-NODE-IP:30090`
Grafana URL `http://YOUR-NODE-IP:30091`
-### Update
+### Upgrade
+
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
```shell
helm repo update
diff --git a/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
index 0261b609b6..09cd5849ee 100644
--- a/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
@@ -12,8 +12,6 @@ sidebar_position: 1
## Launch DevLake
-Commands written `like this` are to be run in your terminal or pasted in the web browser.
-
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.16.1-beta1) 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. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.
@@ -29,9 +27,11 @@ Commands written `like this` are to be run in your terminal or pasted in the web
## Upgrade to a newer version
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
+
1. Run `docker-compose down` to stop services;
2. Open file "docker-compose.yml". Change the image tags of "grafana", "devlake" and "config-ui" to the new version, and save;
-3. Run `docker-compose up -d` start DevLake services.
+3. Run `docker-compose up -d` to start DevLake services.
Please check the [upgrade doc](Upgrade.md) for more information.
diff --git a/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md b/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
index 7fa2668d15..cb586c7236 100644
--- a/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
@@ -43,7 +43,9 @@ Then you can visit:
Config UI URL `http://YOUR-NODE-IP:30090`
Grafana URL `http://YOUR-NODE-IP:30091`
-### Update
+### Upgrade
+
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
```shell
helm repo update
diff --git a/versioned_docs/version-v0.17/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.17/GettingStarted/DockerComposeSetup.md
index e8f01b56f1..17a9e5124b 100644
--- a/versioned_docs/version-v0.17/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.17/GettingStarted/DockerComposeSetup.md
@@ -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.17.0-beta3) into a folder.
+1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.17.0-beta4) 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. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.
@@ -27,9 +27,11 @@ sidebar_position: 1
## Upgrade to a newer version
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
+
1. Run `docker-compose down` to stop services;
2. Open file "docker-compose.yml". Change the image tags of "grafana", "devlake" and "config-ui" to the new version, and save;
-3. Run `docker-compose up -d` start DevLake services.
+3. Run `docker-compose up -d` to start DevLake services.
Please check the [upgrade doc](Upgrade.md) for more information.
diff --git a/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md b/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
index 65be3c8a10..a408e5531b 100644
--- a/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
@@ -43,11 +43,13 @@ Then you can visit:
Config UI URL `http://YOUR-NODE-IP:30090`
Grafana URL `http://YOUR-NODE-IP:30091`
-### Update
+### Upgrade
+
+Please note: **Back up your Grafana dashboards** before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
```shell
helm repo update
-helm upgrade --install devlake devlake/devlake --version=0.17.0-beta3
+helm upgrade --install devlake devlake/devlake --version=0.17.0-beta4
```
Please check the [upgrade doc](Upgrade.md) for more information.