This is an automated email from the ASF dual-hosted git repository.
zhangliang2022 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 152b3cad11 feat: update to v0.17.0-beta9 (#548)
152b3cad11 is described below
commit 152b3cad11614454e5177037f12a039d04f03e57
Author: abeizn <[email protected]>
AuthorDate: Thu Jun 1 19:00:44 2023 +0800
feat: update to v0.17.0-beta9 (#548)
---
docs/GettingStarted/DockerComposeSetup.md | 110 ++++++++++-----------
docs/GettingStarted/HelmSetup.md | 74 +++++++-------
.../version-v0.17/GettingStarted/HelmSetup.md | 74 +++++++-------
3 files changed, 131 insertions(+), 127 deletions(-)
diff --git a/docs/GettingStarted/DockerComposeSetup.md
b/docs/GettingStarted/DockerComposeSetup.md
index df9c10db06..4ccc591c7e 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/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-beta8)
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-beta9)
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`.
@@ -36,56 +36,56 @@ Please note: **Back up your Grafana dashboards** before
upgrade if you have modi
Please check the [upgrade doc](Upgrade.md) for more information.
## FAQ
+
### Can I use a managed cloud database service instead of running database in
Docker?
Yes, please follow the steps below:
1. Comment out the 'mysql' part in `docker-compose.yml`:
+
```yaml
- mysql:
- image: mysql:8
- volumes:
- - mysql-storage:/var/lib/mysql
- restart: always
- ports:
- - "127.0.0.1:3306:3306"
- environment:
- MYSQL_ROOT_PASSWORD: admin
- MYSQL_DATABASE: lake
- MYSQL_USER: merico
- MYSQL_PASSWORD: merico
- command:
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_bin
+mysql:
+ image: mysql:8
+ volumes:
+ - mysql-storage:/var/lib/mysql
+ restart: always
+ ports:
+ - "127.0.0.1:3306:3306"
+ environment:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ command: --character-set-server=utf8mb4
+ --collation-server=utf8mb4_bin
```
2. Comment out the 'mysql' volume in `docker-compose.yml`:
```yaml
volumes:
- mysql-storage:
+ mysql-storage:
```
3. Comment out the 'depends_on mysql' part in `docker-compose.yml`:
```yaml
- depends_on:
- - mysql
+depends_on:
+ - mysql
```
4. Provide your managed cloud database connection info in the 'grafana'
section in `docker-compose.yml`:
-* MYSQL_URL: This parameter specifies the URL of your database instance. For
example, if your database is hosted on a server with IP address 123.45.67.89
and port number 3306, the URL would be "123.45.67.89:3306".
-* MYSQL_DATABASE: This parameter specifies the name of your database. For
example, if your database is named "mydatabase", you would set this parameter
to "mydatabase".
-* MYSQL_USER: This parameter specifies the username that you will use to
connect to your database. For example, if your username is "myuser", you would
set this parameter to "myuser".
-* MYSQL_PASSWORD: This parameter specifies the password that you will use to
connect to your database. For example, if your password is "mypassword", you
would set this parameter to "mypassword".
-
+- MYSQL_URL: This parameter specifies the URL of your database instance. For
example, if your database is hosted on a server with IP address 123.45.67.89
and port number 3306, the URL would be "123.45.67.89:3306".
+- MYSQL_DATABASE: This parameter specifies the name of your database. For
example, if your database is named "mydatabase", you would set this parameter
to "mydatabase".
+- MYSQL_USER: This parameter specifies the username that you will use to
connect to your database. For example, if your username is "myuser", you would
set this parameter to "myuser".
+- MYSQL_PASSWORD: This parameter specifies the password that you will use to
connect to your database. For example, if your password is "mypassword", you
would set this parameter to "mypassword".
```yaml
- MYSQL_URL: 123.45.67.89:3306
- MYSQL_DATABASE: mydatabase
- MYSQL_USER: myuser
- MYSQL_PASSWORD: mypassword
+MYSQL_URL: 123.45.67.89:3306
+MYSQL_DATABASE: mydatabase
+MYSQL_USER: myuser
+MYSQL_PASSWORD: mypassword
```
5. Set DB_URL to your own DB_URL in `.env`:
@@ -106,24 +106,24 @@ Yes, please follow the steps below:
1. Comment out the 'grafana' part:
```yaml
- grafana:
- image: mericodev/devlake-dashboard:latest
- build:
- context: grafana/
- ports:
- - "3002:3000"
- volumes:
- - grafana-storage:/var/lib/grafana
- environment:
- GF_SERVER_ROOT_URL: "http://localhost:4000/grafana";
- GF_USERS_DEFAULT_THEME: "light"
- MYSQL_URL: mysql:3306
- MYSQL_DATABASE: lake
- MYSQL_USER: merico
- MYSQL_PASSWORD: merico
- restart: always
- depends_on:
- - mysql
+grafana:
+ image: mericodev/devlake-dashboard:latest
+ build:
+ context: grafana/
+ ports:
+ - "3002:3000"
+ volumes:
+ - grafana-storage:/var/lib/grafana
+ environment:
+ GF_SERVER_ROOT_URL: "http://localhost:4000/grafana";
+ GF_USERS_DEFAULT_THEME: "light"
+ MYSQL_URL: mysql:3306
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ restart: always
+ depends_on:
+ - mysql
```
2. Comment out grafana volume:
@@ -135,20 +135,20 @@ volumes:
3. Set up the `config-ui` container to adopt the external Grafana in the
`docker-compose.yml`
- ```yaml
- config-ui:
- ...
- environment:
- USE_EXTERNAL_GRAFANA: "true"
- GRAFANA_ENDPOINT: "http://grafana.example.com";
- ...
- ```
+```yaml
+config-ui:
+ ...
+ environment:
+ USE_EXTERNAL_GRAFANA: "true"
+ GRAFANA_ENDPOINT: "http://grafana.example.com";
+ ...
+```
4. Please connect your Grafana to DevLake's database by following
https://grafana.com/docs/grafana/latest/administration/data-source-management/
5. If you want to import dashboards, please check
https://grafana.com/docs/grafana/latest/dashboards/export-import/.
-* You can find DevLake's self-built Grafana dashboards here
(https://github.com/apache/incubator-devlake/tree/main/grafana/dashboards).
+- You can find DevLake's self-built Grafana dashboards here
(https://github.com/apache/incubator-devlake/tree/main/grafana/dashboards).
6. Final step: `docker compose up -d`
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index 0f936fe487..51523d0331 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -21,7 +21,7 @@ To install the chart with release name `devlake`:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
-helm install devlake devlake/devlake --version=0.17.0-beta8
+helm install devlake devlake/devlake --version=0.17.0-beta9
```
And visit your devlake from the node port (32001 by default).
@@ -50,7 +50,7 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
-helm upgrade --install devlake devlake/devlake --version=0.17.0-beta8
+helm upgrade --install devlake devlake/devlake --version=0.17.0-beta9
```
### Uninstall
@@ -191,10 +191,10 @@ Some useful parameters for the chart, you could also
check them in values.yaml
1. Can I use a managed Cloud database service instead of running database in
docker?
- Yes, it just set useExternal value to true while you deploy devlake with
helm chart. Below we'll use MySQL on AWS RDS as an example.
+Yes, it just set useExternal value to true while you deploy devlake with helm
chart. Below we'll use MySQL on AWS RDS as an example.
- a. (Optional) Create a MySQL instance on AWS RDS following this
[doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html),
skip this step if you'd like to use an existing instance
- b. Proviede below values while install from helm:
+a. (Optional) Create a MySQL instance on AWS RDS following this
[doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html),
skip this step if you'd like to use an existing instance
+b. Proviede below values while install from helm:
- `mysql.useExternal`: this should be `true`
- `mysql.externalServer`: use your RDS instance's IP address or domain
name.
@@ -203,46 +203,48 @@ Some useful parameters for the chart, you could also
check them in values.yaml
- `mysql.password`: use your `password` for access RDS instance's DB
- `mysql.database`: use your RDS instance's DB name, you may need to
create a database first with `CREATE DATABASE <DB name>;`
- Here is the example:
+Here is the example:
- ```
- helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
- helm repo update
- helm install devlake devlake/devlake \
- --set mysql.useExternal=true \
- --set mysql.externalServer=db.example.com \
- --set mysql.externalPort=3306 \
- --set mysql.username=admin \
- --set mysql.password=password_4_admin \
- --set mysql.database=devlake
- ```
+```
+helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+helm repo update
+helm install devlake devlake/devlake \
+ --set mysql.useExternal=true \
+ --set mysql.externalServer=db.example.com \
+ --set mysql.externalPort=3306 \
+ --set mysql.username=admin \
+ --set mysql.password=password_4_admin \
+ --set mysql.database=devlake
+```
2. Can I use a secret to store the database connection details?
- Yes, to do so, you need to have a secret in your Kubernetes Cluster that
contains the following values:
+Yes, to do so, you need to have a secret in your Kubernetes Cluster that
contains the following values:
- - `MYSQL_USER`: The user to connect to your DB.
- - `MYSQL_PASSWORD`: The password to connect to your DB.
- - `MYSQL_DATABASE`: The database to connect to your DB.
- - `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
- - `DB_URL`:
mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
+- `MYSQL_USER`: The user to connect to your DB.
+- `MYSQL_PASSWORD`: The password to connect to your DB.
+- `MYSQL_DATABASE`: The database to connect to your DB.
+- `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
+- `DB_URL`:
mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
- The secret name needs to be the same as the value
`option.connectionSecretName`
+The secret name needs to be the same as the value `option.connectionSecretName`
3. Can I use an external Grafana instead of running built-in Grafana?
- Yes, the devlake helm chart supports using an external Grafana. You can set
the following values while installing from helm:
- - `grafana.useExternal`: this should be `true`
- - `grafana.externalUrl`: use your Grafana's URL, e.g.
`https://grafana.example.com`
-
- Here is the example:
- ```
- helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
- helm repo update
- helm install devlake devlake/devlake \
- --set grafana.useExternal=true \
- --set grafana.externalUrl=https://grafana.example.com
- ```
+Yes, the devlake helm chart supports using an external Grafana. You can set
the following values while installing from helm:
+
+- `grafana.useExternal`: this should be `true`
+- `grafana.externalUrl`: use your Grafana's URL, e.g.
`https://grafana.example.com`
+
+Here is the example:
+
+```
+helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+helm repo update
+helm install devlake devlake/devlake \
+ --set grafana.useExternal=true \
+ --set grafana.externalUrl=https://grafana.example.com
+```
## Troubleshooting
diff --git a/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
b/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
index 0f936fe487..51523d0331 100644
--- a/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.17/GettingStarted/HelmSetup.md
@@ -21,7 +21,7 @@ To install the chart with release name `devlake`:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
-helm install devlake devlake/devlake --version=0.17.0-beta8
+helm install devlake devlake/devlake --version=0.17.0-beta9
```
And visit your devlake from the node port (32001 by default).
@@ -50,7 +50,7 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
-helm upgrade --install devlake devlake/devlake --version=0.17.0-beta8
+helm upgrade --install devlake devlake/devlake --version=0.17.0-beta9
```
### Uninstall
@@ -191,10 +191,10 @@ Some useful parameters for the chart, you could also
check them in values.yaml
1. Can I use a managed Cloud database service instead of running database in
docker?
- Yes, it just set useExternal value to true while you deploy devlake with
helm chart. Below we'll use MySQL on AWS RDS as an example.
+Yes, it just set useExternal value to true while you deploy devlake with helm
chart. Below we'll use MySQL on AWS RDS as an example.
- a. (Optional) Create a MySQL instance on AWS RDS following this
[doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html),
skip this step if you'd like to use an existing instance
- b. Proviede below values while install from helm:
+a. (Optional) Create a MySQL instance on AWS RDS following this
[doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html),
skip this step if you'd like to use an existing instance
+b. Proviede below values while install from helm:
- `mysql.useExternal`: this should be `true`
- `mysql.externalServer`: use your RDS instance's IP address or domain
name.
@@ -203,46 +203,48 @@ Some useful parameters for the chart, you could also
check them in values.yaml
- `mysql.password`: use your `password` for access RDS instance's DB
- `mysql.database`: use your RDS instance's DB name, you may need to
create a database first with `CREATE DATABASE <DB name>;`
- Here is the example:
+Here is the example:
- ```
- helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
- helm repo update
- helm install devlake devlake/devlake \
- --set mysql.useExternal=true \
- --set mysql.externalServer=db.example.com \
- --set mysql.externalPort=3306 \
- --set mysql.username=admin \
- --set mysql.password=password_4_admin \
- --set mysql.database=devlake
- ```
+```
+helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+helm repo update
+helm install devlake devlake/devlake \
+ --set mysql.useExternal=true \
+ --set mysql.externalServer=db.example.com \
+ --set mysql.externalPort=3306 \
+ --set mysql.username=admin \
+ --set mysql.password=password_4_admin \
+ --set mysql.database=devlake
+```
2. Can I use a secret to store the database connection details?
- Yes, to do so, you need to have a secret in your Kubernetes Cluster that
contains the following values:
+Yes, to do so, you need to have a secret in your Kubernetes Cluster that
contains the following values:
- - `MYSQL_USER`: The user to connect to your DB.
- - `MYSQL_PASSWORD`: The password to connect to your DB.
- - `MYSQL_DATABASE`: The database to connect to your DB.
- - `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
- - `DB_URL`:
mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
+- `MYSQL_USER`: The user to connect to your DB.
+- `MYSQL_PASSWORD`: The password to connect to your DB.
+- `MYSQL_DATABASE`: The database to connect to your DB.
+- `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
+- `DB_URL`:
mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
- The secret name needs to be the same as the value
`option.connectionSecretName`
+The secret name needs to be the same as the value `option.connectionSecretName`
3. Can I use an external Grafana instead of running built-in Grafana?
- Yes, the devlake helm chart supports using an external Grafana. You can set
the following values while installing from helm:
- - `grafana.useExternal`: this should be `true`
- - `grafana.externalUrl`: use your Grafana's URL, e.g.
`https://grafana.example.com`
-
- Here is the example:
- ```
- helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
- helm repo update
- helm install devlake devlake/devlake \
- --set grafana.useExternal=true \
- --set grafana.externalUrl=https://grafana.example.com
- ```
+Yes, the devlake helm chart supports using an external Grafana. You can set
the following values while installing from helm:
+
+- `grafana.useExternal`: this should be `true`
+- `grafana.externalUrl`: use your Grafana's URL, e.g.
`https://grafana.example.com`
+
+Here is the example:
+
+```
+helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+helm repo update
+helm install devlake devlake/devlake \
+ --set grafana.useExternal=true \
+ --set grafana.externalUrl=https://grafana.example.com
+```
## Troubleshooting
