-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
azure_pipelines_scaler.go
548 lines (477 loc) · 17.4 KB
/
azure_pipelines_scaler.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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
package scalers
import (
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
"time"
"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/go-logr/logr"
v2 "k8s.io/api/autoscaling/v2"
"k8s.io/metrics/pkg/apis/external_metrics"
kedav1alpha1 "github.com/kedacore/keda/v2/apis/keda/v1alpha1"
"github.com/kedacore/keda/v2/pkg/scalers/azure"
"github.com/kedacore/keda/v2/pkg/scalers/scalersconfig"
kedautil "github.com/kedacore/keda/v2/pkg/util"
)
const (
defaultTargetPipelinesQueueLength = 1
)
type JobRequests struct {
Count int `json:"count"`
Value []JobRequest `json:"value"`
}
const (
// "499b84ac-1321-427f-aa17-267ca6975798" is the azure id for DevOps resource
// https://learn.microsoft.com/en-gb/azure/devops/integrate/get-started/authentication/service-principal-managed-identity?view=azure-devops
devopsResource = "499b84ac-1321-427f-aa17-267ca6975798/.default"
)
type JobRequest struct {
RequestID int `json:"requestId"`
QueueTime time.Time `json:"queueTime"`
AssignTime time.Time `json:"assignTime,omitempty"`
ReceiveTime time.Time `json:"receiveTime,omitempty"`
LockedUntil time.Time `json:"lockedUntil,omitempty"`
ServiceOwner string `json:"serviceOwner"`
HostID string `json:"hostId"`
Result *string `json:"result"`
ScopeID string `json:"scopeId"`
PlanType string `json:"planType"`
PlanID string `json:"planId"`
JobID string `json:"jobId"`
Demands []string `json:"demands"`
ReservedAgent *struct {
Links struct {
Self struct {
Href string `json:"href"`
} `json:"self"`
Web struct {
Href string `json:"href"`
} `json:"web"`
} `json:"_links"`
ID int `json:"id"`
Name string `json:"name"`
Version string `json:"version"`
OsDescription string `json:"osDescription"`
Enabled bool `json:"enabled"`
Status string `json:"status"`
ProvisioningState string `json:"provisioningState"`
AccessPoint string `json:"accessPoint"`
} `json:"reservedAgent,omitempty"`
Definition struct {
Links struct {
Web struct {
Href string `json:"href"`
} `json:"web"`
Self struct {
Href string `json:"href"`
} `json:"self"`
} `json:"_links"`
ID int `json:"id"`
Name string `json:"name"`
} `json:"definition"`
Owner struct {
Links struct {
Web struct {
Href string `json:"href"`
} `json:"web"`
Self struct {
Href string `json:"href"`
} `json:"self"`
} `json:"_links"`
ID int `json:"id"`
Name string `json:"name"`
} `json:"owner"`
Data struct {
ParallelismTag string `json:"ParallelismTag"`
IsScheduledKey string `json:"IsScheduledKey"`
} `json:"data"`
PoolID int `json:"poolId"`
OrchestrationID string `json:"orchestrationId"`
Priority int `json:"priority"`
MatchedAgents *[]struct {
Links struct {
Self struct {
Href string `json:"href"`
} `json:"self"`
Web struct {
Href string `json:"href"`
} `json:"web"`
} `json:"_links"`
ID int `json:"id"`
Name string `json:"name"`
Version string `json:"version"`
Enabled bool `json:"enabled"`
Status string `json:"status"`
ProvisioningState string `json:"provisioningState"`
} `json:"matchedAgents,omitempty"`
}
type azurePipelinesPoolNameResponse struct {
Value []struct {
ID int `json:"id"`
} `json:"value"`
}
type azurePipelinesPoolIDResponse struct {
ID int `json:"id"`
}
type azurePipelinesScaler struct {
metricType v2.MetricTargetType
metadata *azurePipelinesMetadata
httpClient *http.Client
podIdentity kedav1alpha1.AuthPodIdentity
logger logr.Logger
}
type azurePipelinesMetadata struct {
organizationURL string
organizationName string
authContext authContext
parent string
demands string
poolID int
targetPipelinesQueueLength int64
activationTargetPipelinesQueueLength int64
jobsToFetch int64
triggerIndex int
requireAllDemands bool
}
type authContext struct {
cred *azidentity.ChainedTokenCredential
pat string
token *azcore.AccessToken
}
// NewAzurePipelinesScaler creates a new AzurePipelinesScaler
func NewAzurePipelinesScaler(ctx context.Context, config *scalersconfig.ScalerConfig) (Scaler, error) {
httpClient := kedautil.CreateHTTPClient(config.GlobalHTTPTimeout, false)
logger := InitializeLogger(config, "azure_pipelines_scaler")
metricType, err := GetMetricTargetType(config)
if err != nil {
return nil, fmt.Errorf("error getting scaler metric type: %w", err)
}
meta, podIdentity, err := parseAzurePipelinesMetadata(ctx, logger, config, httpClient)
if err != nil {
return nil, fmt.Errorf("error parsing azure Pipelines metadata: %w", err)
}
return &azurePipelinesScaler{
metricType: metricType,
metadata: meta,
httpClient: httpClient,
podIdentity: podIdentity,
logger: logger,
}, nil
}
func getAuthMethod(logger logr.Logger, config *scalersconfig.ScalerConfig) (string, *azidentity.ChainedTokenCredential, kedav1alpha1.AuthPodIdentity, error) {
pat := ""
if val, ok := config.AuthParams["personalAccessToken"]; ok && val != "" {
// Found the personalAccessToken in a parameter from TriggerAuthentication
pat = config.AuthParams["personalAccessToken"]
} else if val, ok := config.TriggerMetadata["personalAccessTokenFromEnv"]; ok && val != "" {
pat = config.ResolvedEnv[config.TriggerMetadata["personalAccessTokenFromEnv"]]
} else {
switch config.PodIdentity.Provider {
case "", kedav1alpha1.PodIdentityProviderNone:
return "", nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("no personalAccessToken given or PodIdentity provider configured")
case kedav1alpha1.PodIdentityProviderAzureWorkload:
cred, err := azure.NewChainedCredential(logger, config.PodIdentity)
if err != nil {
return "", nil, kedav1alpha1.AuthPodIdentity{}, err
}
return "", cred, kedav1alpha1.AuthPodIdentity{Provider: config.PodIdentity.Provider}, nil
default:
return "", nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("pod identity %s not supported for azure pipelines", config.PodIdentity.Provider)
}
}
return pat, nil, kedav1alpha1.AuthPodIdentity{}, nil
}
func parseAzurePipelinesMetadata(ctx context.Context, logger logr.Logger, config *scalersconfig.ScalerConfig, httpClient *http.Client) (*azurePipelinesMetadata, kedav1alpha1.AuthPodIdentity, error) {
meta := azurePipelinesMetadata{}
meta.targetPipelinesQueueLength = defaultTargetPipelinesQueueLength
if val, ok := config.TriggerMetadata["targetPipelinesQueueLength"]; ok {
queueLength, err := strconv.ParseInt(val, 10, 64)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("error parsing azure pipelines metadata targetPipelinesQueueLength: %w", err)
}
meta.targetPipelinesQueueLength = queueLength
}
meta.activationTargetPipelinesQueueLength = 0
if val, ok := config.TriggerMetadata["activationTargetPipelinesQueueLength"]; ok {
activationQueueLength, err := strconv.ParseInt(val, 10, 64)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("error parsing azure pipelines metadata activationTargetPipelinesQueueLength: %w", err)
}
meta.activationTargetPipelinesQueueLength = activationQueueLength
}
if val, ok := config.AuthParams["organizationURL"]; ok && val != "" {
// Found the organizationURL in a parameter from TriggerAuthentication
meta.organizationURL = val
} else if val, ok := config.TriggerMetadata["organizationURLFromEnv"]; ok && val != "" {
meta.organizationURL = config.ResolvedEnv[val]
} else {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("no organizationURL given")
}
if val := meta.organizationURL[strings.LastIndex(meta.organizationURL, "/")+1:]; val != "" {
meta.organizationName = meta.organizationURL[strings.LastIndex(meta.organizationURL, "/")+1:]
} else {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("failed to extract organization name from organizationURL")
}
pat, cred, podIdentity, err := getAuthMethod(logger, config)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, err
}
// Trim any trailing new lines from the Azure Pipelines PAT
meta.authContext = authContext{
pat: strings.TrimSuffix(pat, "\n"),
cred: cred,
token: nil,
}
if val, ok := config.TriggerMetadata["parent"]; ok && val != "" {
meta.parent = config.TriggerMetadata["parent"]
} else {
meta.parent = ""
}
if val, ok := config.TriggerMetadata["demands"]; ok && val != "" {
meta.demands = config.TriggerMetadata["demands"]
} else {
meta.demands = ""
}
meta.jobsToFetch = 250
if val, ok := config.TriggerMetadata["jobsToFetch"]; ok && val != "" {
jobsToFetch, err := strconv.ParseInt(val, 10, 64)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("error parsing jobsToFetch: %w", err)
}
meta.jobsToFetch = jobsToFetch
}
meta.requireAllDemands = false
if val, ok := config.TriggerMetadata["requireAllDemands"]; ok && val != "" {
requireAllDemands, err := strconv.ParseBool(val)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, err
}
meta.requireAllDemands = requireAllDemands
}
if val, ok := config.TriggerMetadata["poolName"]; ok && val != "" {
var err error
poolID, err := getPoolIDFromName(ctx, logger, val, &meta, podIdentity, httpClient)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, err
}
meta.poolID = poolID
} else {
if val, ok := config.TriggerMetadata["poolID"]; ok && val != "" {
var err error
poolID, err := validatePoolID(ctx, logger, val, &meta, podIdentity, httpClient)
if err != nil {
return nil, kedav1alpha1.AuthPodIdentity{}, err
}
meta.poolID = poolID
} else {
return nil, kedav1alpha1.AuthPodIdentity{}, fmt.Errorf("no poolName or poolID given")
}
}
meta.triggerIndex = config.TriggerIndex
return &meta, podIdentity, nil
}
func getPoolIDFromName(ctx context.Context, logger logr.Logger, poolName string, metadata *azurePipelinesMetadata, podIdentity kedav1alpha1.AuthPodIdentity, httpClient *http.Client) (int, error) {
urlString := fmt.Sprintf("%s/_apis/distributedtask/pools?poolName=%s", metadata.organizationURL, url.QueryEscape(poolName))
body, err := getAzurePipelineRequest(ctx, logger, urlString, metadata, podIdentity, httpClient)
if err != nil {
return -1, err
}
var result azurePipelinesPoolNameResponse
err = json.Unmarshal(body, &result)
if err != nil {
return -1, err
}
count := len(result.Value)
if count == 0 {
return -1, fmt.Errorf("agent pool with name `%s` not found", poolName)
}
if count != 1 {
return -1, fmt.Errorf("found %d agent pool with name `%s`", count, poolName)
}
return result.Value[0].ID, nil
}
func validatePoolID(ctx context.Context, logger logr.Logger, poolID string, metadata *azurePipelinesMetadata, podIdentity kedav1alpha1.AuthPodIdentity, httpClient *http.Client) (int, error) {
urlString := fmt.Sprintf("%s/_apis/distributedtask/pools?poolID=%s", metadata.organizationURL, poolID)
body, err := getAzurePipelineRequest(ctx, logger, urlString, metadata, podIdentity, httpClient)
if err != nil {
return -1, fmt.Errorf("agent pool with id `%s` not found: %w", poolID, err)
}
var result azurePipelinesPoolIDResponse
err = json.Unmarshal(body, &result)
if err != nil {
return -1, err
}
return result.ID, nil
}
func getToken(ctx context.Context, metadata *azurePipelinesMetadata, scope string) (string, error) {
if metadata.authContext.token != nil {
//if token expires after more then minute from now let's reuse
if metadata.authContext.token.ExpiresOn.After(time.Now().Add(time.Second * 60)) {
return metadata.authContext.token.Token, nil
}
}
token, err := metadata.authContext.cred.GetToken(ctx, policy.TokenRequestOptions{
Scopes: []string{
scope,
},
})
if err != nil {
return "", err
}
metadata.authContext.token = &token
return metadata.authContext.token.Token, nil
}
func getAzurePipelineRequest(ctx context.Context, logger logr.Logger, urlString string, metadata *azurePipelinesMetadata, podIdentity kedav1alpha1.AuthPodIdentity, httpClient *http.Client) ([]byte, error) {
req, err := http.NewRequestWithContext(ctx, "GET", urlString, nil)
if err != nil {
return []byte{}, err
}
switch podIdentity.Provider {
case "", kedav1alpha1.PodIdentityProviderNone:
//PAT
logger.V(1).Info("making request to ADO REST API using PAT")
req.SetBasicAuth("", metadata.authContext.pat)
case kedav1alpha1.PodIdentityProviderAzureWorkload:
//ADO Resource token
logger.V(1).Info("making request to ADO REST API using managed identity")
aadToken, err := getToken(ctx, metadata, devopsResource)
if err != nil {
return []byte{}, fmt.Errorf("cannot create workload identity credentials: %w", err)
}
logger.V(1).Info("token acquired setting auth header as 'bearer XXXXXX'")
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", aadToken))
}
r, err := httpClient.Do(req)
if err != nil {
return []byte{}, err
}
b, err := io.ReadAll(r.Body)
if err != nil {
return []byte{}, err
}
r.Body.Close()
if !(r.StatusCode >= 200 && r.StatusCode <= 299) {
return []byte{}, fmt.Errorf("the Azure DevOps REST API returned error. urlString: %s status: %d response: %s", urlString, r.StatusCode, string(b))
}
return b, nil
}
func (s *azurePipelinesScaler) GetAzurePipelinesQueueLength(ctx context.Context) (int64, error) {
// HotFix Issue (#4387), $top changes the format of the returned JSON
var urlString string
if s.metadata.parent != "" {
urlString = fmt.Sprintf("%s/_apis/distributedtask/pools/%d/jobrequests", s.metadata.organizationURL, s.metadata.poolID)
} else {
urlString = fmt.Sprintf("%s/_apis/distributedtask/pools/%d/jobrequests?$top=%d", s.metadata.organizationURL, s.metadata.poolID, s.metadata.jobsToFetch)
}
body, err := getAzurePipelineRequest(ctx, s.logger, urlString, s.metadata, s.podIdentity, s.httpClient)
if err != nil {
return -1, err
}
var jrs JobRequests
err = json.Unmarshal(body, &jrs)
if err != nil {
s.logger.Error(err, "Cannot unmarshal ADO JobRequests API response")
return -1, err
}
// for each job check if its parent fulfilled, then demand fulfilled, then finally pool fulfilled
var count int64
for _, job := range stripDeadJobs(jrs.Value) {
if s.metadata.parent == "" && s.metadata.demands == "" {
// no plan defined, just add a count
count++
} else {
if s.metadata.parent == "" {
// doesn't use parent, switch to demand
if getCanAgentDemandFulfilJob(job, s.metadata) {
count++
}
} else {
// does use parent
if getCanAgentParentFulfilJob(job, s.metadata) {
count++
}
}
}
}
return count, err
}
func stripDeadJobs(jobs []JobRequest) []JobRequest {
var filtered []JobRequest
for _, job := range jobs {
if job.Result == nil {
filtered = append(filtered, job)
}
}
return filtered
}
func stripAgentVFromArray(array []string) []string {
var result []string
for _, item := range array {
if !strings.HasPrefix(item, "Agent.Version") {
result = append(result, item)
}
}
return result
}
// Determine if the scaledjob has the right demands to spin up
func getCanAgentDemandFulfilJob(jr JobRequest, metadata *azurePipelinesMetadata) bool {
countDemands := 0
demandsInJob := stripAgentVFromArray(jr.Demands)
demandsInScaler := stripAgentVFromArray(strings.Split(metadata.demands, ","))
for _, demandInJob := range demandsInJob {
for _, demandInScaler := range demandsInScaler {
if demandInJob == demandInScaler {
countDemands++
}
}
}
if metadata.requireAllDemands {
return countDemands == len(demandsInJob) && countDemands == len(demandsInScaler)
}
return countDemands == len(demandsInJob)
}
// Determine if the Job and Parent Agent Template have matching capabilities
func getCanAgentParentFulfilJob(jr JobRequest, metadata *azurePipelinesMetadata) bool {
matchedAgents := jr.MatchedAgents
if matchedAgents == nil {
return false
}
for _, m := range *matchedAgents {
if metadata.parent == m.Name {
return true
}
}
return false
}
func (s *azurePipelinesScaler) GetMetricSpecForScaling(context.Context) []v2.MetricSpec {
externalMetric := &v2.ExternalMetricSource{
Metric: v2.MetricIdentifier{
Name: GenerateMetricNameWithIndex(s.metadata.triggerIndex, kedautil.NormalizeString(fmt.Sprintf("azure-pipelines-%d", s.metadata.poolID))),
},
Target: GetMetricTarget(s.metricType, s.metadata.targetPipelinesQueueLength),
}
metricSpec := v2.MetricSpec{External: externalMetric, Type: externalMetricType}
return []v2.MetricSpec{metricSpec}
}
func (s *azurePipelinesScaler) GetMetricsAndActivity(ctx context.Context, metricName string) ([]external_metrics.ExternalMetricValue, bool, error) {
queueLen, err := s.GetAzurePipelinesQueueLength(ctx)
if err != nil {
s.logger.Error(err, "error getting pipelines queue length")
return []external_metrics.ExternalMetricValue{}, false, err
}
metric := GenerateMetricInMili(metricName, float64(queueLen))
return []external_metrics.ExternalMetricValue{metric}, queueLen > s.metadata.activationTargetPipelinesQueueLength, nil
}
func (s *azurePipelinesScaler) Close(context.Context) error {
if s.httpClient != nil {
s.httpClient.CloseIdleConnections()
}
return nil
}