You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by wa...@apache.org on 2023/02/28 08:38:51 UTC
[incubator-devlake-website] 03/04: fix: updated phrasing
This is an automated email from the ASF dual-hosted git repository.
warren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 5888271028c3955b2f281b1519ebf0d2c5526004
Author: Yumeng Wang <yu...@merico.dev>
AuthorDate: Mon Feb 27 18:01:45 2023 +0800
fix: updated phrasing
---
.../version-v0.15/GettingStarted/HelmSetup.md | 24 +++++++++++-----------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
index 69539fb829..ea118bd0e5 100644
--- a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
@@ -40,8 +40,8 @@ kubectl port-forward service/devlake-grafana 30091:3000
```
Then you can visit:
-config-ui by url `http://YOUR-NODE-IP:30090`
-grafana by url `http://YOUR-NODE-IP:30091`
+Config UI URL `http://YOUR-NODE-IP:30090`
+Grafana URL `http://YOUR-NODE-IP:30091`
### Update
@@ -71,7 +71,7 @@ Conditions:
helm install devlake devlake/devlake --set service.uiPort=30000
```
-After deployed, visit devlake: http://192.168.0.6:30000
+After the deployment, visit devlake at: http://192.168.0.6:30000
### Deploy with Ingress
@@ -83,7 +83,7 @@ Conditions:
helm install devlake devlake/devlake --set "ingress.enabled=true,ingress.hostname=devlake.example.com"
```
-After deployed, visit devlake: http://devlake.example.com, and grafana at http://devlake.example.com/grafana
+After the deployment, visit devlake at: http://devlake.example.com, and grafana at http://devlake.example.com/grafana
### Deploy with Ingress (Https)
@@ -105,7 +105,7 @@ helm install devlake devlake/devlake \
--set "ingress.tlsSecretName=ssl-certificate"
```
-After deployed, visit devlake: https://devlake-0.example.com:8443, and grafana at https://devlake-0.example.com:8443/grafana
+After the deployment, visit devlake at: https://devlake-0.example.com:8443, and grafana at https://devlake-0.example.com:8443/grafana
## Parameters
@@ -155,8 +155,8 @@ Some useful parameters for the chart, you could also check them in values.yaml
| ui.basicAuth.password | The password for the basic auth | "admin" |
| service.type | Service type for exposed service | NodePort |
| service.uiPort | Node port for config ui | 32001 |
-| service.ingress.enabled | If enable ingress | false |
-| service.ingress.enableHttps | If enable https | false |
+| service.ingress.enabled | If ingress is enabled | false |
+| service.ingress.enableHttps | If https is enabled | false |
| service.ingress.className | Class name for ingressClass. leave empty for using default | "" |
| service.ingress.hostname | The hostname/domainname for ingress | localhost |
| service.ingress.prefix | The prefix for endpoints, currently not used | / |
@@ -167,11 +167,11 @@ Some useful parameters for the chart, you could also check them in values.yaml
| option.database | The database type, valids: mysql, pgsql | mysql |
## FAQ
-1. Can I use a managed Cloud database service instead of running database in docker?
+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.
- 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. Proviede below values while install from helm:
+ Yes, you can just set useExternal value to true while deploying devlake with helm chart. Below we will 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 would like to use an existing instance.
+ 2. Provide the following values while install from helm:
* `mysql.useExternal`: this should be `true`
* `mysql.externalServer`: use your RDS instance's IP address or domain name.
* `mysql.externalPort`: use your RDS instance's database port.
@@ -195,4 +195,4 @@ Some useful parameters for the chart, you could also check them in values.yaml
## Troubleshooting
-If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
+If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)