-
Notifications
You must be signed in to change notification settings - Fork 787
/
diagnose.go
291 lines (254 loc) · 7.66 KB
/
diagnose.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
package cmd
import (
"fmt"
"github.com/jenkins-x/jx/v2/pkg/table"
"github.com/jenkins-x/jx/v2/pkg/util/system"
"k8s.io/client-go/kubernetes"
"github.com/jenkins-x/jx/v2/pkg/cmd/templates"
"github.com/jenkins-x/jx/v2/pkg/cmd/helper"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts"
"github.com/jenkins-x/jx/v2/pkg/cmd/version"
"github.com/jenkins-x/jx/v2/pkg/health"
"github.com/pkg/errors"
"github.com/jenkins-x/jx-logging/pkg/log"
"github.com/jenkins-x/jx/v2/pkg/util"
"github.com/spf13/cobra"
)
func getValidArgs() []string {
return []string{"", "version", "status", "pvc", "pods", "ingresses", "secrets", "configmaps", "health"}
}
var jxDiagnoseExample = templates.Examples(fmt.Sprintf(`
# To print diagnostic information about pods in n1 namespace
jx diagnose pods -n n1
Supported arguments to diagnose are %v
Deprecated usage:
# To print all information
jx diagnose
#To print specific resource information
jx diagnose --show=pods --show=version
`, getValidArgs()))
// DiagnoseOptions struct contains the diagnose flags
type DiagnoseOptions struct {
*opts.CommonOptions
Namespace string
HelmTLS bool
//Deprecated
Show []string
Runner util.Commander
}
//NewCmdDiagnose creates the diagnose command
func NewCmdDiagnose(commonOpts *opts.CommonOptions) *cobra.Command {
options := &DiagnoseOptions{
CommonOptions: commonOpts,
}
cmd := &cobra.Command{
Use: "diagnose ARG",
Short: "Print diagnostic information about the Jenkins X installation",
Example: jxDiagnoseExample,
ValidArgs: getValidArgs(),
//Todo: This will be removed by cobra.ExactValidArgs(1) after --show flag is removed
Args: cobra.OnlyValidArgs,
Run: func(cmd *cobra.Command, args []string) {
path, err := util.JXBinLocation()
helper.CheckErr(err)
runner := &util.Command{
Name: fmt.Sprintf("%s/kubectl", path),
}
options.Runner = runner
options.Cmd = cmd
options.Args = args
err = options.Run()
helper.CheckErr(err)
},
}
cmd.Flags().StringVarP(&options.Namespace, "namespace", "n", "", "The namespace to display the kube resources from. If left out, defaults to the current namespace")
cmd.Flags().StringArrayVarP(&options.Show, "show", "", []string{"version", "status", "pvc", "pods", "ingresses", "secrets", "configmaps"}, "Determine what information to diagnose")
cmd.Flags().BoolVarP(&options.HelmTLS, "helm-tls", "", false, "Whether to use TLS with helm")
_ = cmd.Flags().MarkDeprecated("show", "use jx diagnose <object> instead. This will be removed on July 1, 2020")
return cmd
}
// Run implements the diagnose command
func (o *DiagnoseOptions) Run() error {
// Get the namespace to run the diagnostics in, and output it
kubeClient, ns, err := o.KubeClientAndDevNamespace()
if err != nil {
return errors.Wrap(err, "failed to create kubeClient")
}
log.Logger().Infof("Running in namespace: %s", util.ColorInfo(ns))
_, table := o.GetPackageVersions(ns, o.HelmTLS)
// os version
osVersion, err := o.GetOsVersion()
if err != nil {
log.Logger().Warnf("Failed to get OS version: %s", err)
} else {
table.AddRow("Operating System", util.ColorInfo(osVersion))
}
switch len(o.Args) {
//ToDo: This wont be required after the deprecated --show flag is removed
case 0:
err = runDeprecatedShow(o, table, kubeClient, ns)
if err != nil {
return err
}
case 1:
if o.showInfo("version") {
err := version.NewCmdVersion(o.CommonOptions).Execute()
if err != nil {
return err
}
// Render system level information
table.Render()
}
if o.showInfo("status") {
err := NewCmdStatus(o.CommonOptions).Execute()
if err != nil {
return err
}
}
if o.showInfo("pvc") {
err := printStatus(o, "Kubernetes PVCs", "kubectl", "get", "pvc", "--namespace", ns)
if err != nil {
return err
}
}
if o.showInfo("pods") {
err := printStatus(o, "Kubernetes Pods", "kubectl", "get", "po", "--namespace", ns)
if err != nil {
return err
}
}
if o.showInfo("ingresses") {
err := printStatus(o, "Kubernetes Ingresses", "kubectl", "get", "ingress", "--namespace", ns)
if err != nil {
return err
}
}
if o.showInfo("secrets") {
err := printStatus(o, "Kubernetes Secrets", "kubectl", "get", "secrets", "--namespace", ns)
if err != nil {
return err
}
}
if o.showInfo("configmaps") {
err := printStatus(o, "Kubernetes Configmaps", "kubectl", "get", "configmaps", "--namespace", ns)
if err != nil {
return err
}
}
if o.showInfo("health") {
err = health.Kuberhealthy(kubeClient, ns)
if err != nil {
return err
}
}
//ToDo: This wont be required after the deprecated --show flag is removed
default:
return errors.New("Only one argument is allowed")
}
log.Logger().Info("\nPlease visit https://jenkins-x.io/faq/issues/ for any known issues.")
log.Logger().Info("\nFinished printing diagnostic information.")
return nil
}
// Run the specified command (jx status, kubectl get po, etc) and print its output
func printStatus(o *DiagnoseOptions, header string, command string, options ...string) error {
o.Runner.SetArgs(options)
output, err := o.Runner.RunWithoutRetry()
if err != nil {
log.Logger().Errorf("Unable to get the %s", header)
return err
}
// Print the output of the command, and add a little header at the top for formatting / readability
log.Logger().Infof("\n%s:\n%s", header, util.ColorInfo(output))
return nil
}
// Deprecated
func (o *DiagnoseOptions) showOption(e string) bool {
for _, a := range o.Show {
if a == e {
return true
}
}
return false
}
func (o *DiagnoseOptions) showInfo(e string) bool {
for _, a := range o.Args {
if a == e {
return true
}
}
return false
}
// GetOsVersion returns a human friendly string of the current OS
// in the case of an error this still returns a valid string for the details that can be found.
func (o *DiagnoseOptions) GetOsVersion() (string, error) {
return system.GetOsVersion()
}
//Deprecated
func runDeprecatedShow(o *DiagnoseOptions, table table.Table, kubeClient kubernetes.Interface, ns string) error {
if o.showOption("version") {
versionCmd := version.NewCmdVersion(o.CommonOptions)
// Ugly hack to prevent --show flag from being passed to the version command
versionCmd.SetArgs([]string{})
err := versionCmd.Execute()
if err != nil {
return err
}
// Render system level information
table.Render()
return nil
}
if o.showOption("status") {
statusCmd := NewCmdStatus(o.CommonOptions)
// Ugly hack to prevent --show flag from being passed to the status command
statusCmd.SetArgs([]string{})
err := statusCmd.Execute()
if err != nil {
return err
}
return nil
}
if o.showOption("pvc") {
err := printStatus(o, "Kubernetes PVCs", "kubectl", "get", "pvc", "--namespace", ns)
if err != nil {
return err
}
return nil
}
if o.showOption("pods") {
err := printStatus(o, "Kubernetes Pods", "kubectl", "get", "po", "--namespace", ns)
if err != nil {
return err
}
return nil
}
if o.showOption("ingresses") {
err := printStatus(o, "Kubernetes Ingresses", "kubectl", "get", "ingress", "--namespace", ns)
if err != nil {
return err
}
return nil
}
if o.showOption("secrets") {
err := printStatus(o, "Kubernetes Secrets", "kubectl", "get", "secrets", "--namespace", ns)
if err != nil {
return err
}
return nil
}
if o.showOption("configmaps") {
err := printStatus(o, "Kubernetes Configmaps", "kubectl", "get", "configmaps", "--namespace", ns)
if err != nil {
return err
}
return nil
}
if o.showOption("health") {
err := health.Kuberhealthy(kubeClient, ns)
if err != nil {
return err
}
return nil
}
// Handle error if unsupported show option is passed
return errors.New(fmt.Sprintf("Unsupported show option: %v", o.Show))
}