forked from jenkins-x/jx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
create_devpod.go
422 lines (381 loc) · 10.8 KB
/
create_devpod.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
package cmd
import (
"fmt"
"io"
"io/ioutil"
"os"
"os/user"
"path/filepath"
"regexp"
"strconv"
"strings"
"time"
"github.com/ghodss/yaml"
"github.com/jenkins-x/jx/pkg/apis/jenkins.io/v1"
"github.com/jenkins-x/jx/pkg/jx/cmd/templates"
"github.com/jenkins-x/jx/pkg/kube"
"github.com/jenkins-x/jx/pkg/log"
"github.com/jenkins-x/jx/pkg/util"
"github.com/spf13/cobra"
"k8s.io/apimachinery/pkg/api/resource"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const (
optionLabel = "label"
optionRequestCpu = "request-cpu"
devPodGoPath = "/home/jenkins/go"
)
var (
createDevPodLong = templates.LongDesc(`
Creates a new DevPod
For more documentation see: [https://jenkins-x.io/developing/devpods/](https://jenkins-x.io/developing/devpods/)
`)
createDevPodExample = templates.Examples(`
# creates a new DevPod asking the user for the label to use
jx create devpod
# creates a new Maven DevPod
jx create devpod -l maven
`)
)
// CreateDevPodOptions the options for the create spring command
type CreateDevPodOptions struct {
CreateOptions
Label string
Suffix string
WorkingDir string
RequestCpu string
Dir string
Reuse bool
Sync bool
}
// NewCmdCreateDevPod creates a command object for the "create" command
func NewCmdCreateDevPod(f Factory, out io.Writer, errOut io.Writer) *cobra.Command {
options := &CreateDevPodOptions{
CreateOptions: CreateOptions{
CommonOptions: CommonOptions{
Factory: f,
Out: out,
Err: errOut,
},
},
}
cmd := &cobra.Command{
Use: "devpod",
Short: "Creates a Developer Pod for running builds and tests inside the cluster",
Aliases: []string{"dpod", "buildpod"},
Long: createDevPodLong,
Example: createDevPodExample,
Run: func(cmd *cobra.Command, args []string) {
options.Cmd = cmd
options.Args = args
err := options.Run()
CheckErr(err)
},
}
cmd.Flags().StringVarP(&options.Label, optionLabel, "l", "", "The label of the pod template to use")
cmd.Flags().StringVarP(&options.Suffix, "suffix", "s", "", "The suffix to append the pod name")
cmd.Flags().StringVarP(&options.WorkingDir, "working-dir", "w", "", "The working directory of the dev pod")
cmd.Flags().StringVarP(&options.RequestCpu, optionRequestCpu, "c", "1", "The request CPU of the dev pod")
cmd.Flags().BoolVarP(&options.Reuse, "reuse", "", false, "Reuse and existing DevPod for this folder and label if one exists")
cmd.Flags().BoolVarP(&options.Sync, "sync", "", false, "Also synchronise the local file system into the DevPod")
options.addCommonFlags(cmd)
return cmd
}
// Run implements this command
func (o *CreateDevPodOptions) Run() error {
client, curNs, err := o.KubeClient()
if err != nil {
return err
}
ns, _, err := kube.GetDevNamespace(client, curNs)
if err != nil {
return err
}
u, err := user.Current()
if err != nil {
return err
}
dir, err := os.Getwd()
if err != nil {
return err
}
cm, err := client.CoreV1().ConfigMaps(ns).Get(kube.ConfigMapJenkinsPodTemplates, metav1.GetOptions{})
if err != nil {
return fmt.Errorf("Failed to find ConfigMap %s in namespace %s: %s", kube.ConfigMapJenkinsPodTemplates, ns, err)
}
podTemplates := cm.Data
labels := util.SortedMapKeys(podTemplates)
label := o.Label
if label == "" {
label = o.guessDevPodLabel(dir, labels)
}
if label == "" {
label, err = util.PickName(labels, "Pick which kind of dev pod you wish to create: ")
if err != nil {
return err
}
}
yml := podTemplates[label]
if yml == "" {
return util.InvalidOption(optionLabel, label, labels)
}
editEnv, err := o.getOrCreateEditEnvironment()
if err != nil {
return err
}
pod := &corev1.Pod{}
err = yaml.Unmarshal([]byte(yml), pod)
if err != nil {
return fmt.Errorf("Failed to parse Pod Template YAML: %s\n%s", err, yml)
}
if pod.Labels == nil {
pod.Labels = map[string]string{}
}
if pod.Annotations == nil {
pod.Annotations = map[string]string{}
}
// lets remove the workspace volume as that breaks kync
workspaceVolume := "workspace-volume"
for i, v := range pod.Spec.Volumes {
if v.Name == workspaceVolume {
pod.Spec.Volumes = append(pod.Spec.Volumes[:i], pod.Spec.Volumes[i+1:]...)
break
}
}
for ci, c := range pod.Spec.Containers {
for i, v := range c.VolumeMounts {
if v.Name == workspaceVolume {
pod.Spec.Containers[ci].VolumeMounts = append(c.VolumeMounts[:i], c.VolumeMounts[i+1:]...)
break
}
}
}
userName := u.Username
name := kube.ToValidName(userName + "-" + label)
if o.Suffix != "" {
name += "-" + o.Suffix
}
names, err := kube.GetPodNames(client, ns, "")
if err != nil {
return err
}
name = uniquePodName(names, name)
pod.Name = name
pod.Labels[kube.LabelPodTemplate] = label
pod.Labels[kube.LabelDevPodName] = name
pod.Labels[kube.LabelDevPodUsername] = userName
if len(pod.Spec.Containers) == 0 {
return fmt.Errorf("No containers specified for label %s with YAML: %s", label, yml)
}
container1 := &pod.Spec.Containers[0]
if o.RequestCpu != "" {
q, err := resource.ParseQuantity(o.RequestCpu)
if err != nil {
return util.InvalidOptionError(optionRequestCpu, o.RequestCpu, err)
}
container1.Resources.Requests[corev1.ResourceCPU] = q
}
workingDir := o.WorkingDir
if workingDir == "" {
workingDir = "/code"
// lets check for gopath stuff
gopath := os.Getenv("GOPATH")
if gopath != "" {
rel, err := filepath.Rel(gopath, dir)
if err == nil && rel != "" {
workingDir = filepath.Join(devPodGoPath, rel)
}
}
}
pod.Annotations[kube.AnnotationWorkingDir] = workingDir
pod.Annotations[kube.AnnotationLocalDir] = dir
container1.Env = append(container1.Env, corev1.EnvVar{
Name: "WORK_DIR",
Value: workingDir,
})
container1.Stdin = true
if editEnv != nil {
container1.Env = append(container1.Env, corev1.EnvVar{
Name: "SKAFFOLD_DEPLOY_NAMESPACE",
Value: editEnv.Spec.Namespace,
})
}
podResources := client.CoreV1().Pods(ns)
create := true
if o.Reuse {
matchLabels := map[string]string{
kube.LabelPodTemplate: label,
kube.LabelDevPodUsername: userName,
}
selector, err := metav1.LabelSelectorAsSelector(&metav1.LabelSelector{MatchLabels: matchLabels})
if err != nil {
return err
}
options := metav1.ListOptions{
LabelSelector: selector.String(),
}
podsList, err := podResources.List(options)
if err != nil {
return err
}
for _, p := range podsList.Items {
ann := p.Annotations
if ann != nil && ann[kube.AnnotationLocalDir] == dir && p.DeletionTimestamp == nil {
create = false
name = p.Name
log.Infof("Reusing pod %s - waiting for it to be ready...\n", util.ColorInfo(name))
break
}
}
}
if create {
log.Infof("Creating a dev pod of label: %s\n", util.ColorInfo(label))
_, err = podResources.Create(pod)
if err != nil {
if o.Verbose {
return fmt.Errorf("Failed to create pod %s\nYAML: %s", err, yml)
} else {
return fmt.Errorf("Failed to create pod %s", err)
}
}
log.Infof("Created pod %s - waiting for it to be ready...\n", util.ColorInfo(name))
}
err = kube.WaitForPodNameToBeReady(client, ns, name, time.Hour)
if err != nil {
return err
}
log.Infof("Pod %s is now ready!\n", util.ColorInfo(name))
log.Infof("You can open other shells into this DevPod via %s\n", util.ColorInfo("jx create devpod --reuse"))
if o.Sync {
syncOptions := &SyncOptions{
CommonOptions: o.CommonOptions,
Namespace: ns,
Pod: name,
Daemon: true,
Dir: dir,
}
err = syncOptions.CreateKsync(client, ns, name, dir, workingDir, userName)
if err != nil {
return err
}
}
options := &RshOptions{
CommonOptions: o.CommonOptions,
Namespace: ns,
Pod: name,
DevPod: true,
}
options.Args = []string{}
return options.Run()
}
func (o *CreateDevPodOptions) getOrCreateEditEnvironment() (*v1.Environment, error) {
var env *v1.Environment
apisClient, err := o.Factory.CreateApiExtensionsClient()
if err != nil {
return env, err
}
err = kube.RegisterEnvironmentCRD(apisClient)
if err != nil {
return env, err
}
kubeClient, _, err := o.KubeClient()
if err != nil {
return env, err
}
jxClient, ns, err := o.JXClientAndDevNamespace()
if err != nil {
return env, err
}
u, err := user.Current()
if err != nil {
return env, err
}
env, err = kube.EnsureEditEnvironmentSetup(kubeClient, jxClient, ns, u.Username)
if err != nil {
return env, err
}
// lets ensure that we've installed the exposecontroller service in the namespace
var flag bool
editNs := env.Spec.Namespace
flag, err = kube.IsDeploymentRunning(kubeClient, kube.DeploymentExposecontrollerService, editNs)
if !flag || err != nil {
log.Infof("Installing the ExposecontrollerService in the namespace: %s\n", util.ColorInfo(editNs))
releaseName := editNs + "-es"
err = o.installChart(releaseName, kube.ChartExposecontrollerService, "", editNs, true, nil)
}
return env, err
}
func (o *CreateDevPodOptions) guessDevPodLabel(dir string, labels []string) string {
gopath := os.Getenv("GOPATH")
if gopath != "" {
rel, err := filepath.Rel(gopath, dir)
if err == nil && rel != "" && !strings.HasPrefix(rel, "../") {
return "go"
}
}
root, _, err := o.Git().FindGitConfigDir(o.Dir)
if err != nil {
log.Warnf("Could not find a .git directory: %s\n", err)
}
answer := ""
if root != "" {
jenkinsfile := filepath.Join(root, "Jenkinsfile")
exists, err := util.FileExists(jenkinsfile)
if err != nil {
log.Warnf("Could not find a Jenkinsfile at %s: %s\n", jenkinsfile, err)
} else if exists {
answer, err = findDevPodLabelFromJenkinsfile(jenkinsfile, labels)
if err != nil {
log.Warnf("Could not extract the pod template label from Jenkinsfile at %s: %s\n", jenkinsfile, err)
}
}
}
return answer
}
func findDevPodLabelFromJenkinsfile(filename string, labels []string) (string, error) {
answer := ""
data, err := ioutil.ReadFile(filename)
if err != nil {
return answer, err
}
r, err := regexp.Compile(`label\s+\"(.+)\"`)
if err != nil {
return answer, err
}
jenkinsXLabelPrefix := "jenkins-"
lines := strings.Split(string(data), "\n")
for _, line := range lines {
text := strings.TrimSpace(line)
arr := r.FindStringSubmatch(text)
if len(arr) > 1 {
a := arr[1]
if a != "" {
if util.StringArrayIndex(labels, a) >= 0 {
return a, nil
}
if strings.HasPrefix(a, jenkinsXLabelPrefix) {
a = strings.TrimPrefix(a, jenkinsXLabelPrefix)
if util.StringArrayIndex(labels, a) >= 0 {
return a, nil
}
}
return answer, fmt.Errorf("Cannot find pipeline agent %s in the list of available DevPods: %s", a, strings.Join(labels, ", "))
}
}
}
return answer, nil
}
func uniquePodName(names []string, prefix string) string {
count := 1
for {
name := prefix
if count > 1 {
name += strconv.Itoa(count)
}
if util.StringArrayIndex(names, name) < 0 {
return name
}
count++
}
}