Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for kubedb/cli@6980c711 #612

Closed
wants to merge 1 commit into from
Closed

Update docs for kubedb/cli@6980c711 #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_monitor_check-connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
9 changes: 6 additions & 3 deletions docs/reference/cli/kubectl-dba_monitor_dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_monitor_get-alerts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
Loading