-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: 1gtm <[email protected]>
- Loading branch information
Showing
5 changed files
with
209 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: Kubectl-Dba Monitor | ||
| menu: | ||
| docs_{{ .version }}: | ||
| identifier: kubectl-dba-monitor | ||
| name: Kubectl-Dba Monitor | ||
| parent: reference-cli | ||
| menu_name: docs_{{ .version }} | ||
| section_menu_id: reference | ||
| --- | ||
| ## kubectl-dba monitor | ||
|
|
||
| Monitoring related commands for a database | ||
|
|
||
| ### Synopsis | ||
|
|
||
| All monitoring related commands from AppsCode. | ||
|
|
||
| ``` | ||
| kubectl-dba monitor | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| ``` | ||
| # Check triggered alerts for a specific database | ||
| kubectl dba monitor get-alerts [DATABASE] [DATABASE_NAME] -n [NAMESPACE] | ||
| # Check availability of grafana dashboard of a database | ||
| kubectl dba monitor dashboard [DATABASE] [DASHBOARD_NAME] | ||
| # Check connection status of target with prometheus server for a specific database | ||
| kubectl dba monitor check-connection [DATABASE] [DATABASE_NAME] -n [NAMESPACE] | ||
| # Common Flags | ||
| --prom-svc-name : name of the prometheus service | ||
| --prom-svc-namespace : namespace of the prometheus service | ||
| --prom-svc-port : port of the prometheus service | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for monitor | ||
| --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 | ||
| * [kubectl-dba monitor check-connection](/docs/reference/cli/kubectl-dba_monitor_check-connection.md) - Check connection status of prometheus targets with server | ||
| * [kubectl-dba monitor dashboard](/docs/reference/cli/kubectl-dba_monitor_dashboard.md) - Check availability of a grafana dashboard | ||
| * [kubectl-dba monitor get-alerts](/docs/reference/cli/kubectl-dba_monitor_get-alerts.md) - Alerts associated with a database | ||
|
|
84 changes: 84 additions & 0 deletions
84
docs/reference/cli/kubectl-dba_monitor_check-connection.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| title: Kubectl-Dba Monitor Check-Connection | ||
| menu: | ||
| docs_{{ .version }}: | ||
| identifier: kubectl-dba-monitor-check-connection | ||
| name: Kubectl-Dba Monitor Check-Connection | ||
| parent: reference-cli | ||
| menu_name: docs_{{ .version }} | ||
| section_menu_id: reference | ||
| --- | ||
| ## kubectl-dba monitor check-connection | ||
|
|
||
| Check connection status of prometheus targets with server | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Check connection status for different targets with prometheus server for specific DB. | ||
|
|
||
| ``` | ||
| kubectl-dba monitor check-connection | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| ``` | ||
| 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] | ||
| # Check connection status for different targets with prometheus server for a specific postgres database | ||
| kubectl dba monitor check-connection mongodb sample_mg -n demo \ | ||
| --prom-svc-name=prometheus-kube-prometheus-prometheus --prom-svc-namespace=monitoring --prom-svc-port=9090 | ||
| Valid resource types include: | ||
| * elasticsearch | ||
| * kafka | ||
| * mariadb | ||
| * mongodb | ||
| * mysql | ||
| * perconaxtradb | ||
| * postgres | ||
| * proxysql | ||
| * redis | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for check-connection | ||
| ``` | ||
|
|
||
| ### 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 | ||
| --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) | ||
| --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 monitor](/docs/reference/cli/kubectl-dba_monitor.md) - Monitoring related commands for a database | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters