You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2022/07/29 18:53:35 UTC
[incubator-devlake-website] branch main updated: docs: minor style fix to k8s doc (#143)
This is an automated email from the ASF dual-hosted git repository.
hez 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 d37f8292 docs: minor style fix to k8s doc (#143)
d37f8292 is described below
commit d37f82927626b5ffcb5d97f8f2c5a60b9b9e67db
Author: Hezheng Yin <he...@merico.dev>
AuthorDate: Fri Jul 29 11:53:31 2022 -0700
docs: minor style fix to k8s doc (#143)
---
docs/QuickStart/KubernetesSetup.md | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/docs/QuickStart/KubernetesSetup.md b/docs/QuickStart/KubernetesSetup.md
index 6e7bd72a..b074dfa0 100644
--- a/docs/QuickStart/KubernetesSetup.md
+++ b/docs/QuickStart/KubernetesSetup.md
@@ -37,13 +37,14 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak
## FAQ
1. Can I use a managed Cloud database service instead of running database in docker?
- Yes, it only takes a few changes in the sample yaml file to make it happen. Below we'll use MySQL on AWS RDS as an example.
- 1. (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
- 2. Remove the `mysql` deployment and service sections from `k8s-deploy.yaml`
- 3. Update `devlake-config` configmap according to your RDS instance setup:
- * `MYSQL_ROOT_PASSWORD`: remove this line
- * `MYSQL_USER`: use your RDS instance's master username
- * `MYSQL_PASSWORD`: use your RDS instance's password
- * `MYSQL_DATABASE`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`
- * `MYSQL_URL`: set this for `grafana` in `$HOST:$PORT` format, where $HOST and $PORT should be your RDS instance's endpoint and port respectively
- * `DB_URL`: update the connection string with your RDS instance's info for `devlake`
+
+ Yes, it only takes a few changes in the sample yaml file. Below we'll use MySQL on AWS RDS as an example.
+ 1. (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
+ 2. Remove the `mysql` deployment and service sections from `k8s-deploy.yaml`
+ 3. Update `devlake-config` configmap according to your RDS instance setup:
+ * `MYSQL_ROOT_PASSWORD`: remove this line
+ * `MYSQL_USER`: use your RDS instance's master username
+ * `MYSQL_PASSWORD`: use your RDS instance's password
+ * `MYSQL_DATABASE`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`
+ * `MYSQL_URL`: set this for `grafana` in `$HOST:$PORT` format, where $HOST and $PORT should be your RDS instance's endpoint and port respectively
+ * `DB_URL`: update the connection string with your RDS instance's info for `devlake`