diff --git a/docs/install-and-deploy/deploy-obagent-with-obd.md b/docs/install-and-deploy/deploy-obagent-with-obd.md index cf3d113270558df3be184a62dcdc02db6a320d1d..38341cc2c2b40d2b4d730ae7db22649c3ab2bdf4 100644 --- a/docs/install-and-deploy/deploy-obagent-with-obd.md +++ b/docs/install-and-deploy/deploy-obagent-with-obd.md @@ -24,11 +24,11 @@ obagent: > **注æ„**:`servers` å—段必须与 oceanbase-ce çš„ `servers` å—段一致。 -详细信æ¯ï¼Œå‚考 [é…置文件](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/distributed-with-obproxy-and-obagent-example.yaml)。 +详细信æ¯ï¼Œè¯·å‚考 [é…置文件](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/distributed-with-obproxy-and-obagent-example.yaml)。 ## å•ç‹¬éƒ¨ç½² OBAgent -OBD ä¸æ”¯æŒä¸ºå·²éƒ¨ç½²çš„é›†ç¾¤æ·»åŠ æ–°çš„ç»„ä»¶ã€‚å¦‚æžœæ‚¨å¸Œæœ›ä¸ºè¦å·²éƒ¨ç½²çš„集群é…ç½® OBAgent,您需è¦å•ç‹¬éƒ¨ç½² OBAgent。è¦å•ç‹¬éƒ¨ç½² OBAgent,您需è¦å‡†å¤‡ OBAgent çš„é…置文件。请确ä¿é…置文件ä¸çš„以下å—段与 OceanBase æ•°æ®åº“相åŒï¼š +OBD ä¸æ”¯æŒä¸ºå·²éƒ¨ç½²çš„é›†ç¾¤æ·»åŠ æ–°çš„ç»„ä»¶ã€‚å¦‚æžœæ‚¨å¸Œæœ›ä¸ºè¦å·²éƒ¨ç½²çš„集群é…ç½® OBAgent,您需è¦å•ç‹¬éƒ¨ç½² OBAgent。若è¦å•ç‹¬éƒ¨ç½² OBAgent,您需è¦å‡†å¤‡ OBAgent çš„é…置文件。请确ä¿é…置文件ä¸çš„以下å—段与 OceanBase æ•°æ®åº“相åŒï¼š ```yaml obagent: @@ -60,7 +60,7 @@ obagent: # Monitor status for OceanBase Database. Active is to enable. Inactive is to disable. The default value is active. When you deploy an cluster automatically, OBD decides whether to enable this parameter based on depends. ``` -更多信æ¯ï¼Œå‚考 [OBAgent é…置文件](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/obagent-only-example.yaml +更多信æ¯ï¼Œè¯·å‚考 [OBAgent é…置文件](https://github.com/oceanbase/obdeploy/blob/master/example/obagent/obagent-only-example.yaml )。 ## å¯åŠ¨ OBAgent @@ -74,13 +74,13 @@ obd cluster deploy <deploy name> [-c <yaml path>] [-f] [-U] [-A] obd cluster start <deploy name> [flags] ``` -更多信æ¯ï¼Œå‚考 [OBD 使用文档](https://github.com/oceanbase/obdeploy/blob/master/README-CN.md#obd-cluster-deploy)。 +更多信æ¯ï¼Œè¯·å‚考 [OBD 使用文档](https://github.com/oceanbase/obdeploy/blob/master/README-CN.md#obd-cluster-deploy)。 ## (å¯é€‰ï¼‰å¯åŠ¨ Prometheus > 说明:您需è¦å®‰è£… Prometheus。 -è¿è¡Œä»¥ä¸‹å‘½ä»¤ï¼Œå¯åŠ¨ Prometheus, obagent ä¸çš„é…置文件模版 obd å·²ç»è¿›è¡Œäº†æ›¿æ¢ï¼Œå¯ä»¥å¤åˆ¶è¯¥é…置文件到部署 Prometheus 的主机,然åŽç›´æŽ¥ä½¿ç”¨è¯¥é…置文件用如下命令å¯åŠ¨ prometheus : +OBD ä¼šæ›¿æ¢ OBAgent é…置文件模版ä¸çš„å˜é‡ï¼Œå¯ä»¥å¤åˆ¶è¯¥é…置文件(prometheus.yaml)到部署 Prometheus 的主机,然åŽæ‰§è¡Œå¦‚下命令使用 prometheus.yaml 文件å¯åŠ¨ Prometheus: ```bash ./prometheus --config.file=./prometheus.yaml @@ -90,7 +90,7 @@ obd cluster start <deploy name> [flags] - 下载并解压 Prometheus Alertmanager。 - å¯åŠ¨ Prometheus Alertmanager。 -- é…ç½® Prometheus Alertmanager。更多信æ¯ï¼Œå‚考 [Prometheus 文档](https://www.prometheus.io/docs/alerting/latest/configuration/)。 +- é…ç½® Prometheus Alertmanager。更多信æ¯ï¼Œè¯·å‚考 [Prometheus 文档](https://www.prometheus.io/docs/alerting/latest/configuration/)。 OBAgent æ供默认的报è¦é¡¹ï¼Œé…置文件ä½äºŽ `conf/prometheus_config/rules`。其ä¸ï¼Œ`host_rules.yaml` å˜å‚¨æœºå™¨æŠ¥è¦é¡¹ï¼Œ`ob_rules.yaml` å˜å‚¨ OceanBase æ•°æ®åº“报è¦é¡¹ã€‚如果默认报è¦é¡¹ä¸èƒ½æ»¡è¶³æ‚¨çš„需求,按照以下方å¼è‡ªå®šä¹‰æŠ¥è¦é¡¹ï¼š @@ -117,10 +117,10 @@ groups: ```bash ./bin/grafana-server ``` -- 登陆 grafana 并且修改密ç ,第一次登陆默认账å·å¯†ç 都是 admin。 +- 登陆 grafana 并且修改密ç ,第一次登陆默认账å·å’Œå¯†ç 都是 admin。 - é…ç½® prometheus 为数æ®æº, æ·»åŠ æ•°æ®æºçš„æ–¹å¼å‚考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/datasources/add-a-data-source/)。 -- 导入 dashboard, 针对 OB å’Œä¸»æœºæŒ‡æ ‡çš„é…置已ç»å‘布到grafana,id 分别为 15215, 15216, 导入 dashboard çš„æ–¹å¼å‚考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/)。 +- 导入 dashboard, 针对 OB å’Œä¸»æœºæŒ‡æ ‡çš„é…置已ç»å‘布到grafana,id 分别为 15215, 15216, 导入 dashboard çš„æ–¹å¼è¯·å‚考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/)。 ## (å¯é€‰ï¼‰æ›´æ–° KV é…ç½® -è¦æ›´æ–° KV é…置,请使用 `obd cluster edit-config`。详细信æ¯ï¼Œå‚考 [OBD 使用文档](https://github.com/oceanbase/obdeploy/blob/master/README-CN.md#obd-cluster-edit-config)。 +è¦æ›´æ–° KV é…置,请使用 `obd cluster edit-config`。详细信æ¯ï¼Œè¯·å‚考 [OBD 使用文档](https://github.com/oceanbase/obdeploy/blob/master/README-CN.md#obd-cluster-edit-config)。