-
Notifications
You must be signed in to change notification settings - Fork 155
/
datascript.go
397 lines (350 loc) · 13.1 KB
/
datascript.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
package operations
import (
"fmt"
"strings"
"time"
"github.com/sethvargo/go-password/password"
"github.com/spf13/viper"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
appsv1alpha1 "github.com/apecloud/kubeblocks/apis/apps/v1alpha1"
"github.com/apecloud/kubeblocks/internal/constant"
componetutil "github.com/apecloud/kubeblocks/internal/controller/component"
intctrlutil "github.com/apecloud/kubeblocks/internal/controllerutil"
"github.com/apecloud/kubeblocks/internal/sqlchannel/engine"
)
var _ OpsHandler = DataScriptOpsHandler{}
var _ error = &FastFaileError{}
// DataScriptOpsHandler handles DataScript operation, it is more like a one-time command operation.
type DataScriptOpsHandler struct {
}
// FastFaileError is a error type that will not retry the operation.
type FastFaileError struct {
message string
}
func (e *FastFaileError) Error() string {
return fmt.Sprintf("fail with message: %s", e.message)
}
func init() {
// ToClusterPhase is not defined, because 'datascript' does not affect the cluster status.
dataScriptOpsHander := DataScriptOpsHandler{}
dataScriptBehavior := OpsBehaviour{
FromClusterPhases: []appsv1alpha1.ClusterPhase{appsv1alpha1.RunningClusterPhase},
MaintainClusterPhaseBySelf: false,
OpsHandler: dataScriptOpsHander,
}
opsMgr := GetOpsManager()
opsMgr.RegisterOps(appsv1alpha1.DataScriptType, dataScriptBehavior)
}
// Action implements OpsHandler.Action
// It will create a job to execute the script. It will fail fast if the script is not valid, or the target pod is not found.
func (o DataScriptOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error {
opsRequest := opsResource.OpsRequest
cluster := opsResource.Cluster
spec := opsRequest.Spec.ScriptSpec
// get component
component := cluster.Spec.GetComponentByName(spec.ComponentName)
if component == nil {
// we have checked component exists in validation, so this should not happen
return &FastFaileError{message: fmt.Sprintf("component %s not found in cluster %s", spec.ComponentName, cluster.Name)}
}
clusterDef, err := getClusterDefByName(reqCtx.Ctx, cli, cluster.Spec.ClusterDefRef)
if err != nil {
if apierrors.IsNotFound(err) {
// fail fast if cluster def does not exists
return &FastFaileError{message: err.Error()}
}
return err
}
// get componentDef
componentDef := clusterDef.GetComponentDefByName(component.ComponentDefRef)
if componentDef == nil {
return &FastFaileError{message: fmt.Sprintf("componentDef %s not found in clusterDef %s", component.ComponentDefRef, clusterDef.Name)}
}
// create jobs
var jobs []*batchv1.Job
if jobs, err = buildDataScriptJobs(reqCtx, cli, opsResource.Cluster, component, opsRequest, componentDef.CharacterType); err != nil {
return err
}
for _, job := range jobs {
if err = cli.Create(reqCtx.Ctx, job); err != nil {
return err
}
}
return nil
}
// ReconcileAction implements OpsHandler.ReconcileAction
// It will check the job status, and update the opsRequest status.
// If the job is neither completed nor failed, it will retry after 1 second.
// If the job is completed, it will return OpsSucceedPhase
// If the job is failed, it will return OpsFailedPhase.
func (o DataScriptOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error) {
opsRequest := opsResource.OpsRequest
cluster := opsResource.Cluster
spec := opsRequest.Spec.ScriptSpec
meetsJobConditions := func(job *batchv1.Job, condType batchv1.JobConditionType, condStatus corev1.ConditionStatus) bool {
for _, condition := range job.Status.Conditions {
if condition.Type == condType && condition.Status == condStatus {
return true
}
}
return false
}
// retrieve job for this opsRequest
jobList := &batchv1.JobList{}
if err := cli.List(reqCtx.Ctx, jobList, client.InNamespace(cluster.Namespace), client.MatchingLabels(getDataScriptJobLabels(cluster.Name, spec.ComponentName, opsRequest.Name))); err != nil {
return appsv1alpha1.OpsFailedPhase, 0, err
} else if len(jobList.Items) == 0 {
return appsv1alpha1.OpsFailedPhase, 0, fmt.Errorf("job not found")
}
var (
expectedCount int
succedCount int
failedCount int
)
expectedCount = len(jobList.Items)
// check job status
for _, job := range jobList.Items {
if meetsJobConditions(&job, batchv1.JobComplete, corev1.ConditionTrue) {
succedCount++
} else if meetsJobConditions(&job, batchv1.JobFailed, corev1.ConditionTrue) {
failedCount++
}
}
opsStatus := appsv1alpha1.OpsRunningPhase
if succedCount == expectedCount {
opsStatus = appsv1alpha1.OpsSucceedPhase
} else if failedCount+succedCount == expectedCount {
opsStatus = appsv1alpha1.OpsFailedPhase
}
patch := client.MergeFrom(opsRequest.DeepCopy())
opsRequest.Status.Progress = fmt.Sprintf("%d/%d", succedCount, expectedCount)
// patch OpsRequest.status.components
if err := cli.Status().Patch(reqCtx.Ctx, opsRequest, patch); err != nil {
return opsStatus, time.Second, err
}
if succedCount == expectedCount {
return appsv1alpha1.OpsSucceedPhase, 0, nil
} else if failedCount+succedCount == expectedCount {
return appsv1alpha1.OpsFailedPhase, 0, fmt.Errorf("%d job execution failed, please check the job log ", failedCount)
}
return appsv1alpha1.OpsRunningPhase, 5 * time.Second, nil
}
func (o DataScriptOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error) {
return appsv1alpha1.NewDataScriptCondition(opsRes.OpsRequest), nil
}
func (o DataScriptOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error {
return nil
}
func (o DataScriptOpsHandler) GetRealAffectedComponentMap(opsRequest *appsv1alpha1.OpsRequest) realAffectedComponentMap {
return realAffectedComponentMap(opsRequest.Spec.GetDataScriptComponentNameSet())
}
// getScriptContent will get script content from script or scriptFrom
func getScriptContent(reqCtx intctrlutil.RequestCtx, cli client.Client, spec *appsv1alpha1.ScriptSpec) ([]string, error) {
script := make([]string, 0)
if len(spec.Script) > 0 {
script = append(script, spec.Script...)
}
if spec.ScriptFrom == nil {
return script, nil
}
configMapsRefs := spec.ScriptFrom.ConfigMapRef
secretRefs := spec.ScriptFrom.SecretRef
if len(configMapsRefs) > 0 {
obj := &corev1.ConfigMap{}
for _, cm := range configMapsRefs {
if err := cli.Get(reqCtx.Ctx, types.NamespacedName{Namespace: reqCtx.Req.Namespace, Name: cm.Name}, obj); err != nil {
return nil, err
}
script = append(script, obj.Data[cm.Key])
}
}
if len(secretRefs) > 0 {
obj := &corev1.Secret{}
for _, secret := range secretRefs {
if err := cli.Get(reqCtx.Ctx, types.NamespacedName{Namespace: reqCtx.Req.Namespace, Name: secret.Name}, obj); err != nil {
return nil, err
}
if obj.Data[secret.Key] == nil {
return nil, fmt.Errorf("secret %s/%s does not have key %s", reqCtx.Req.Namespace, secret.Name, secret.Key)
}
secretData := string(obj.Data[secret.Key])
// trim the last \n
if len(secretData) > 0 && secretData[len(secretData)-1] == '\n' {
secretData = secretData[:len(secretData)-1]
}
script = append(script, secretData)
}
}
return script, nil
}
func getTargetService(reqCtx intctrlutil.RequestCtx, cli client.Client, clusterObjectKey client.ObjectKey, componentName string) (string, error) {
// get svc
service := &corev1.Service{}
serviceName := fmt.Sprintf("%s-%s", clusterObjectKey.Name, componentName)
if err := cli.Get(reqCtx.Ctx, types.NamespacedName{Namespace: clusterObjectKey.Namespace, Name: serviceName}, service); err != nil {
return "", err
}
return serviceName, nil
}
func buildDataScriptJobs(reqCtx intctrlutil.RequestCtx, cli client.Client, cluster *appsv1alpha1.Cluster, component *appsv1alpha1.ClusterComponentSpec,
ops *appsv1alpha1.OpsRequest, charType string) ([]*batchv1.Job, error) {
engineForJob, err := engine.New(charType)
if err != nil || engineForJob == nil {
return nil, &FastFaileError{message: err.Error()}
}
buildJob := func(endpoint string) (*batchv1.Job, error) {
envs := []corev1.EnvVar{}
envs = append(envs, corev1.EnvVar{
Name: "KB_HOST",
Value: endpoint,
})
// parse username and password
secretFrom := ops.Spec.ScriptSpec.Secret
if secretFrom == nil {
secretFrom = &appsv1alpha1.ScriptSecret{
Name: fmt.Sprintf("%s-conn-credential", cluster.Name),
PasswordKey: "password",
UsernameKey: "username",
}
}
// verify secrets exist
if err := cli.Get(reqCtx.Ctx, types.NamespacedName{Namespace: reqCtx.Req.Namespace, Name: secretFrom.Name}, &corev1.Secret{}); err != nil {
return nil, &FastFaileError{message: err.Error()}
}
envs = append(envs, corev1.EnvVar{
Name: "KB_USER",
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
Key: secretFrom.UsernameKey,
LocalObjectReference: corev1.LocalObjectReference{
Name: secretFrom.Name,
},
},
},
})
envs = append(envs, corev1.EnvVar{
Name: "KB_PASSWD",
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
Key: secretFrom.PasswordKey,
LocalObjectReference: corev1.LocalObjectReference{
Name: secretFrom.Name,
},
},
},
})
// parse scripts
scripts, err := getScriptContent(reqCtx, cli, ops.Spec.ScriptSpec)
if err != nil {
return nil, &FastFaileError{message: err.Error()}
}
envs = append(envs, corev1.EnvVar{
Name: "KB_SCRIPT",
Value: strings.Join(scripts, "\n"),
})
jobCmdTpl, envVars, err := engineForJob.ExecuteCommand(scripts)
if err != nil {
return nil, &FastFaileError{message: err.Error()}
}
if envVars != nil {
envs = append(envs, envVars...)
}
containerImg := viper.GetString(constant.KBDataScriptClientsImage)
if len(ops.Spec.ScriptSpec.Image) != 0 {
containerImg = ops.Spec.ScriptSpec.Image
}
if len(containerImg) == 0 {
return nil, &FastFaileError{message: "image is empty"}
}
container := corev1.Container{
Name: "datascript",
Image: containerImg,
ImagePullPolicy: corev1.PullPolicy(viper.GetString(constant.KBImagePullPolicy)),
Command: jobCmdTpl,
Env: envs,
}
randomStr, _ := password.Generate(4, 0, 0, true, false)
jobName := fmt.Sprintf("%s-%s-%s-%s", cluster.Name, "script", ops.Name, randomStr)
if len(jobName) > 63 {
jobName = jobName[:63]
}
job := &batchv1.Job{
ObjectMeta: metav1.ObjectMeta{
Name: jobName,
Namespace: cluster.Namespace,
},
}
// set backoff limit to 0, so that the job will not be restarted
job.Spec.BackoffLimit = pointer.Int32(0)
job.Spec.Template.Spec.RestartPolicy = corev1.RestartPolicyNever
job.Spec.Template.Spec.Containers = []corev1.Container{container}
// add labels
job.Labels = getDataScriptJobLabels(cluster.Name, component.Name, ops.Name)
// add tolerations
tolerations, err := componetutil.BuildTolerations(cluster, component)
if err != nil {
return nil, &FastFaileError{message: err.Error()}
}
job.Spec.Template.Spec.Tolerations = tolerations
// add owner reference
scheme, _ := appsv1alpha1.SchemeBuilder.Build()
if err := controllerutil.SetOwnerReference(ops, job, scheme); err != nil {
return nil, &FastFaileError{message: err.Error()}
}
return job, nil
}
// parse kb host
var endpoint string
var job *batchv1.Job
jobs := make([]*batchv1.Job, 0)
if ops.Spec.ScriptSpec.Selector == nil {
if endpoint, err = getTargetService(reqCtx, cli, client.ObjectKeyFromObject(cluster), component.Name); err != nil {
return nil, &FastFaileError{message: err.Error()}
}
if job, err = buildJob(endpoint); err != nil {
return nil, &FastFaileError{message: err.Error()}
}
jobs = append(jobs, job)
return jobs, nil
}
selector, err := metav1.LabelSelectorAsSelector(ops.Spec.ScriptSpec.Selector)
if err != nil {
return nil, &FastFaileError{message: err.Error()}
}
pods := &corev1.PodList{}
if err = cli.List(reqCtx.Ctx, pods, client.InNamespace(cluster.Namespace),
client.MatchingLabels{
constant.AppInstanceLabelKey: cluster.Name,
constant.KBAppComponentLabelKey: component.Name,
},
client.MatchingLabelsSelector{Selector: selector},
); err != nil {
return nil, &FastFaileError{message: err.Error()}
} else if len(pods.Items) == 0 {
return nil, &FastFaileError{message: "no pods found"}
}
for _, pod := range pods.Items {
endpoint = pod.Status.PodIP
if job, err = buildJob(endpoint); err != nil {
return nil, &FastFaileError{message: err.Error()}
} else {
jobs = append(jobs, job)
}
}
return jobs, nil
}
func getDataScriptJobLabels(cluster, component, request string) map[string]string {
return map[string]string{
constant.AppInstanceLabelKey: cluster,
constant.KBAppComponentLabelKey: component,
constant.OpsRequestNameLabelKey: request,
constant.OpsRequestTypeLabelKey: string(appsv1alpha1.DataScriptType),
}
}