From 8d259d8275170901e267beb8aff3da84e49a211f Mon Sep 17 00:00:00 2001 From: 1gtm <1gtm@appscode.com> Date: Tue, 27 Feb 2024 09:37:43 +0000 Subject: [PATCH] Update docs for kubedb/cli@6980c711 Signed-off-by: 1gtm <1gtm@appscode.com> --- .../cli/kubectl-dba_monitor_check-connection.md | 2 +- docs/reference/cli/kubectl-dba_monitor_dashboard.md | 9 ++++++--- docs/reference/cli/kubectl-dba_monitor_get-alerts.md | 2 +- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/reference/cli/kubectl-dba_monitor_check-connection.md b/docs/reference/cli/kubectl-dba_monitor_check-connection.md index fd8871cb06..170d31f0bb 100644 --- a/docs/reference/cli/kubectl-dba_monitor_check-connection.md +++ b/docs/reference/cli/kubectl-dba_monitor_check-connection.md @@ -24,7 +24,7 @@ kubectl-dba monitor check-connection ``` kubectl dba monitor check-connection [DATABASE] [DATABASE_NAME] -n [NAMESPACE] \ - --prom-svc=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] + --prom-svc-name=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] # Check connection status for different targets with prometheus server for a specific postgres database kubectl dba monitor check-connection mongodb sample_mg -n demo \ diff --git a/docs/reference/cli/kubectl-dba_monitor_dashboard.md b/docs/reference/cli/kubectl-dba_monitor_dashboard.md index 2a23c9f957..63d3454333 100644 --- a/docs/reference/cli/kubectl-dba_monitor_dashboard.md +++ b/docs/reference/cli/kubectl-dba_monitor_dashboard.md @@ -23,11 +23,13 @@ kubectl-dba monitor dashboard ### Examples ``` - kubectl dba monitor dashboard [DATABASE] [DASHBOARD_NAME] \ - --prom-svc=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] + kubectl dba monitor dashboard [DATABASE] [DATABASE_NAME] -n [NAMESPACE] \ + [DASHBOARD_NAME] --file=[FILE_CONTAINING_DASHBOARD_JSON] \ + --prom-svc-name=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] # Check availability of a postgres grafana dashboard - kubectl-dba monitor dashboard postgres postgres_databases_dashboard \ + kubectl-dba monitor dashboard postgres pg15 -n demo \ + --file=/home/arnob/yamls/summary.json \ --prom-svc-name=prometheus-kube-prometheus-prometheus --prom-svc-namespace=monitoring --prom-svc-port=9090 Valid dashboards include: @@ -46,6 +48,7 @@ kubectl-dba monitor dashboard ``` -b, --branch string branch name of the github repo (default "master") + -f, --file string absolute or relative path of the file containing dashboard -h, --help help for dashboard ``` diff --git a/docs/reference/cli/kubectl-dba_monitor_get-alerts.md b/docs/reference/cli/kubectl-dba_monitor_get-alerts.md index e55b500e84..8be6f7db7c 100644 --- a/docs/reference/cli/kubectl-dba_monitor_get-alerts.md +++ b/docs/reference/cli/kubectl-dba_monitor_get-alerts.md @@ -24,7 +24,7 @@ kubectl-dba monitor get-alerts ``` kubectl dba monitor get-alerts [DATABASE] [DATABASE_NAME] -n [NAMESPACE] \ - --prom-svc=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] + --prom-svc-name=[PROM_SVC_NAME] --prom-svc-namespace=[PROM_SVC_NS] --prom-svc-port=[PROM_SVC_PORT] # Get triggered alert for a specific mongodb kubectl dba monitor get-alerts mongodb sample-mongodb -n demo \