/
mustgather.go
331 lines (298 loc) · 9.25 KB
/
mustgather.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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
package mustgather
import (
"fmt"
"math/rand"
"path"
"time"
"github.com/spf13/cobra"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/cli-runtime/pkg/genericclioptions/printers"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
kcmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/scheme"
"k8s.io/kubernetes/pkg/kubectl/util/templates"
"github.com/openshift/client-go/image/clientset/versioned/typed/image/v1"
"github.com/openshift/origin/pkg/image/util"
"github.com/openshift/origin/pkg/oc/cli/rsync"
)
var (
mustGatherLong = templates.LongDesc(`
Launch a pod to gather debugging information
This command will launch a pod in a temporary namespace on your
cluster that gathers debugging information, using a copy of the active
client config context, and then downloads the gathered information.
Experimental: This command is under active development and may change without notice.
`)
mustGatherExample = templates.Examples(`
# gather default information using the default image and command, writing into ./must-gather.local.<rand>
oc adm must-gather
# gather default information with a specific local folder to copy to
oc adm must-gather --dest-dir=/local/directory
# gather default information using a specific image, command, and pod-dir
oc adm must-gather --image=my/image:tag --source-dir=/pod/directory -- myspecial-command.sh
`)
)
func NewMustGatherCommand(f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command {
o := NewMustGatherOptions(streams)
rsyncCommand := rsync.NewCmdRsync(rsync.RsyncRecommendedName, "", f, streams)
cmd := &cobra.Command{
Use: "must-gather",
Short: "Launch a new instance of a pod for gathering debug information",
Long: mustGatherLong,
Example: mustGatherExample,
Hidden: true,
Run: func(cmd *cobra.Command, args []string) {
kcmdutil.CheckErr(o.Complete(f, cmd, args))
kcmdutil.CheckErr(o.Run(rsyncCommand))
},
}
cmd.Flags().StringVar(&o.NodeName, "node-name", o.NodeName, "Set a specific node to use - by default a random master will be used")
cmd.Flags().StringVar(&o.Image, "image", o.Image, "Set a specific image to use, by default the OpenShift's must-gather image will be used.")
cmd.Flags().StringVar(&o.DestDir, "dest-dir", o.DestDir, "Set a specific directory on the local machine to write gathered data to.")
cmd.Flags().StringVar(&o.SourceDir, "source-dir", o.SourceDir, "Set the specific directory on the pod copy the gathered data from.")
cmd.Flags().BoolVar(&o.Keep, "keep", o.Keep, "Do not delete temporary resources when command completes.")
cmd.Flags().MarkHidden("keep")
return cmd
}
func NewMustGatherOptions(streams genericclioptions.IOStreams) *MustGatherOptions {
return &MustGatherOptions{
SourceDir: "/must-gather/",
IOStreams: streams,
}
}
func (o *MustGatherOptions) Complete(f kcmdutil.Factory, cmd *cobra.Command, args []string) error {
if i := cmd.ArgsLenAtDash(); i != -1 && i < len(args) {
o.Command = args[i:]
} else {
o.Command = args
}
var err error
if o.Config, err = f.ToRESTConfig(); err != nil {
return err
}
if o.Client, err = kubernetes.NewForConfig(o.Config); err != nil {
return err
}
if len(o.DestDir) == 0 {
o.DestDir = fmt.Sprintf("must-gather.local.%06d", rand.Int63())
}
if len(o.Image) == 0 {
imageClient, err := v1.NewForConfig(o.Config)
if err != nil {
return err
}
imageStream, err := imageClient.ImageStreams("openshift").Get("must-gather", metav1.GetOptions{})
if err != nil {
return err
}
var ok bool
if o.Image, ok = util.ResolveLatestTaggedImage(imageStream, "latest"); !ok {
return fmt.Errorf("unable to to resolve must-gather image")
}
}
o.PrinterCreated, err = printers.NewTypeSetter(scheme.Scheme).WrapToPrinter(&printers.NamePrinter{Operation: "created"}, nil)
if err != nil {
return err
}
o.PrinterDeleted, err = printers.NewTypeSetter(scheme.Scheme).WrapToPrinter(&printers.NamePrinter{Operation: "deleted"}, nil)
if err != nil {
return err
}
o.RsyncRshCmd = rsync.DefaultRsyncRemoteShellToUse(cmd.Parent())
return nil
}
type MustGatherOptions struct {
genericclioptions.IOStreams
Config *rest.Config
Client kubernetes.Interface
NodeName string
DestDir string
SourceDir string
Image string
Command []string
Keep bool
RsyncRshCmd string
PrinterCreated printers.ResourcePrinter
PrinterDeleted printers.ResourcePrinter
}
// Run creates and runs a must-gather pod.d
func (o *MustGatherOptions) Run(rsyncCmd *cobra.Command) error {
if len(o.Image) == 0 {
return fmt.Errorf("missing an image")
}
var err error
// create namespace
ns, err := o.Client.CoreV1().Namespaces().Create(&corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "openshift-must-gather-",
Labels: map[string]string{
"openshift.io/run-level": "0",
},
Annotations: map[string]string{
"oc.openshift.io/command": "oc adm must-gather",
},
},
})
if err != nil {
return err
}
o.PrinterCreated.PrintObj(ns, o.Out)
if !o.Keep {
defer func() {
if err := o.Client.CoreV1().Namespaces().Delete(ns.Name, nil); err != nil {
fmt.Printf("%v", err)
return
}
o.PrinterDeleted.PrintObj(ns, o.Out)
}()
}
clusterRoleBinding, err := o.Client.RbacV1().ClusterRoleBindings().Create(o.newClusterRoleBinding(ns.Name))
if err != nil {
return err
}
o.PrinterCreated.PrintObj(clusterRoleBinding, o.Out)
if !o.Keep {
defer func() {
if err := o.Client.RbacV1().ClusterRoleBindings().Delete(clusterRoleBinding.Name, &metav1.DeleteOptions{}); err != nil {
fmt.Printf("%v", err)
return
}
o.PrinterDeleted.PrintObj(clusterRoleBinding, o.Out)
}()
}
// create pod
pod, err := o.Client.CoreV1().Pods(ns.Name).Create(o.newPod(o.NodeName))
if err != nil {
return err
}
// wait for pod to be running (gather has completed)
if err := o.waitForPodRunning(pod); err != nil {
return err
}
// copy the gathered files into the local destination dir
err = o.copyFilesFromPod(pod)
return err
}
func (o *MustGatherOptions) copyFilesFromPod(pod *corev1.Pod) error {
rsyncOptions := &rsync.RsyncOptions{
Namespace: pod.Namespace,
Source: &rsync.PathSpec{PodName: pod.Name, Path: path.Clean(o.SourceDir) + "/"},
ContainerName: "copy",
Destination: &rsync.PathSpec{PodName: "", Path: o.DestDir},
Client: o.Client,
Config: o.Config,
RshCmd: fmt.Sprintf("%s --namespace=%s", o.RsyncRshCmd, pod.Namespace),
IOStreams: o.IOStreams,
}
rsyncOptions.Strategy = rsync.NewDefaultCopyStrategy(rsyncOptions)
return rsyncOptions.RunRsync()
}
func (o *MustGatherOptions) waitForPodRunning(pod *corev1.Pod) error {
phase := pod.Status.Phase
err := wait.PollImmediate(time.Second, 10*time.Minute, func() (bool, error) {
var err error
if pod, err = o.Client.CoreV1().Pods(pod.Namespace).Get(pod.Name, metav1.GetOptions{}); err != nil {
return false, nil
}
phase = pod.Status.Phase
return phase != corev1.PodPending, nil
})
if err != nil {
return err
}
if phase != corev1.PodRunning {
return fmt.Errorf("pod is not running: %v", phase)
}
return nil
}
func (o *MustGatherOptions) newClusterRoleBinding(ns string) *rbacv1.ClusterRoleBinding {
return &rbacv1.ClusterRoleBinding{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "must-gather-",
Annotations: map[string]string{
"oc.openshift.io/command": "oc adm must-gather",
},
},
RoleRef: rbacv1.RoleRef{
APIGroup: "rbac.authorization.k8s.io",
Kind: "ClusterRole",
Name: "cluster-admin",
},
Subjects: []rbacv1.Subject{
{
Kind: "ServiceAccount",
Name: "default",
Namespace: ns,
},
},
}
}
// newPod creates a pod with 2 containers with a shared volume mount:
// - gather: init container that runs gather command
// - copy: no-op container we can exec into
func (o *MustGatherOptions) newPod(node string) *corev1.Pod {
zero := int64(0)
ret := &corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "must-gather-",
Labels: map[string]string{
"app": "must-gather",
},
},
Spec: corev1.PodSpec{
NodeName: node,
RestartPolicy: corev1.RestartPolicyNever,
Volumes: []corev1.Volume{
{
Name: "must-gather-output",
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
},
},
InitContainers: []corev1.Container{
{
Name: "gather",
Image: o.Image,
Command: []string{"/usr/bin/gather"},
VolumeMounts: []corev1.VolumeMount{
{
Name: "must-gather-output",
MountPath: path.Clean(o.SourceDir),
ReadOnly: false,
},
},
},
},
Containers: []corev1.Container{
{
Name: "copy",
Image: o.Image,
Command: []string{"/bin/bash", "-c", "trap : TERM INT; sleep infinity & wait"},
VolumeMounts: []corev1.VolumeMount{
{
Name: "must-gather-output",
MountPath: path.Clean(o.SourceDir),
ReadOnly: false,
},
},
},
},
TerminationGracePeriodSeconds: &zero,
Tolerations: []corev1.Toleration{
{
Operator: "Exists",
},
},
},
}
if len(o.Command) > 0 {
ret.Spec.InitContainers[0].Command = o.Command
}
return ret
}