-
Notifications
You must be signed in to change notification settings - Fork 0
/
cmd_setup.go
534 lines (482 loc) · 13.9 KB
/
cmd_setup.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//nolint:gocyclo
package util
import (
"context"
"errors"
"maps"
"strconv"
"strings"
"time"
"github.com/charmbracelet/huh"
"github.com/clevyr/kubedb/internal/config"
"github.com/clevyr/kubedb/internal/consts"
"github.com/clevyr/kubedb/internal/database"
"github.com/clevyr/kubedb/internal/kubernetes"
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"golang.org/x/sync/errgroup"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
networkingv1 "k8s.io/api/networking/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/utils/ptr"
)
type SetupOptions struct {
Name string
DisableAuthFlags bool
NoSurvey bool
}
func DefaultSetup(cmd *cobra.Command, conf *config.Global, opts SetupOptions) error {
cmd.SilenceUsage = true
ctx := cmd.Context()
conf.Kubeconfig = viper.GetString(consts.KubeconfigKey)
var err error
conf.Context, err = cmd.Flags().GetString(consts.ContextFlag)
if err != nil {
panic(err)
}
conf.Namespace, err = cmd.Flags().GetString(consts.NamespaceFlag)
if err != nil {
panic(err)
}
conf.Client, err = kubernetes.NewClient(conf.Kubeconfig, conf.Context, conf.Namespace)
if err != nil {
return err
}
log.Debug().Str("namespace", conf.Client.Namespace).Msg("created kube client")
conf.Context = conf.Client.Context
conf.Namespace = conf.Client.Namespace
if _, err := conf.Client.Namespaces().Get(ctx, conf.Namespace, metav1.GetOptions{}); err != nil {
log.Warn().Err(err).Msg("namespace may not exist")
}
podFlag, err := cmd.Flags().GetString(consts.PodFlag)
if err != nil {
panic(err)
}
var pods []corev1.Pod
if podFlag != "" {
slashIdx := strings.IndexRune(podFlag, '/')
if slashIdx != 0 && slashIdx+1 < len(podFlag) {
podFlag = podFlag[slashIdx+1:]
}
pod, err := conf.Client.Pods().Get(ctx, podFlag, metav1.GetOptions{})
if err != nil {
return err
}
pods = []corev1.Pod{*pod}
}
dialectFlag, err := cmd.Flags().GetString(consts.DialectFlag)
if err != nil {
panic(err)
}
if dialectFlag == "" {
// Configure via detection
if len(pods) == 0 {
result, err := database.DetectDialect(ctx, conf.Client)
if err != nil {
return err
}
if len(result) == 1 || opts.NoSurvey {
for dialect, p := range result {
conf.Dialect = dialect
pods = p
break
}
} else {
opts := make([]huh.Option[config.Database], 0, len(result))
for dialect := range result {
opts = append(opts, huh.NewOption(dialect.PrettyName(), dialect))
}
var chosen config.Database
if err := huh.NewForm(huh.NewGroup(
huh.NewSelect[config.Database]().
Title("Select database type").
Options(opts...).
Value(&chosen),
)).Run(); err != nil {
return err
}
conf.Dialect = chosen
pods = result[chosen]
}
log.Debug().Str("dialect", conf.Dialect.Name()).Msg("detected dialect")
} else {
conf.Dialect, err = database.DetectDialectFromPod(pods[0])
if err != nil {
return err
}
}
} else {
// Configure via flag
conf.Dialect, err = database.New(dialectFlag)
if err != nil {
return err
}
log.Debug().Str("dialect", conf.Dialect.Name()).Msg("configured database")
if len(pods) == 0 {
pods, err = conf.Client.GetPodsFiltered(ctx, conf.Dialect.PodFilters())
if err != nil {
return err
}
if len(pods) == 0 {
return kubernetes.ErrPodNotFound
}
}
}
if len(pods) > 1 {
if db, ok := conf.Dialect.(config.DatabaseFilter); ok && podFlag == "" {
filtered, err := db.FilterPods(ctx, conf.Client, pods)
if err != nil {
log.Warn().Err(err).Msg("could not query primary instance")
}
if len(filtered) != 0 {
pods = filtered
}
}
}
if len(pods) == 1 || opts.NoSurvey {
conf.DBPod = pods[0]
} else {
opts := make([]huh.Option[int], 0, len(pods))
for i, pod := range pods {
opts = append(opts, huh.NewOption(pod.Name, i))
}
var idx int
if err := huh.NewForm(huh.NewGroup(
huh.NewSelect[int]().
Title("Select " + conf.Dialect.PrettyName() + " instance").
Options(opts...).
Value(&idx),
)).Run(); err != nil {
return err
}
conf.DBPod = pods[idx]
}
group, ctx := errgroup.WithContext(ctx)
group.Go(func() error {
conf.Port, err = cmd.Flags().GetUint16(consts.PortFlag)
if err != nil {
panic(err)
}
if db, ok := conf.Dialect.(config.DatabasePort); ok && conf.Port == 0 {
port, err := db.PortEnvNames().Search(ctx, conf.Client, conf.DBPod)
if err != nil {
log.Debug().Msg("could not detect port from pod env")
} else {
port, err := strconv.ParseUint(port, 10, 16)
if err != nil {
log.Debug().Uint64("port", port).Msg("failed to parse port from pod env")
} else {
conf.Port = uint16(port)
log.Debug().Uint16("port", conf.Port).Msg("found port in pod env")
}
}
if conf.Port == 0 {
conf.Port = db.DefaultPort()
}
}
return nil
})
group.Go(func() error {
conf.Database, err = cmd.Flags().GetString(consts.DbnameFlag)
if err != nil && !opts.DisableAuthFlags {
panic(err)
}
if db, ok := conf.Dialect.(config.DatabaseDB); ok && conf.Database == "" {
conf.Database, err = db.DatabaseEnvNames().Search(ctx, conf.Client, conf.DBPod)
if err != nil {
log.Debug().Msg("could not detect database from pod env")
} else {
log.Debug().Str("database", conf.Database).Msg("found db name in pod env")
}
}
return nil
})
group.Go(func() error {
conf.Username, err = cmd.Flags().GetString(consts.UsernameFlag)
if err != nil && !opts.DisableAuthFlags {
panic(err)
}
if db, ok := conf.Dialect.(config.DatabaseUsername); ok && conf.Username == "" {
conf.Username, err = db.UserEnvNames().Search(ctx, conf.Client, conf.DBPod)
if err != nil {
conf.Username = db.DefaultUser()
log.Debug().Str("user", conf.Username).Msg("could not detect user from pod env, using default")
} else {
log.Debug().Str("user", conf.Username).Msg("found user in pod env")
}
}
conf.Password, err = cmd.Flags().GetString(consts.PasswordFlag)
if err != nil && !opts.DisableAuthFlags {
panic(err)
}
if db, ok := conf.Dialect.(config.DatabasePassword); ok && conf.Password == "" {
conf.Password, err = db.PasswordEnvNames(*conf).Search(ctx, conf.Client, conf.DBPod)
if err != nil {
log.Err(err).Str("password", conf.Password).Msg("could not detect password from pod env")
return err
}
log.Debug().Msg("found password in pod env")
}
return nil
})
group.Go(func() error {
if db, ok := conf.Dialect.(config.DatabaseDisableJob); ok && db.DisableJob() {
viper.Set(consts.CreateJobKey, false)
}
if !viper.GetBool(consts.CreateJobKey) {
conf.Host = "127.0.0.1"
conf.JobPod = conf.DBPod
}
return nil
})
return group.Wait()
}
func CreateJob(ctx context.Context, conf *config.Global, opts SetupOptions) error {
if viper.GetBool(consts.CreateJobKey) {
if err := createJob(ctx, conf, opts.Name); err != nil {
return err
}
OnFinalize(func(_ error) {
Teardown(conf)
})
if err := watchJobPod(ctx, conf); err != nil {
return err
}
}
return nil
}
func createJob(ctx context.Context, conf *config.Global, actionName string) error {
image := conf.DBPod.Spec.Containers[0].Image
name := "kubedb-"
if actionName != "" {
name += actionName + "-"
}
standardLabels := map[string]string{
"app.kubernetes.io/name": "kubedb",
"app.kubernetes.io/instance": "kubedb",
"app.kubernetes.io/component": actionName,
"app.kubernetes.io/version": GetVersion(),
}
podLabels := map[string]string{
"sidecar.istio.io/inject": "false",
}
maps.Copy(podLabels, standardLabels)
maps.Copy(podLabels, viper.GetStringMapString(consts.JobPodLabelsKey))
job := batchv1.Job{
ObjectMeta: metav1.ObjectMeta{
GenerateName: name,
Namespace: conf.Namespace,
Labels: standardLabels,
},
Spec: batchv1.JobSpec{
ActiveDeadlineSeconds: ptr.To(int64(24 * time.Hour.Seconds())),
TTLSecondsAfterFinished: ptr.To(int32(time.Hour.Seconds())),
BackoffLimit: ptr.To(int32(0)),
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
"linkerd.io/inject": "disabled",
},
Labels: podLabels,
},
Spec: corev1.PodSpec{
RestartPolicy: corev1.RestartPolicyNever,
TerminationGracePeriodSeconds: ptr.To(int64(0)),
Affinity: &corev1.Affinity{
PodAffinity: &corev1.PodAffinity{
PreferredDuringSchedulingIgnoredDuringExecution: []corev1.WeightedPodAffinityTerm{
{
Weight: 100,
PodAffinityTerm: corev1.PodAffinityTerm{
TopologyKey: "kubernetes.io/hostname",
LabelSelector: &metav1.LabelSelector{
MatchLabels: conf.DBPod.ObjectMeta.Labels,
},
},
},
{
Weight: 90,
PodAffinityTerm: corev1.PodAffinityTerm{
TopologyKey: "topology.kubernetes.io/zone",
LabelSelector: &metav1.LabelSelector{
MatchLabels: conf.DBPod.ObjectMeta.Labels,
},
},
},
{
Weight: 80,
PodAffinityTerm: corev1.PodAffinityTerm{
TopologyKey: "topology.kubernetes.io/region",
LabelSelector: &metav1.LabelSelector{
MatchLabels: conf.DBPod.ObjectMeta.Labels,
},
},
},
},
},
},
Containers: []corev1.Container{
{
Name: "kubedb",
Image: image,
ImagePullPolicy: corev1.PullIfNotPresent,
Command: []string{"sleep"},
Args: []string{"infinity"},
TTY: true,
Stdin: true,
},
},
},
},
},
}
ctx, cancel := context.WithTimeout(ctx, time.Minute)
defer cancel()
nsLog := log.With().Str("namespace", conf.Namespace).Logger()
nsLog.Info().Msg("creating job")
var err error
if conf.Job, err = conf.Client.Jobs().Create(ctx, &job, metav1.CreateOptions{}); err != nil {
return err
}
if viper.GetBool(consts.CreateNetworkPolicyKey) {
jobPodKey, jobPodVal := jobPodNameLabel(conf, conf.Job)
policy := networkingv1.NetworkPolicy{
ObjectMeta: metav1.ObjectMeta{
Name: conf.Job.Name,
Namespace: conf.Client.Namespace,
Labels: standardLabels,
},
Spec: networkingv1.NetworkPolicySpec{
PodSelector: metav1.LabelSelector{MatchLabels: map[string]string{
jobPodKey: jobPodVal,
}},
PolicyTypes: []networkingv1.PolicyType{networkingv1.PolicyTypeIngress, networkingv1.PolicyTypeEgress},
Ingress: []networkingv1.NetworkPolicyIngressRule{{}},
Egress: []networkingv1.NetworkPolicyEgressRule{
{
To: []networkingv1.NetworkPolicyPeer{{
NamespaceSelector: ptr.To(metav1.LabelSelector{MatchLabels: map[string]string{
"kubernetes.io/metadata.name": conf.Client.Namespace,
}}),
}},
Ports: []networkingv1.NetworkPolicyPort{{
Port: ptr.To(intstr.FromInt32(int32(conf.Port))),
}},
},
},
},
}
nsLog.Info().Msg("creating network policy")
if _, err := conf.Client.NetworkPolicies().Create(ctx, &policy, metav1.CreateOptions{}); err != nil {
nsLog.Err(err).Msg("failed to create network policy")
viper.Set(consts.CreateNetworkPolicyKey, "false")
}
}
return nil
}
var (
ErrJobPodFailed = errors.New("job pod failed")
ErrJobPodEarlyExit = errors.New("job pod exited early")
ErrJobPodInvalid = errors.New("unexpected job pod object type")
)
func watchJobPod(ctx context.Context, conf *config.Global) error {
log.Info().
Str("namespace", conf.Namespace).
Str("job", conf.Job.ObjectMeta.Name).
Msg("waiting for job...")
ctx, cancel := context.WithTimeout(ctx, 5*time.Minute)
defer cancel()
watch, err := conf.Client.Pods().Watch(ctx, metav1.ListOptions{
LabelSelector: jobPodLabelSelector(conf, conf.Job),
})
if err != nil {
return pollJobPod(ctx, conf)
}
defer func() {
watch.Stop()
}()
for {
select {
case <-ctx.Done():
return ctx.Err()
case event := <-watch.ResultChan():
if pod, ok := event.Object.(*corev1.Pod); ok {
switch pod.Status.Phase {
case corev1.PodRunning:
conf.Host = conf.DBPod.Status.PodIP
pod.DeepCopyInto(&conf.JobPod)
return nil
case corev1.PodFailed:
return ErrJobPodFailed
case corev1.PodSucceeded:
return ErrJobPodEarlyExit
}
} else {
return ErrJobPodInvalid
}
}
}
}
func pollJobPod(ctx context.Context, conf *config.Global) error {
return wait.PollUntilContextCancel(
ctx, time.Second, true, func(ctx context.Context) (bool, error) {
list, err := conf.Client.Pods().List(ctx, metav1.ListOptions{
LabelSelector: jobPodLabelSelector(conf, conf.Job),
})
if err != nil {
return false, err
}
if len(list.Items) == 0 {
return false, nil
}
switch list.Items[0].Status.Phase {
case corev1.PodRunning:
conf.Host = conf.DBPod.Status.PodIP
conf.JobPod = list.Items[0]
return true, nil
case corev1.PodFailed:
return false, ErrJobPodFailed
case corev1.PodSucceeded:
return false, ErrJobPodEarlyExit
default:
return false, nil
}
},
)
}
func jobPodUIDLabel(conf *config.Global, job *batchv1.Job) (string, string) {
useNewLabel, err := conf.Client.MinServerVersion(1, 27)
if err != nil {
log.Warn().Err(err).Msg("failed to query server version; assuming v1.27+")
useNewLabel = true
}
var key string
if useNewLabel {
key = "batch.kubernetes.io/controller-uid"
} else {
key = "controller-uid"
}
return key, string(job.ObjectMeta.UID)
}
func jobPodLabelSelector(conf *config.Global, job *batchv1.Job) string {
k, v := jobPodUIDLabel(conf, job)
return k + "=" + v
}
func jobPodNameLabel(conf *config.Global, job *batchv1.Job) (string, string) {
useNewLabel, err := conf.Client.MinServerVersion(1, 27)
if err != nil {
log.Warn().Err(err).Msg("failed to query server version; assuming v1.27+")
useNewLabel = true
}
var key string
if useNewLabel {
key = "batch.kubernetes.io/job-name"
} else {
key = "job-name"
}
return key, job.Name
}