-
Notifications
You must be signed in to change notification settings - Fork 134
/
cluster_context.go
504 lines (440 loc) · 16.8 KB
/
cluster_context.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
package context
import (
"encoding/json"
"fmt"
"time"
"github.com/pkg/errors"
log "github.com/sirupsen/logrus"
v1 "k8s.io/api/core/v1"
discovery "k8s.io/api/discovery/v1"
networking "k8s.io/api/networking/v1"
k8s_errors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/clock"
"k8s.io/client-go/informers"
informer "k8s.io/client-go/informers/core/v1"
discovery_informer "k8s.io/client-go/informers/discovery/v1"
network_informer "k8s.io/client-go/informers/networking/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/cache"
"k8s.io/kubelet/pkg/apis/stats/v1alpha1"
"k8s.io/utils/pointer"
"github.com/armadaproject/armada/internal/common/armadacontext"
"github.com/armadaproject/armada/internal/common/cluster"
util2 "github.com/armadaproject/armada/internal/common/util"
"github.com/armadaproject/armada/internal/executor/configuration"
"github.com/armadaproject/armada/internal/executor/domain"
"github.com/armadaproject/armada/internal/executor/util"
)
const podByUIDIndex = "podUID"
type ClusterIdentity interface {
GetClusterId() string
GetClusterPool() string
}
type ClusterContext interface {
ClusterIdentity
AddPodEventHandler(handler cache.ResourceEventHandlerFuncs)
GetBatchPods() ([]*v1.Pod, error)
GetAllPods() ([]*v1.Pod, error)
GetActiveBatchPods() ([]*v1.Pod, error)
GetNodes() ([]*v1.Node, error)
GetNode(nodeName string) (*v1.Node, error)
GetNodeStatsSummary(*armadacontext.Context, *v1.Node) (*v1alpha1.Summary, error)
GetPodEvents(pod *v1.Pod) ([]*v1.Event, error)
GetServices(pod *v1.Pod) ([]*v1.Service, error)
GetIngresses(pod *v1.Pod) ([]*networking.Ingress, error)
GetEndpointSlices(namespace string, labelName string, labelValue string) ([]*discovery.EndpointSlice, error)
SubmitPod(pod *v1.Pod, owner string, ownerGroups []string) (*v1.Pod, error)
SubmitService(service *v1.Service) (*v1.Service, error)
SubmitIngress(ingress *networking.Ingress) (*networking.Ingress, error)
DeletePodWithCondition(pod *v1.Pod, condition func(pod *v1.Pod) bool, pessimistic bool) error
DeletePods(pods []*v1.Pod)
DeleteService(service *v1.Service) error
DeleteIngress(ingress *networking.Ingress) error
AddAnnotation(pod *v1.Pod, annotations map[string]string) error
Stop()
}
type KubernetesClusterContext struct {
clusterId string
pool string
deleteThreadCount int
submittedPods util.PodCache
podsToDelete util.PodCache
podInformer informer.PodInformer
nodeInformer informer.NodeInformer
serviceInformer informer.ServiceInformer
ingressInformer network_informer.IngressInformer
endpointSliceInformer discovery_informer.EndpointSliceInformer
stopper chan struct{}
kubernetesClient kubernetes.Interface
kubernetesClientProvider cluster.KubernetesClientProvider
eventInformer informer.EventInformer
podKillTimeout time.Duration
clock clock.Clock
}
func (c *KubernetesClusterContext) GetClusterId() string {
return c.clusterId
}
func (c *KubernetesClusterContext) GetClusterPool() string {
return c.pool
}
func NewClusterContext(
configuration configuration.ApplicationConfiguration,
minTimeBetweenRepeatDeletionCalls time.Duration,
kubernetesClientProvider cluster.KubernetesClientProvider,
killTimeout time.Duration,
) *KubernetesClusterContext {
kubernetesClient := kubernetesClientProvider.Client()
factory := informers.NewSharedInformerFactoryWithOptions(kubernetesClient, 0)
context := &KubernetesClusterContext{
clusterId: configuration.ClusterId,
pool: configuration.Pool,
deleteThreadCount: configuration.DeleteConcurrencyLimit,
submittedPods: util.NewTimeExpiringPodCache(time.Minute, time.Second, "submitted_job"),
podsToDelete: util.NewTimeExpiringPodCache(minTimeBetweenRepeatDeletionCalls, time.Second, "deleted_job"),
stopper: make(chan struct{}),
podInformer: factory.Core().V1().Pods(),
nodeInformer: factory.Core().V1().Nodes(),
eventInformer: factory.Core().V1().Events(),
serviceInformer: factory.Core().V1().Services(),
ingressInformer: factory.Networking().V1().Ingresses(),
endpointSliceInformer: factory.Discovery().V1().EndpointSlices(),
kubernetesClient: kubernetesClient,
kubernetesClientProvider: kubernetesClientProvider,
podKillTimeout: killTimeout,
clock: clock.RealClock{},
}
context.AddPodEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
pod, ok := obj.(*v1.Pod)
if !ok {
log.Errorf("Failed to process pod event due to it being an unexpected type. Failed to process %+v", obj)
return
}
context.submittedPods.Delete(util.ExtractPodKey(pod))
},
})
// Use node informer so it is initialised properly
context.nodeInformer.Lister()
context.serviceInformer.Lister()
context.ingressInformer.Lister()
context.endpointSliceInformer.Lister()
err := context.eventInformer.Informer().AddIndexers(cache.Indexers{podByUIDIndex: indexPodByUID})
if err != nil {
panic(err)
}
factory.Start(context.stopper)
factory.WaitForCacheSync(context.stopper)
return context
}
func indexPodByUID(obj interface{}) (strings []string, err error) {
event := obj.(*v1.Event)
if event.InvolvedObject.Kind != "Pod" || event.InvolvedObject.UID == "" {
return []string{}, nil
}
return []string{string(event.InvolvedObject.UID)}, nil
}
func (c *KubernetesClusterContext) AddPodEventHandler(handler cache.ResourceEventHandlerFuncs) {
c.podInformer.Informer().AddEventHandler(handler)
}
func (c *KubernetesClusterContext) Stop() {
close(c.stopper)
}
func (c *KubernetesClusterContext) GetActiveBatchPods() ([]*v1.Pod, error) {
return c.podInformer.Lister().List(util.GetManagedPodSelector())
}
func (c *KubernetesClusterContext) GetBatchPods() ([]*v1.Pod, error) {
podsInCluster, err := c.GetActiveBatchPods()
if err != nil {
return nil, err
}
allPods := podsInCluster
allPods = util.MergePodList(allPods, c.submittedPods.GetAll())
return allPods, nil
}
func (c *KubernetesClusterContext) GetAllPods() ([]*v1.Pod, error) {
podsInCluster, err := c.podInformer.Lister().List(labels.Everything())
if err != nil {
return nil, err
}
allPods := podsInCluster
allPods = util.MergePodList(allPods, c.submittedPods.GetAll())
return allPods, nil
}
func (c *KubernetesClusterContext) GetPodEvents(pod *v1.Pod) ([]*v1.Event, error) {
events, err := c.eventInformer.Informer().GetIndexer().ByIndex(podByUIDIndex, string(pod.UID))
if err != nil {
return nil, err
}
var eventsTyped []*v1.Event
for _, untyped := range events {
typed, ok := untyped.(*v1.Event)
if ok {
eventsTyped = append(eventsTyped, typed)
}
}
return eventsTyped, nil
}
func (c *KubernetesClusterContext) GetNodes() ([]*v1.Node, error) {
return c.nodeInformer.Lister().List(labels.Everything())
}
func (c *KubernetesClusterContext) GetNode(nodeName string) (*v1.Node, error) {
return c.nodeInformer.Lister().Get(nodeName)
}
func (c *KubernetesClusterContext) GetNodeStatsSummary(ctx *armadacontext.Context, node *v1.Node) (*v1alpha1.Summary, error) {
request := c.kubernetesClient.
CoreV1().
RESTClient().
Get().
Resource("nodes").
Name(node.Name).
SubResource("proxy", "stats", "summary")
res := request.Do(ctx)
rawJson, err := res.Raw()
if err != nil {
return nil, fmt.Errorf("request error %s (body %s)", err, string(rawJson))
}
summary := &v1alpha1.Summary{}
err = json.Unmarshal(rawJson, summary)
if err != nil {
return nil, fmt.Errorf("unable to unmarshal %s", err)
}
return summary, nil
}
func (c *KubernetesClusterContext) SubmitPod(pod *v1.Pod, owner string, ownerGroups []string) (*v1.Pod, error) {
c.submittedPods.Add(pod)
ownerClient, err := c.kubernetesClientProvider.ClientForUser(owner, ownerGroups)
if err != nil {
return nil, err
}
returnedPod, err := ownerClient.CoreV1().Pods(pod.Namespace).Create(armadacontext.Background(), pod, metav1.CreateOptions{})
if err != nil {
c.submittedPods.Delete(util.ExtractPodKey(pod))
}
return returnedPod, err
}
func (c *KubernetesClusterContext) SubmitService(service *v1.Service) (*v1.Service, error) {
return c.kubernetesClient.CoreV1().Services(service.Namespace).Create(armadacontext.Background(), service, metav1.CreateOptions{})
}
func (c *KubernetesClusterContext) SubmitIngress(ingress *networking.Ingress) (*networking.Ingress, error) {
return c.kubernetesClient.NetworkingV1().Ingresses(ingress.Namespace).Create(armadacontext.Background(), ingress, metav1.CreateOptions{})
}
func (c *KubernetesClusterContext) AddAnnotation(pod *v1.Pod, annotations map[string]string) error {
patch := &domain.Patch{
MetaData: metav1.ObjectMeta{
Annotations: annotations,
},
}
patchBytes, err := json.Marshal(patch)
if err != nil {
return err
}
_, err = c.kubernetesClient.CoreV1().
Pods(pod.Namespace).
Patch(armadacontext.Background(), pod.Name, types.StrategicMergePatchType, patchBytes, metav1.PatchOptions{})
if err != nil {
return err
}
return nil
}
func (c *KubernetesClusterContext) DeletePodWithCondition(pod *v1.Pod, condition func(pod *v1.Pod) bool, pessimistic bool) error {
currentPod, err := c.podInformer.Lister().Pods(pod.Namespace).Get(pod.Name)
if err != nil {
return errors.Errorf("unable to find current pod state for pod %s because %s", pod.Name, err)
}
if !util.IsMarkedForDeletion(currentPod) {
_, err := c.markForDeletion(currentPod)
if err != nil {
return err
}
// Get latest pod state - bypassing cache
timeout, cancel := armadacontext.WithTimeout(armadacontext.Background(), time.Second*10)
defer cancel()
currentPod, err = c.kubernetesClient.CoreV1().Pods(currentPod.Namespace).Get(timeout, currentPod.Name, metav1.GetOptions{})
if err != nil {
return err
}
if !util.IsMarkedForDeletion(currentPod) {
return errors.Errorf("failed to get updated version of pod from kubernetes")
}
}
if !condition(currentPod) {
return fmt.Errorf("pod does not match provided condition")
}
deleteOptions := metav1.DeleteOptions{GracePeriodSeconds: nil}
if pessimistic {
deleteOptions.Preconditions = &metav1.Preconditions{
ResourceVersion: ¤tPod.ResourceVersion,
}
}
if currentPod.DeletionTimestamp != nil {
killTime := currentPod.DeletionTimestamp.
Add(util.GetDeletionGracePeriodOrDefault(currentPod)).
Add(c.podKillTimeout)
if c.clock.Now().After(killTime) {
log.Infof("Pod %s/%s was requested deleted at %s, but is still present. Force killing.", currentPod.Namespace, currentPod.Name, currentPod.DeletionTimestamp)
deleteOptions.GracePeriodSeconds = pointer.Int64(0)
} else {
log.Debugf("Asked to delete pod %s/%s but this pod is already being deleted", currentPod.Namespace, currentPod.Name)
return nil
}
}
err = c.deletePod(currentPod, deleteOptions)
if err != nil && k8s_errors.IsNotFound(err) {
return nil
}
return err
}
func (c *KubernetesClusterContext) DeletePods(pods []*v1.Pod) {
for _, podToDelete := range pods {
c.podsToDelete.AddIfNotExists(podToDelete)
}
}
func (c *KubernetesClusterContext) DeleteService(service *v1.Service) error {
deleteOptions := createDeleteOptions()
err := c.kubernetesClient.CoreV1().Services(service.Namespace).Delete(armadacontext.Background(), service.Name, deleteOptions)
if err != nil && k8s_errors.IsNotFound(err) {
return nil
}
return err
}
func (c *KubernetesClusterContext) DeleteIngress(ingress *networking.Ingress) error {
deleteOptions := createDeleteOptions()
err := c.kubernetesClient.NetworkingV1().Ingresses(ingress.Namespace).Delete(armadacontext.Background(), ingress.Name, deleteOptions)
if err != nil && k8s_errors.IsNotFound(err) {
return nil
}
return err
}
func (c *KubernetesClusterContext) ProcessPodsToDelete() {
pods := c.podsToDelete.GetAll()
util.ProcessItemsWithThreadPool(armadacontext.Background(), c.deleteThreadCount, pods, func(podToDelete *v1.Pod) {
if podToDelete == nil {
return
}
if podToDelete.DeletionTimestamp == nil {
// We've never tried to delete this pod before. Delete using the grace period
c.doDelete(podToDelete, false)
} else {
// we've tried to delete this pod before. If we're after the kill period then force delete
// else it's a no-op
killTime := podToDelete.DeletionTimestamp.
Add(util.GetDeletionGracePeriodOrDefault(podToDelete)).
Add(c.podKillTimeout)
if c.clock.Now().After(killTime) {
log.Infof("Pod %s/%s was requested deleted at %s, but is still present. Force killing.", podToDelete.Namespace, podToDelete.Name, podToDelete.DeletionTimestamp)
c.doDelete(podToDelete, true)
} else {
log.Debugf("Asked to delete pod %s/%s but this pod is already being deleted", podToDelete.Namespace, podToDelete.Name)
}
}
})
}
func (c *KubernetesClusterContext) doDelete(pod *v1.Pod, force bool) {
podId := util.ExtractPodKey(pod)
var err error
if !util.IsMarkedForDeletion(pod) {
updatedPod, annotationErr := c.markForDeletion(pod)
err = annotationErr
if annotationErr == nil {
pod = updatedPod
c.podsToDelete.Update(podId, pod)
}
}
if err == nil {
deleteOptions := metav1.DeleteOptions{GracePeriodSeconds: nil}
if force {
deleteOptions.GracePeriodSeconds = pointer.Int64(0)
}
err = c.deletePod(pod, deleteOptions)
}
if err == nil || k8s_errors.IsNotFound(err) {
c.podsToDelete.Update(podId, nil)
} else {
log.Errorf("Failed to delete pod %s/%s because %s", pod.Namespace, pod.Name, err)
c.podsToDelete.Delete(podId)
}
}
func (c *KubernetesClusterContext) deletePod(pod *v1.Pod, deleteOptions metav1.DeleteOptions) error {
return c.kubernetesClient.CoreV1().Pods(pod.Namespace).Delete(armadacontext.Background(), pod.Name, deleteOptions)
}
func (c *KubernetesClusterContext) markForDeletion(pod *v1.Pod) (*v1.Pod, error) {
annotations := make(map[string]string)
annotationName := domain.MarkedForDeletion
annotations[annotationName] = time.Now().String()
err := c.AddAnnotation(pod, annotations)
pod.Annotations = util2.MergeMaps(pod.Annotations, annotations)
return pod, err
}
func (c *KubernetesClusterContext) GetServices(pod *v1.Pod) ([]*v1.Service, error) {
podAssociationSelector, err := createPodAssociationSelector(pod)
if err != nil {
return []*v1.Service{}, err
}
services, err := c.serviceInformer.Lister().List(*podAssociationSelector)
if err != nil && k8s_errors.IsNotFound(err) {
return []*v1.Service{}, nil
}
if err == nil && services == nil {
services = []*v1.Service{}
}
return services, err
}
func (c *KubernetesClusterContext) GetIngresses(pod *v1.Pod) ([]*networking.Ingress, error) {
podAssociationSelector, err := createPodAssociationSelector(pod)
if err != nil {
return []*networking.Ingress{}, err
}
ingresses, err := c.ingressInformer.Lister().List(*podAssociationSelector)
if err != nil && k8s_errors.IsNotFound(err) {
return []*networking.Ingress{}, nil
}
if err == nil && ingresses == nil {
ingresses = []*networking.Ingress{}
}
return ingresses, err
}
func (c *KubernetesClusterContext) GetEndpointSlices(namespace string, labelName string, labelValue string) ([]*discovery.EndpointSlice, error) {
req, err := labels.NewRequirement(labelName, selection.Equals, []string{labelValue})
if err != nil {
return nil, err
}
selector := labels.NewSelector().Add(*req)
endpointSlices, err := c.endpointSliceInformer.Lister().EndpointSlices(namespace).List(selector)
if err != nil {
return nil, fmt.Errorf("cannot get endpointslices with label #{labelName}=#{labelValue} in namespace #{namespace}: #{err}")
}
return endpointSlices, nil
}
func createPodAssociationSelector(pod *v1.Pod) (*labels.Selector, error) {
jobId, jobIdPresent := pod.Labels[domain.JobId]
queue, queuePresent := pod.Labels[domain.Queue]
podNumber, podNumberPresent := pod.Labels[domain.PodNumber]
if !jobIdPresent || !queuePresent || !podNumberPresent {
return nil, fmt.Errorf("Cannot create pod association selector as pod %s (%s) is missing Armada identifier labels", pod.Name, pod.Namespace)
}
jobIdMatchesSelector, err := labels.NewRequirement(domain.JobId, selection.Equals, []string{jobId})
if err != nil {
return nil, err
}
queueMatchesSelector, err := labels.NewRequirement(domain.Queue, selection.Equals, []string{queue})
if err != nil {
return nil, err
}
podNumberMatchesSelector, err := labels.NewRequirement(domain.PodNumber, selection.Equals, []string{podNumber})
if err != nil {
return nil, err
}
selector := labels.NewSelector().Add(*jobIdMatchesSelector, *queueMatchesSelector, *podNumberMatchesSelector)
return &selector, nil
}
func createDeleteOptions() metav1.DeleteOptions {
gracePeriod := int64(0)
deleteOptions := metav1.DeleteOptions{
GracePeriodSeconds: &gracePeriod,
}
return deleteOptions
}