-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
exec_env.go
239 lines (184 loc) · 7.08 KB
/
exec_env.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
/*
Copyright 2023 The Skaffold Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package k8sjob
import (
"context"
"fmt"
"io"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/actions"
k8scomponents "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/deploy/component/kubernetes"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/deploy/kubectl"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/deploy/label"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/graph"
k8sjobutil "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/k8sjob"
k8sjoblogger "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/k8sjob/logger"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/k8sjob/tracker"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/kubernetes"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/loader"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util"
)
type ExecEnv struct {
// Used to print the output from the associated tasks.
logger *k8sjoblogger.Logger
// Keeps track of all the jobs created for each associated triggered task.
tracker *tracker.JobTracker
// Kubectl client used to manage communication with the cluster.
kubectl *kubectl.CLI
// Namespace to use for all kubectl operations.
namespace string
// Labeller client.
labeller *label.DefaultLabeller
// Used to load the local built images into the local clusters that require it, e.g, Kind, K3D.
imageLoader loader.ImageLoader
// List of all the local custom actions configurations defined, by name.
acsCfgByName map[string]latest.Action
// Global env variables to be injected into every container of each task.
envVars []corev1.EnvVar
}
func NewExecEnv(ctx context.Context, cfg kubectl.Config, labeller *label.DefaultLabeller, namespace string, envMap map[string]string, acs []latest.Action) *ExecEnv {
if namespace == "" {
namespace = "default"
}
kubectl := kubectl.NewCLI(cfg, latest.KubectlFlags{}, namespace)
tracker := tracker.NewContainerTracker()
logger := k8sjoblogger.NewLogger(ctx, tracker, labeller, kubectl.KubeContext)
acsCfgByName := map[string]latest.Action{}
for _, a := range acs {
acsCfgByName[a.Name] = a
}
envVars := []corev1.EnvVar{}
for k, v := range envMap {
envVars = append(envVars, corev1.EnvVar{Name: k, Value: v})
}
return &ExecEnv{
kubectl: &kubectl,
logger: logger,
tracker: tracker,
namespace: namespace,
labeller: labeller,
imageLoader: k8scomponents.NewImageLoader(cfg, kubectl.CLI),
acsCfgByName: acsCfgByName,
envVars: envVars,
}
}
func (e ExecEnv) PrepareActions(ctx context.Context, out io.Writer, allbuilds, localImgs []graph.Artifact, acsNames []string) ([]actions.Action, error) {
if err := kubernetes.FailIfClusterIsNotReachable(e.kubectl.KubeContext); err != nil {
return nil, fmt.Errorf("unable to connect to Kubernetes: %w", err)
}
if err := e.imageLoader.LoadImages(ctx, out, localImgs, localImgs, localImgs); err != nil {
return nil, err
}
e.logger.Start(ctx, out)
return e.createActions(allbuilds, acsNames)
}
func (e ExecEnv) Cleanup(ctx context.Context, out io.Writer) error {
return nil
}
func (e ExecEnv) Stop() {
// This is to drain the logs from the succeeded jobs. Failed jobs were already removed from the cluster.
e.logger.Stop()
}
func (e ExecEnv) createActions(bs []graph.Artifact, acsNames []string) ([]actions.Action, error) {
var acs []actions.Action
var toTrack []graph.Artifact
builtArtifacts := map[string]graph.Artifact{}
for _, b := range bs {
builtArtifacts[b.ImageName] = b
}
for _, aName := range acsNames {
aCfg, found := e.acsCfgByName[aName]
if !found {
return nil, fmt.Errorf("action %v not found for k8s execution mode", aName)
}
jmp := aCfg.ExecutionModeConfig.KubernetesClusterExecutionMode.JobManifestPath
o := aCfg.ExecutionModeConfig.KubernetesClusterExecutionMode.Overrides
jm, err := e.getJobManifest(jmp, o)
if err != nil {
return nil, err
}
ts, artifactsToTrack := e.createTasks(aCfg, jm, builtArtifacts)
acs = append(acs, *actions.NewAction(aCfg.Name, *aCfg.Config.Timeout, *aCfg.Config.IsFailFast, ts))
toTrack = append(toTrack, artifactsToTrack...)
}
e.logger.RegisterArtifacts(toTrack)
return acs, nil
}
func (e ExecEnv) createTasks(aCfg latest.Action, jobManifest *batchv1.Job, builtArtifacts map[string]graph.Artifact) ([]actions.Task, []graph.Artifact) {
var ts []actions.Task
var toTrack []graph.Artifact
for _, cCfg := range aCfg.Containers {
art := e.getArtifactToDeploy(builtArtifacts, cCfg)
ts = append(ts, NewTask(cCfg, e.kubectl, e.namespace, art, *jobManifest, &e))
toTrack = append(toTrack, graph.Artifact{ImageName: cCfg.Image, Tag: cCfg.Name})
}
return ts, toTrack
}
func (e ExecEnv) getArtifactToDeploy(builtArtifacts map[string]graph.Artifact, cfg latest.VerifyContainer) graph.Artifact {
ba, found := builtArtifacts[cfg.Image]
artToDeploy := graph.Artifact{ImageName: cfg.Image, Tag: cfg.Image}
if found {
artToDeploy.Tag = ba.Tag
}
return artToDeploy
}
func (e ExecEnv) getJobManifest(jobManifestPath, overrides string) (*batchv1.Job, error) {
job, err := e.getBaseJobManifest(jobManifestPath)
if err != nil {
return nil, err
}
job, err = e.applyOverrides(job, overrides)
if err != nil {
return nil, err
}
e.setDefaultValues(job)
return job, nil
}
func (e ExecEnv) getBaseJobManifest(jobManifestPath string) (*batchv1.Job, error) {
if jobManifestPath == "" {
return k8sjobutil.GetGenericJob(), nil
}
return k8sjobutil.LoadFromPath(jobManifestPath)
}
func (e ExecEnv) applyOverrides(job *batchv1.Job, overrides string) (*batchv1.Job, error) {
if overrides == "" {
return job, nil
}
obj, err := k8sjobutil.ApplyOverrides(job, overrides)
if err != nil {
return nil, err
}
return obj.(*batchv1.Job), nil
}
func (e ExecEnv) setDefaultValues(job *batchv1.Job) {
if job.Labels == nil {
job.Labels = map[string]string{}
}
if job.Spec.Template.Labels == nil {
job.Spec.Template.Labels = map[string]string{}
}
if job.Namespace == "" {
job.Namespace = e.namespace
}
job.Labels["skaffold.dev/run-id"] = e.labeller.GetRunID()
job.Spec.Template.Labels["skaffold.dev/run-id"] = e.labeller.GetRunID()
job.Spec.Template.Spec.RestartPolicy = corev1.RestartPolicyNever
job.Spec.BackoffLimit = util.Ptr[int32](0)
}
func (e ExecEnv) TrackContainerAndJobFromBuild(art graph.Artifact, container tracker.Job, job *batchv1.Job) {
e.tracker.Add(art, container, job.Namespace)
e.tracker.AddJob(job)
e.logger.RegisterJob(job.Name)
}