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.

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@a67dadc9 #604

Merged
merged 1 commit into from
Jan 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/reference/cli/kubectl-dba.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ kubectl-dba [flags]

* [kubectl-dba completion](/docs/reference/cli/kubectl-dba_completion.md) - Generate completion script
* [kubectl-dba connect](/docs/reference/cli/kubectl-dba_connect.md) - Connect to a database.
* [kubectl-dba dashboard](/docs/reference/cli/kubectl-dba_dashboard.md) - Check availability of a grafana dashboard
* [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database
* [kubectl-dba debug](/docs/reference/cli/kubectl-dba_debug.md) - Debug any Database issue
* [kubectl-dba describe](/docs/reference/cli/kubectl-dba_describe.md) - Show details of a specific resource or group of resources
Expand Down
78 changes: 78 additions & 0 deletions docs/reference/cli/kubectl-dba_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: Kubectl-Dba Dashboard
menu:
docs_{{ .version }}:
identifier: kubectl-dba-dashboard
name: Kubectl-Dba Dashboard
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba dashboard

Check availability of a grafana dashboard

### Synopsis

Check availability of metrics in prometheus server used in a grafana dashboard.

```
kubectl-dba dashboard
```

### Examples

```
# Check availability of mongodb-summary-dashboard grafana dashboard of mongodb
kubectl dba dashboard mongodb mongodb-summary-dashboard

Valid dashboards include:
* elasticsearch
* mongodb
* mariadb
* mysql
* postgres
* redis
```

### Options

```
-b, --branch string branch name of the github repo (default "master")
-h, --help help for dashboard
--prom-svc-name string name of the prometheus service
--prom-svc-namespace string namespace of the prometheus service
--prom-svc-port int port of the prometheus service (default 9090)
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "/home/runner/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--default-seccomp-profile-type string Default seccomp profile
--disable-compression If true, opt-out of response compression for all requests to the server
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
```

### SEE ALSO

* [kubectl-dba](/docs/reference/cli/kubectl-dba.md) - kubectl plugin for KubeDB

Loading