-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
resource.go
335 lines (304 loc) · 11.5 KB
/
resource.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
package executor
import (
"context"
"encoding/json"
"fmt"
"io/ioutil"
"os"
"os/exec"
"os/signal"
"strings"
"time"
log "github.com/sirupsen/logrus"
"github.com/tidwall/gjson"
apierr "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/util/wait"
"github.com/argoproj/argo-workflows/v3/errors"
wfv1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
"github.com/argoproj/argo-workflows/v3/util"
envutil "github.com/argoproj/argo-workflows/v3/util/env"
argoerr "github.com/argoproj/argo-workflows/v3/util/errors"
os_specific "github.com/argoproj/argo-workflows/v3/workflow/executor/os-specific"
)
// ExecResource will run kubectl action against a manifest
func (we *WorkflowExecutor) ExecResource(action string, manifestPath string, flags []string) (string, string, string, error) {
args, err := we.getKubectlArguments(action, manifestPath, flags)
if err != nil {
return "", "", "", err
}
cmd := exec.Command("kubectl", args...)
log.Info(strings.Join(cmd.Args, " "))
out, err := cmd.Output()
if err != nil {
exErr := err.(*exec.ExitError)
errMsg := strings.TrimSpace(string(exErr.Stderr))
return "", "", "", errors.New(errors.CodeBadRequest, errMsg)
}
if action == "delete" {
return "", "", "", nil
}
if action == "get" && len(out) == 0 {
return "", "", "", nil
}
obj := unstructured.Unstructured{}
err = json.Unmarshal(out, &obj)
if err != nil {
return "", "", "", err
}
resourceGroup := obj.GroupVersionKind().Group
resourceName := obj.GetName()
resourceKind := obj.GroupVersionKind().Kind
if resourceName == "" || resourceKind == "" {
return "", "", "", errors.New(errors.CodeBadRequest, "Kind and name are both required but at least one of them is missing from the manifest")
}
resourceFullName := fmt.Sprintf("%s.%s/%s", strings.ToLower(resourceKind), resourceGroup, resourceName)
selfLink := inferObjectSelfLink(obj)
log.Infof("Resource: %s/%s. SelfLink: %s", obj.GetNamespace(), resourceFullName, selfLink)
return obj.GetNamespace(), resourceFullName, selfLink, nil
}
func inferObjectSelfLink(obj unstructured.Unstructured) string {
gvk := obj.GroupVersionKind()
// This is the best guess we can do here and is what `kubectl` uses under the hood. Hopefully future versions of the
// REST client would remove the need to infer the plural name.
pluralGVR, _ := meta.UnsafeGuessKindToResource(gvk)
var selfLinkPrefix string
if gvk.Group == "" {
selfLinkPrefix = "api"
} else {
selfLinkPrefix = "apis"
}
// We cannot use `obj.GetSelfLink()` directly since it is deprecated and will be removed after Kubernetes 1.21: https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/1164-remove-selflink
return fmt.Sprintf("%s/%s/namespaces/%s/%s/%s",
selfLinkPrefix, obj.GetAPIVersion(), obj.GetNamespace(), pluralGVR.Resource, obj.GetName())
}
func (we *WorkflowExecutor) getKubectlArguments(action string, manifestPath string, flags []string) ([]string, error) {
buff, err := ioutil.ReadFile(manifestPath)
if err != nil {
return []string{}, errors.New(errors.CodeBadRequest, err.Error())
}
if len(buff) == 0 && len(flags) == 0 {
return []string{}, errors.New(errors.CodeBadRequest, "Must provide at least one of flags or manifest.")
}
args := []string{
action,
}
output := "json"
if action == "delete" {
args = append(args, "--ignore-not-found")
output = "name"
}
appendFileFlag := true
if action == "patch" {
mergeStrategy := "strategic"
if we.Template.Resource.MergeStrategy != "" {
mergeStrategy = we.Template.Resource.MergeStrategy
if mergeStrategy == "json" {
// Action "patch" require flag "-p" with resource arguments.
// But kubectl disallow specify both "-f" flag and resource arguments.
// Flag "-f" should be excluded for action "patch" here if it's a json patch.
appendFileFlag = false
}
}
args = append(args, "--type")
args = append(args, mergeStrategy)
args = append(args, "-p")
args = append(args, string(buff))
}
if len(flags) != 0 {
args = append(args, flags...)
}
if len(buff) != 0 && appendFileFlag {
args = append(args, "-f")
args = append(args, manifestPath)
}
args = append(args, "-o")
args = append(args, output)
return args, nil
}
// gjsonLabels is an implementation of labels.Labels interface
// which allows us to take advantage of k8s labels library
// for the purposes of evaluating fail and success conditions
type gjsonLabels struct {
json []byte
}
// Has returns whether the provided label exists.
func (g gjsonLabels) Has(label string) bool {
return gjson.GetBytes(g.json, label).Exists()
}
// Get returns the value for the provided label.
func (g gjsonLabels) Get(label string) string {
return gjson.GetBytes(g.json, label).String()
}
// signalMonitoring start the goroutine which listens for a SIGUSR2.
// Upon receiving of the signal, We update the pod annotation and exit the process.
func (we *WorkflowExecutor) signalMonitoring() {
log.Infof("Starting SIGUSR2 signal monitor")
sigs := make(chan os.Signal, 1)
signal.Notify(sigs, os_specific.GetOsSignal())
go func() {
for {
<-sigs
log.Infof("Received SIGUSR2 signal. Process is terminated")
util.WriteTeriminateMessage("Received user signal to terminate the workflow")
os.Exit(130)
}
}()
}
// WaitResource waits for a specific resource to satisfy either the success or failure condition
func (we *WorkflowExecutor) WaitResource(ctx context.Context, resourceNamespace, resourceName, selfLink string) error {
// Monitor the SIGTERM
we.signalMonitoring()
if we.Template.Resource.SuccessCondition == "" && we.Template.Resource.FailureCondition == "" {
return nil
}
var successReqs labels.Requirements
if we.Template.Resource.SuccessCondition != "" {
successSelector, err := labels.Parse(we.Template.Resource.SuccessCondition)
if err != nil {
return errors.Errorf(errors.CodeBadRequest, "success condition '%s' failed to parse: %v", we.Template.Resource.SuccessCondition, err)
}
log.Infof("Waiting for conditions: %s", successSelector)
successReqs, _ = successSelector.Requirements()
}
var failReqs labels.Requirements
if we.Template.Resource.FailureCondition != "" {
failSelector, err := labels.Parse(we.Template.Resource.FailureCondition)
if err != nil {
return errors.Errorf(errors.CodeBadRequest, "fail condition '%s' failed to parse: %v", we.Template.Resource.FailureCondition, err)
}
log.Infof("Failing for conditions: %s", failSelector)
failReqs, _ = failSelector.Requirements()
}
err := wait.PollImmediateInfinite(envutil.LookupEnvDurationOr("RESOURCE_STATE_CHECK_INTERVAL", time.Second*5),
func() (bool, error) {
isErrRetryable, err := we.checkResourceState(ctx, selfLink, successReqs, failReqs)
if err == nil {
log.Infof("Returning from successful wait for resource %s in namespace %s", resourceName, resourceNamespace)
return true, nil
}
if isErrRetryable || argoerr.IsTransientErr(err) {
log.Infof("Waiting for resource %s in namespace %s resulted in retryable error: %v", resourceName, resourceNamespace, err)
return false, nil
}
log.Warnf("Waiting for resource %s in namespace %s resulted in non-retryable error: %v", resourceName, resourceNamespace, err)
return false, err
})
if err != nil {
if err == wait.ErrWaitTimeout {
log.Warnf("Waiting for resource %s resulted in timeout due to repeated errors", resourceName)
} else {
log.Warnf("Waiting for resource %s resulted in error %v", resourceName, err)
}
return err
}
return nil
}
// checkResourceState performs resource status checking and then waiting on json reading.
// The returning boolean indicates whether we should retry.
func (we *WorkflowExecutor) checkResourceState(ctx context.Context, selfLink string, successReqs labels.Requirements, failReqs labels.Requirements) (bool, error) {
request := we.RESTClient.Get().RequestURI(selfLink)
stream, err := request.Stream(ctx)
if err != nil {
err = errors.Cause(err)
if apierr.IsNotFound(err) {
return false, errors.Errorf(errors.CodeNotFound, "The resource has been deleted while its status was still being checked. Will not be retried: %v", err)
}
return false, err
}
defer func() { _ = stream.Close() }()
jsonBytes, err := ioutil.ReadAll(stream)
if err != nil {
return false, err
}
jsonString := string(jsonBytes)
log.Debug(jsonString)
if !gjson.Valid(jsonString) {
return false, errors.Errorf(errors.CodeNotFound, "Encountered invalid JSON response when checking resource status. Will not be retried: %q", jsonString)
}
return matchConditions(jsonBytes, successReqs, failReqs)
}
// matchConditions checks whether the returned JSON bytes match success or failure conditions.
func matchConditions(jsonBytes []byte, successReqs labels.Requirements, failReqs labels.Requirements) (bool, error) {
ls := gjsonLabels{json: jsonBytes}
for _, req := range failReqs {
failed := req.Matches(ls)
msg := fmt.Sprintf("failure condition '%s' evaluated %v", req, failed)
log.Infof(msg)
if failed {
// We return false here to not retry when failure conditions met.
return false, errors.Errorf(errors.CodeBadRequest, msg)
}
}
numMatched := 0
for _, req := range successReqs {
matched := req.Matches(ls)
log.Infof("success condition '%s' evaluated %v", req, matched)
if matched {
numMatched++
}
}
log.Infof("%d/%d success conditions matched", numMatched, len(successReqs))
if numMatched >= len(successReqs) {
return false, nil
}
return true, errors.Errorf(errors.CodeNotFound, "Neither success condition nor the failure condition has been matched. Retrying...")
}
// SaveResourceParameters will save any resource output parameters
func (we *WorkflowExecutor) SaveResourceParameters(ctx context.Context, resourceNamespace string, resourceName string) error {
if len(we.Template.Outputs.Parameters) == 0 {
log.Infof("No output parameters")
return nil
}
log.Infof("Saving resource output parameters")
for i, param := range we.Template.Outputs.Parameters {
if param.ValueFrom == nil {
continue
}
if resourceNamespace == "" && resourceName == "" {
output := ""
if param.ValueFrom.Default != nil {
output = param.ValueFrom.Default.String()
}
we.Template.Outputs.Parameters[i].Value = wfv1.AnyStringPtr(output)
continue
}
var cmd *exec.Cmd
if param.ValueFrom.JSONPath != "" {
args := []string{"get", resourceName, "-o", fmt.Sprintf("jsonpath=%s", param.ValueFrom.JSONPath)}
if resourceNamespace != "" {
args = append(args, "-n", resourceNamespace)
}
cmd = exec.Command("kubectl", args...)
} else if param.ValueFrom.JQFilter != "" {
resArgs := []string{resourceName}
if resourceNamespace != "" {
resArgs = append(resArgs, "-n", resourceNamespace)
}
cmdStr := fmt.Sprintf("kubectl get %s -o json | jq -rc '%s'", strings.Join(resArgs, " "), param.ValueFrom.JQFilter)
cmd = exec.Command("sh", "-c", cmdStr)
} else {
continue
}
log.Info(cmd.Args)
out, err := cmd.Output()
if err != nil {
// We have a default value to use instead of returning an error
if param.ValueFrom.Default != nil {
out = []byte(param.ValueFrom.Default.String())
} else {
if exErr, ok := err.(*exec.ExitError); ok {
log.Errorf("`%s` stderr:\n%s", cmd.Args, string(exErr.Stderr))
}
return errors.InternalWrapError(err)
}
}
output := string(out)
we.Template.Outputs.Parameters[i].Value = wfv1.AnyStringPtr(output)
log.Infof("Saved output parameter: %s, value: %s", param.Name, output)
}
err := we.AnnotateOutputs(ctx, nil)
return err
}