mirror of
https://github.com/percona/percona-toolkit.git
synced 2025-09-11 21:51:21 +00:00
PT-1865 Update readme, rename tool
This commit is contained in:
@@ -1,42 +0,0 @@
|
|||||||
#Debug collector tool
|
|
||||||
|
|
||||||
Collects data for debugging from a k8s/opeshift cluster and creates a tar.gz archive with it.
|
|
||||||
Archive name will be "cluster-dump.tar.gz" and it will be saved in the same location where you will run tool
|
|
||||||
|
|
||||||
###Data that will be collected
|
|
||||||
"pods",
|
|
||||||
"replicasets",
|
|
||||||
"deployments",
|
|
||||||
"statefulsets",
|
|
||||||
"replicationcontrollers",
|
|
||||||
"events",
|
|
||||||
"configmaps",
|
|
||||||
"secrets",
|
|
||||||
"cronjobs",
|
|
||||||
"jobs",
|
|
||||||
"podsecuritypolicies",
|
|
||||||
"poddisruptionbudgets",
|
|
||||||
"perconaxtradbbackups",
|
|
||||||
"perconaxtradbclusterbackups",
|
|
||||||
"perconaxtradbclusterrestores",
|
|
||||||
"perconaxtradbclusters",
|
|
||||||
"clusterrolebindings",
|
|
||||||
"clusterroles",
|
|
||||||
"rolebindings",
|
|
||||||
"roles",
|
|
||||||
"storageclasses",
|
|
||||||
"persistentvolumeclaims",
|
|
||||||
"persistentvolumes",
|
|
||||||
"modes",
|
|
||||||
"pxc/psmdb" (depend on 'resource' flag)
|
|
||||||
|
|
||||||
|
|
||||||
###Usage
|
|
||||||
Tool accept 3 flags:
|
|
||||||
1) resource: name of required custom resource ("pxc" is default)
|
|
||||||
2) namespace: namespace from where you need to collect data. If empty data will be collected from all namespaces
|
|
||||||
3) cluster: name for exact pxc/psmdb cluster. If empty tool will collect all "resource"
|
|
||||||
|
|
||||||
###Requirements
|
|
||||||
Installed and configured 'kubectl' is needed for work
|
|
||||||
|
|
42
src/go/k8s-debug-collector/README.md
Normal file
42
src/go/k8s-debug-collector/README.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
### Data that will be collected
|
||||||
|
"pods",
|
||||||
|
"replicasets",
|
||||||
|
"deployments",
|
||||||
|
"statefulsets",
|
||||||
|
"replicationcontrollers",
|
||||||
|
"events",
|
||||||
|
"configmaps",
|
||||||
|
"secrets",
|
||||||
|
"cronjobs",
|
||||||
|
"jobs",
|
||||||
|
"podsecuritypolicies",
|
||||||
|
"poddisruptionbudgets",
|
||||||
|
"perconaxtradbbackups",
|
||||||
|
"perconaxtradbclusterbackups",
|
||||||
|
"perconaxtradbclusterrestores",
|
||||||
|
"perconaxtradbclusters",
|
||||||
|
"clusterrolebindings",
|
||||||
|
"clusterroles",
|
||||||
|
"rolebindings",
|
||||||
|
"roles",
|
||||||
|
"storageclasses",
|
||||||
|
"persistentvolumeclaims",
|
||||||
|
"persistentvolumes",
|
||||||
|
"modes",
|
||||||
|
"your-custom-resource" (depend on 'resource' flag)
|
||||||
|
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
`k8s-debug-collector <flags>`
|
||||||
|
Flags:
|
||||||
|
`--resource` targeted custom resource name (default "pxc")
|
||||||
|
`--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
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
Installed and configured 'kubectl' is needed for work
|
||||||
|
|
@@ -5,7 +5,7 @@ import (
|
|||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
"github.com/percona/percona-toolkit/src/go/debug-collector/dumper"
|
"github.com/percona/percona-toolkit/src/go/k8s-debug-collector/dumper"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
Reference in New Issue
Block a user