Update README.md

Formatting, spelling
This commit is contained in:
PaulJacobs-percona
2021-01-07 09:20:12 +03:00
committed by GitHub
parent 5c8a8bdda6
commit 77d2025a5a

View File

@@ -1,8 +1,10 @@
# Debug collector tool # Debug collector tool
Collects debug data (logs, resource statuses etc.) from a k8s/opeshift cluster. Data packed into "cluster-dump.tar.gz" archive in the current working directory. Collects debug data (logs, resource statuses etc.) from a k8s/OpenShift cluster. Data is packed into the `cluster-dump.tar.gz` archive in the current working directory.
### Data that will be collected ## Data that will be collected
```
"pods", "pods",
"replicasets", "replicasets",
"deployments", "deployments",
@@ -27,18 +29,23 @@ Collects debug data (logs, resource statuses etc.) from a k8s/opeshift cluster.
"persistentvolumeclaims", "persistentvolumeclaims",
"persistentvolumes", "persistentvolumes",
"modes", "modes",
"your-custom-resource" (depend on 'resource' flag) "your-custom-resource" (depends on 'resource' flag)
## Usage
### Usage
`pt-k8s-debug-collector <flags>` `pt-k8s-debug-collector <flags>`
Flags: Flags:
`--resource` targeted custom resource name (default "pxc") `--resource` targeted custom resource name (default "pxc")
`--namespace` targeted namespace. By default data will be collected from all namespaces `--namespace` targeted namespace. By default data will be collected from all namespaces
`--cluster` targeted pxc/psmdb cluster. By default data from all available clusters to be collected `--cluster` targeted pxc/psmdb cluster. By default data from all available clusters to be collected
### Requirements ## Requirements
Installed and configured 'kubectl'
Installed and configured 'pt-mysql-summary' - Installed and configured 'kubectl'
Installed and configured 'pt-mongodb-summary' - Installed and configured 'pt-mysql-summary'
- Installed and configured 'pt-mongodb-summary'