/
state.go
572 lines (511 loc) · 19.2 KB
/
state.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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
// Copyright 2024 The PipeCD 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 kubernetes
import (
"fmt"
"sort"
"strings"
"time"
appsv1 "k8s.io/api/apps/v1"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
networkingv1 "k8s.io/api/networking/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/client-go/kubernetes/scheme"
"github.com/pipe-cd/pipecd/pkg/model"
)
func MakeKubernetesResourceState(uid string, key ResourceKey, obj *unstructured.Unstructured, now time.Time) model.KubernetesResourceState {
var (
owners = obj.GetOwnerReferences()
ownerIDs = make([]string, 0, len(owners))
creationTime = obj.GetCreationTimestamp()
status, desc = determineResourceHealth(key, obj)
)
for _, owner := range owners {
ownerIDs = append(ownerIDs, string(owner.UID))
}
sort.Strings(ownerIDs)
state := model.KubernetesResourceState{
Id: uid,
OwnerIds: ownerIDs,
// TODO: Think about adding more parents by using label selectors
ParentIds: ownerIDs,
Name: key.Name,
ApiVersion: key.APIVersion,
Kind: key.Kind,
Namespace: obj.GetNamespace(),
HealthStatus: status,
HealthDescription: desc,
CreatedAt: creationTime.Unix(),
UpdatedAt: now.Unix(),
}
return state
}
func determineResourceHealth(key ResourceKey, obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
if !IsKubernetesBuiltInResource(key.APIVersion) {
desc = fmt.Sprintf("\"%s/%s\" was applied successfully but its health status couldn't be determined exactly. (Because tracking status for this kind of resource is not supported yet.)", key.APIVersion, key.Kind)
return
}
switch key.Kind {
case KindDeployment:
return determineDeploymentHealth(obj)
case KindStatefulSet:
return determineStatefulSetHealth(obj)
case KindDaemonSet:
return determineDaemonSetHealth(obj)
case KindReplicaSet:
return determineReplicaSetHealth(obj)
case KindPod:
return determinePodHealth(obj)
case KindJob:
return determineJobHealth(obj)
case KindCronJob:
return determineCronJobHealth(obj)
case KindService:
return determineServiceHealth(obj)
case KindIngress:
return determineIngressHealth(obj)
case KindConfigMap:
return determineConfigMapHealth(obj)
case KindPersistentVolume:
return determinePersistentVolumeHealth(obj)
case KindPersistentVolumeClaim:
return determinePVCHealth(obj)
case KindSecret:
return determineSecretHealth(obj)
case KindServiceAccount:
return determineServiceAccountHealth(obj)
case KindRole:
return determineRoleHealth(obj)
case KindRoleBinding:
return determineRoleBindingHealth(obj)
case KindClusterRole:
return determineClusterRoleHealth(obj)
case KindClusterRoleBinding:
return determineClusterRoleBindingHealth(obj)
case KindNameSpace:
return determineNameSpace(obj)
case KindPodDisruptionBudget:
return determinePodDisruptionBudgetHealth(obj)
default:
desc = "Unimplemented or unknown resource"
return
}
}
func determineRoleHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineRoleBindingHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineClusterRoleHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineClusterRoleBindingHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineDeploymentHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
d := &appsv1.Deployment{}
err := scheme.Scheme.Convert(obj, d, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, d, err)
return
}
status = model.KubernetesResourceState_OTHER
if d.Spec.Paused {
desc = "Deployment is paused"
return
}
// Referred to:
// https://github.com/kubernetes/kubernetes/blob/7942dca975b7be9386540df3c17e309c3cb2de60/staging/src/k8s.io/kubectl/pkg/polymorphichelpers/rollout_status.go#L75
if d.Generation > d.Status.ObservedGeneration {
desc = "Waiting for rollout to finish because observed deployment generation less than desired generation"
return
}
// TimedOutReason is added in a deployment when its newest replica set fails to show any progress
// within the given deadline (progressDeadlineSeconds).
const timedOutReason = "ProgressDeadlineExceeded"
var cond *appsv1.DeploymentCondition
for i := range d.Status.Conditions {
c := d.Status.Conditions[i]
if c.Type == appsv1.DeploymentProgressing {
cond = &c
break
}
}
if cond != nil && cond.Reason == timedOutReason {
desc = fmt.Sprintf("Deployment %q exceeded its progress deadline", obj.GetName())
}
if d.Spec.Replicas == nil {
desc = "The number of desired replicas is unspecified"
return
}
if d.Status.UpdatedReplicas < *d.Spec.Replicas {
desc = fmt.Sprintf("Waiting for remaining %d/%d replicas to be updated", d.Status.UpdatedReplicas, *d.Spec.Replicas)
return
}
if d.Status.UpdatedReplicas < d.Status.Replicas {
desc = fmt.Sprintf("%d old replicas are pending termination", d.Status.Replicas-d.Status.UpdatedReplicas)
return
}
if d.Status.AvailableReplicas < d.Status.Replicas {
desc = fmt.Sprintf("Waiting for remaining %d/%d replicas to be available", d.Status.Replicas-d.Status.AvailableReplicas, d.Status.Replicas)
return
}
status = model.KubernetesResourceState_HEALTHY
return
}
func determineStatefulSetHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
s := &appsv1.StatefulSet{}
err := scheme.Scheme.Convert(obj, s, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, s, err)
return
}
// Referred to:
// https://github.com/kubernetes/kubernetes/blob/7942dca975b7be9386540df3c17e309c3cb2de60/staging/src/k8s.io/kubectl/pkg/polymorphichelpers/rollout_status.go#L130-L149
status = model.KubernetesResourceState_OTHER
if s.Status.ObservedGeneration == 0 || s.Generation > s.Status.ObservedGeneration {
desc = "Waiting for statefulset spec update to be observed"
return
}
if s.Spec.Replicas == nil {
desc = "The number of desired replicas is unspecified"
return
}
if *s.Spec.Replicas != s.Status.ReadyReplicas {
desc = fmt.Sprintf("The number of ready replicas (%d) is different from the desired number (%d)", s.Status.ReadyReplicas, *s.Spec.Replicas)
return
}
// Check if the partitioned roll out is in progress.
if s.Spec.UpdateStrategy.Type == appsv1.RollingUpdateStatefulSetStrategyType && s.Spec.UpdateStrategy.RollingUpdate != nil {
if s.Spec.Replicas != nil && s.Spec.UpdateStrategy.RollingUpdate.Partition != nil {
if s.Status.UpdatedReplicas < (*s.Spec.Replicas - *s.Spec.UpdateStrategy.RollingUpdate.Partition) {
desc = fmt.Sprintf("Waiting for partitioned roll out to finish because %d out of %d new pods have been updated",
s.Status.UpdatedReplicas, (*s.Spec.Replicas - *s.Spec.UpdateStrategy.RollingUpdate.Partition))
return
}
}
status = model.KubernetesResourceState_HEALTHY
return
}
if s.Status.UpdateRevision != s.Status.CurrentRevision {
desc = fmt.Sprintf("Waiting for statefulset rolling update to complete %d pods at revision %s", s.Status.UpdatedReplicas, s.Status.UpdateRevision)
return
}
status = model.KubernetesResourceState_HEALTHY
return
}
func determineDaemonSetHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
d := &appsv1.DaemonSet{}
err := scheme.Scheme.Convert(obj, d, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, d, err)
return
}
// Referred to:
// https://github.com/kubernetes/kubernetes/blob/7942dca975b7be9386540df3c17e309c3cb2de60/staging/src/k8s.io/kubectl/pkg/polymorphichelpers/rollout_status.go#L107-L115
status = model.KubernetesResourceState_OTHER
if d.Status.ObservedGeneration == 0 || d.Generation > d.Status.ObservedGeneration {
desc = "Waiting for rollout to finish because observed daemon set generation less than desired generation"
return
}
if d.Status.UpdatedNumberScheduled < d.Status.DesiredNumberScheduled {
desc = fmt.Sprintf("Waiting for daemon set %q rollout to finish because %d out of %d new pods have been updated", d.Name, d.Status.UpdatedNumberScheduled, d.Status.DesiredNumberScheduled)
return
}
if d.Status.NumberAvailable < d.Status.DesiredNumberScheduled {
desc = fmt.Sprintf("Waiting for daemon set %q rollout to finish because %d of %d updated pods are available", d.Name, d.Status.NumberAvailable, d.Status.DesiredNumberScheduled)
return
}
if d.Status.NumberMisscheduled > 0 {
desc = fmt.Sprintf("%d nodes that are running the daemon pod, but are not supposed to run the daemon pod", d.Status.NumberMisscheduled)
return
}
if d.Status.NumberUnavailable > 0 {
desc = fmt.Sprintf("%d nodes that should be running the daemon pod and have none of the daemon pod running and available", d.Status.NumberUnavailable)
return
}
status = model.KubernetesResourceState_HEALTHY
return
}
func determineReplicaSetHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
r := &appsv1.ReplicaSet{}
err := scheme.Scheme.Convert(obj, r, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, r, err)
return
}
status = model.KubernetesResourceState_OTHER
if r.Status.ObservedGeneration == 0 || r.Generation > r.Status.ObservedGeneration {
desc = "Waiting for rollout to finish because observed replica set generation less than desired generation"
return
}
var cond *appsv1.ReplicaSetCondition
for i := range r.Status.Conditions {
c := r.Status.Conditions[i]
if c.Type == appsv1.ReplicaSetReplicaFailure {
cond = &c
break
}
}
switch {
case cond != nil && cond.Status == corev1.ConditionTrue:
desc = cond.Message
return
case r.Spec.Replicas == nil:
desc = "The number of desired replicas is unspecified"
return
case r.Status.AvailableReplicas < *r.Spec.Replicas:
desc = fmt.Sprintf("Waiting for rollout to finish because only %d/%d replicas are available", r.Status.AvailableReplicas, *r.Spec.Replicas)
return
case *r.Spec.Replicas != r.Status.ReadyReplicas:
desc = fmt.Sprintf("The number of ready replicas (%d) is different from the desired number (%d)", r.Status.ReadyReplicas, *r.Spec.Replicas)
return
}
status = model.KubernetesResourceState_HEALTHY
return
}
func determineCronJobHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineJobHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
job := &batchv1.Job{}
err := scheme.Scheme.Convert(obj, job, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, job, err)
return
}
var (
failed bool
completed bool
message string
)
for _, condition := range job.Status.Conditions {
switch condition.Type {
case batchv1.JobFailed:
failed = true
completed = true
message = condition.Message
case batchv1.JobComplete:
completed = true
message = condition.Message
}
if failed {
break
}
}
switch {
case !completed:
status = model.KubernetesResourceState_HEALTHY
desc = "Job is in progress"
case failed:
status = model.KubernetesResourceState_OTHER
desc = message
default:
status = model.KubernetesResourceState_HEALTHY
desc = message
}
return
}
func determinePodHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
p := &corev1.Pod{}
err := scheme.Scheme.Convert(obj, p, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, p, err)
return
}
// Determine based on its container statuses.
if p.Spec.RestartPolicy == corev1.RestartPolicyAlways {
var messages []string
for _, s := range p.Status.ContainerStatuses {
waiting := s.State.Waiting
if waiting == nil {
continue
}
if strings.HasPrefix(waiting.Reason, "Err") || strings.HasSuffix(waiting.Reason, "Error") || strings.HasSuffix(waiting.Reason, "BackOff") {
status = model.KubernetesResourceState_OTHER
messages = append(messages, waiting.Message)
}
}
if status == model.KubernetesResourceState_OTHER {
desc = strings.Join(messages, ", ")
return
}
}
// Determine based on its phase.
switch p.Status.Phase {
case corev1.PodRunning, corev1.PodSucceeded:
status = model.KubernetesResourceState_HEALTHY
desc = p.Status.Message
default:
status = model.KubernetesResourceState_OTHER
desc = p.Status.Message
}
return
}
func determineIngressHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
check := func(ingressList []corev1.LoadBalancerIngress) {
if len(ingressList) == 0 {
status = model.KubernetesResourceState_OTHER
desc = "Ingress points for the load-balancer are in progress"
return
}
status = model.KubernetesResourceState_HEALTHY
}
v1Ingress := &networkingv1.Ingress{}
err := scheme.Scheme.Convert(obj, v1Ingress, nil)
if err == nil {
check(v1Ingress.Status.LoadBalancer.Ingress)
return
}
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, v1Ingress, err)
return
}
func determineServiceHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
s := &corev1.Service{}
err := scheme.Scheme.Convert(obj, s, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, s, err)
return
}
status = model.KubernetesResourceState_HEALTHY
if s.Spec.Type != corev1.ServiceTypeLoadBalancer {
return
}
if len(s.Status.LoadBalancer.Ingress) == 0 {
status = model.KubernetesResourceState_OTHER
desc = "Ingress points for the load-balancer are in progress"
return
}
return
}
func determineConfigMapHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineSecretHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determinePersistentVolumeHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
pv := &corev1.PersistentVolume{}
err := scheme.Scheme.Convert(obj, pv, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, pv, err)
return
}
switch pv.Status.Phase {
case corev1.VolumeBound, corev1.VolumeAvailable:
status = model.KubernetesResourceState_HEALTHY
desc = pv.Status.Message
default:
status = model.KubernetesResourceState_OTHER
desc = pv.Status.Message
}
return
}
func determinePVCHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
pvc := &corev1.PersistentVolumeClaim{}
err := scheme.Scheme.Convert(obj, pvc, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, pvc, err)
return
}
switch pvc.Status.Phase {
case corev1.ClaimLost:
status = model.KubernetesResourceState_OTHER
desc = "Lost its underlying PersistentVolume"
case corev1.ClaimPending:
status = model.KubernetesResourceState_OTHER
desc = "Being not yet bound"
case corev1.ClaimBound:
status = model.KubernetesResourceState_HEALTHY
default:
status = model.KubernetesResourceState_OTHER
desc = "The current phase of PersistentVolumeClaim is unexpected"
}
return
}
func determineServiceAccountHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determinePodDisruptionBudgetHealth(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
desc = fmt.Sprintf("%q was applied successfully", obj.GetName())
status = model.KubernetesResourceState_HEALTHY
return
}
func determineNameSpace(obj *unstructured.Unstructured) (status model.KubernetesResourceState_HealthStatus, desc string) {
ns := &corev1.Namespace{}
err := scheme.Scheme.Convert(obj, ns, nil)
if err != nil {
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("Unexpected error while calculating: unable to convert %T to %T: %v", obj, ns, err)
return
}
switch ns.Status.Phase {
case corev1.NamespaceActive:
// Go to determine based on the status' conditions.
case corev1.NamespaceTerminating:
status = model.KubernetesResourceState_OTHER
desc = "NameSpace is gracefully terminated"
return
default:
status = model.KubernetesResourceState_OTHER
desc = fmt.Sprintf("The NameSpace is at an unexpected phase: %s", ns.Status.Phase)
return
}
status = model.KubernetesResourceState_HEALTHY
var cond *corev1.NamespaceCondition
for i := range ns.Status.Conditions {
c := ns.Status.Conditions[i]
switch c.Type {
case corev1.NamespaceDeletionDiscoveryFailure, corev1.NamespaceDeletionContentFailure, corev1.NamespaceDeletionGVParsingFailure:
cond = &c
}
if cond != nil {
break
}
}
if cond != nil && cond.Status == corev1.ConditionTrue {
status = model.KubernetesResourceState_OTHER
desc = cond.Message
return
}
return
}