mirror of
https://github.com/replicatedhq/troubleshoot.git
synced 2026-04-15 07:16:34 +00:00
977fc438ea
* Add collect command and remote host collectors
Adds the ability to run a host collector on a set of remote k8s nodes.
Target nodes can be filtered using the --selector flag, with the same
syntax as kubectl. Existing flags for --collector-image,
--collector-pullpolicy and --request-timeout are used. To run on a
specified node, --selector="kubernetes.io/hostname=kind-worker2" could
be used.
The collect command is used by the remote collector to output the
results using a "raw" format, which uses the filename as the key, and
the value the output as a escaped json string. When run manually it
defaults to fully decoded json. The existing block devices,
ipv4interfaces and services host collectors don't decode properly - the
fix is to convert their slice output to a map (fix not included as
unsure what depends on the existing format).
The collect command is also useful for troubleshooting preflight issues.
Examples are included to show remote collector usage.
```
bin/collect --collector-image=croomes/troubleshoot:latest examples/collect/remote/memory.yaml --namespace test
{
"kind-control-plane": {
"system/memory.json": {
"total": 1304207360
}
},
"kind-worker": {
"system/memory.json": {
"total": 1695780864
}
},
"kind-worker2": {
"system/memory.json": {
"total": 1726353408
}
}
}
```
The preflight command has been updated to run remote collectors. To run
a host collector remotely it must be specified in the spec as a
`remoteCollector`:
```
apiVersion: troubleshoot.sh/v1beta2
kind: HostPreflight
metadata:
name: memory
spec:
remoteCollectors:
- memory:
collectorName: memory
analyzers:
- memory:
outcomes:
- fail:
when: "< 8Gi"
message: At least 8Gi of memory is required
- warn:
when: "< 32Gi"
message: At least 32Gi of memory is recommended
- pass:
message: The system has as sufficient memory
```
Results for each node are analyzed separately, with the node name
appended to the title:
```
bin/preflight --interactive=false --collector-image=croomes/troubleshoot:latest examples/preflight/remote/memory.yaml --format=json
{memory running 0 1}
{memory completed 1 1}
{
"fail": [
{
"title": "Amount of Memory (kind-worker2)",
"message": "At least 8Gi of memory is required"
},
{
"title": "Amount of Memory (kind-worker)",
"message": "At least 8Gi of memory is required"
},
{
"title": "Amount of Memory (kind-control-plane)",
"message": "At least 8Gi of memory is required"
}
]
}
```
Also added a host collector to allow preflight checks of required kernel
modules, which is the main driver for this change.
80 lines
3.4 KiB
Modula-2
80 lines
3.4 KiB
Modula-2
module github.com/replicatedhq/troubleshoot
|
|
|
|
go 1.12
|
|
|
|
require (
|
|
github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46 // indirect
|
|
github.com/ahmetalpbalkan/go-cursor v0.0.0-20131010032410-8136607ea412
|
|
github.com/blang/semver v3.5.1+incompatible
|
|
github.com/chzyer/logex v1.1.11-0.20160617073814-96a4d311aa9b // indirect
|
|
github.com/containers/image/v5 v5.10.4
|
|
github.com/docker/distribution v2.7.1+incompatible
|
|
github.com/docker/spdystream v0.0.0-20181023171402-6480d4af844c // indirect
|
|
github.com/elazarl/goproxy v0.0.0-20191011121108-aa519ddbe484 // indirect
|
|
github.com/emicklei/go-restful v2.9.6+incompatible // indirect
|
|
github.com/fatih/color v1.12.0
|
|
github.com/go-ole/go-ole v1.2.5 // indirect
|
|
github.com/go-openapi/spec v0.19.4 // indirect
|
|
github.com/go-redis/redis/v7 v7.2.0
|
|
github.com/go-sql-driver/mysql v1.5.0
|
|
github.com/gobwas/glob v0.2.3
|
|
github.com/godbus/dbus v4.1.0+incompatible
|
|
github.com/google/go-cmp v0.5.6 // indirect
|
|
github.com/google/gofuzz v1.1.0
|
|
github.com/hashicorp/go-getter v1.3.1-0.20190627223108-da0323b9545e
|
|
github.com/hashicorp/go-multierror v1.1.1
|
|
github.com/kr/text v0.2.0 // indirect
|
|
github.com/lib/pq v1.3.0
|
|
github.com/longhorn/longhorn-manager v1.1.1
|
|
github.com/manifoldco/promptui v0.8.0
|
|
github.com/mattn/go-isatty v0.0.12
|
|
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
|
|
github.com/onsi/gomega v1.14.0 // indirect
|
|
github.com/pkg/errors v0.9.1
|
|
github.com/replicatedhq/termui/v3 v3.1.1-0.20200811145416-f40076d26851
|
|
github.com/segmentio/ksuid v1.0.3
|
|
github.com/shirou/gopsutil v3.21.1+incompatible
|
|
github.com/spf13/cobra v1.2.1
|
|
github.com/spf13/pflag v1.0.5
|
|
github.com/spf13/viper v1.8.1
|
|
github.com/stretchr/testify v1.7.0
|
|
github.com/tj/go-spin v1.1.0
|
|
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
|
|
golang.org/x/tools v0.1.5 // indirect
|
|
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
|
|
gopkg.in/yaml.v2 v2.4.0
|
|
k8s.io/api v0.22.2
|
|
k8s.io/apiextensions-apiserver v0.22.2
|
|
k8s.io/apimachinery v0.22.2
|
|
k8s.io/apiserver v0.22.2
|
|
k8s.io/cli-runtime v0.20.2
|
|
k8s.io/client-go v0.20.2
|
|
sigs.k8s.io/controller-runtime v0.8.3
|
|
)
|
|
|
|
replace (
|
|
github.com/longhorn/longhorn-manager => github.com/replicatedhq/longhorn-manager v1.1.2-0.20210622201804-05b01947b99d
|
|
k8s.io/api => k8s.io/api v0.20.2
|
|
k8s.io/apiextensions-apiserver => k8s.io/apiextensions-apiserver v0.20.2
|
|
k8s.io/apimachinery => k8s.io/apimachinery v0.20.2
|
|
k8s.io/apiserver => k8s.io/apiserver v0.20.2
|
|
k8s.io/cli-runtime => k8s.io/cli-runtime v0.20.2
|
|
k8s.io/client-go => k8s.io/client-go v0.20.2
|
|
k8s.io/cloud-provider => k8s.io/cloud-provider v0.20.2
|
|
k8s.io/cluster-bootstrap => k8s.io/cluster-bootstrap v0.20.2
|
|
k8s.io/code-generator => k8s.io/code-generator v0.20.2
|
|
k8s.io/component-base => k8s.io/component-base v0.20.2
|
|
k8s.io/cri-api => k8s.io/cri-api v0.20.2
|
|
k8s.io/csi-translation-lib => k8s.io/csi-translation-lib v0.20.2
|
|
k8s.io/kube-aggregator => k8s.io/kube-aggregator v0.20.2
|
|
k8s.io/kube-controller-manager => k8s.io/kube-controller-manager v0.20.2
|
|
k8s.io/kube-proxy => k8s.io/kube-proxy v0.20.2
|
|
k8s.io/kube-scheduler => k8s.io/kube-scheduler v0.20.2
|
|
k8s.io/kubectl => k8s.io/kubectl v0.20.2
|
|
k8s.io/kubelet => k8s.io/kubelet v0.20.2
|
|
k8s.io/legacy-cloud-providers => k8s.io/legacy-cloud-providers v0.20.2
|
|
k8s.io/metrics => k8s.io/metrics v0.20.2
|
|
k8s.io/sample-apiserver => k8s.io/sample-apiserver v0.20.2
|
|
sigs.k8s.io/controller-runtime => github.com/kubernetes-sigs/controller-runtime v0.8.3
|
|
)
|