|
| 1 | +// Copyright 2023 D2iQ, Inc. All rights reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package deleter |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "fmt" |
| 9 | + "strconv" |
| 10 | + "time" |
| 11 | + |
| 12 | + "github.com/go-logr/logr" |
| 13 | + corev1 "k8s.io/api/core/v1" |
| 14 | + "k8s.io/apimachinery/pkg/api/errors" |
| 15 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 16 | + "k8s.io/apimachinery/pkg/util/wait" |
| 17 | + "sigs.k8s.io/cluster-api/api/v1beta1" |
| 18 | + "sigs.k8s.io/cluster-api/util/conditions" |
| 19 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 20 | + |
| 21 | + "github.com/d2iq-labs/capi-runtime-extensions/pkg/constants" |
| 22 | + "github.com/d2iq-labs/capi-runtime-extensions/pkg/k8s/annotations" |
| 23 | +) |
| 24 | + |
| 25 | +type Deleter struct { |
| 26 | + cluster *v1beta1.Cluster |
| 27 | + client client.Client |
| 28 | + log logr.Logger |
| 29 | +} |
| 30 | + |
| 31 | +type objectMetaList []metav1.ObjectMeta |
| 32 | + |
| 33 | +func (ol objectMetaList) asCommaSeparatedString() string { |
| 34 | + out := "" |
| 35 | + separator := "" |
| 36 | + for n := range ol { |
| 37 | + object := ol[n] |
| 38 | + out += fmt.Sprintf("%s%s/%s", separator, object.Namespace, object.Name) |
| 39 | + separator = ", " |
| 40 | + } |
| 41 | + return out |
| 42 | +} |
| 43 | + |
| 44 | +func New(log logr.Logger, cluster *v1beta1.Cluster, remoteClient client.Client) Deleter { |
| 45 | + return Deleter{ |
| 46 | + cluster: cluster, |
| 47 | + client: remoteClient, |
| 48 | + log: log, |
| 49 | + } |
| 50 | +} |
| 51 | + |
| 52 | +func (d *Deleter) DeleteServicesWithLoadBalancer(ctx context.Context) error { |
| 53 | + err := deleteServicesWithLoadBalancer(ctx, d.client, d.log) |
| 54 | + if err != nil { |
| 55 | + return err |
| 56 | + } |
| 57 | + return nil |
| 58 | +} |
| 59 | + |
| 60 | +func deleteServicesWithLoadBalancer( |
| 61 | + ctx context.Context, |
| 62 | + c client.Client, |
| 63 | + log logr.Logger, |
| 64 | +) error { |
| 65 | + log.Info("Listing Services with type LoadBalancer") |
| 66 | + services := &corev1.ServiceList{} |
| 67 | + err := c.List(ctx, services) |
| 68 | + if err != nil { |
| 69 | + return fmt.Errorf("error listing Services: %w", err) |
| 70 | + } |
| 71 | + |
| 72 | + svcsFailedToBeDeleted := make(objectMetaList, 0) |
| 73 | + for i := range services.Items { |
| 74 | + svc := &services.Items[i] |
| 75 | + if needsDelete(svc) { |
| 76 | + log.Info(fmt.Sprintf("Deleting Service %s/%s", svc.Namespace, svc.Name)) |
| 77 | + if err = c.Delete(ctx, svc); err != nil { |
| 78 | + log.Error( |
| 79 | + err, |
| 80 | + fmt.Sprintf( |
| 81 | + "Error deleting Service %s/%s", |
| 82 | + svc.Namespace, |
| 83 | + svc.Name, |
| 84 | + ), |
| 85 | + ) |
| 86 | + svcsFailedToBeDeleted = append(svcsFailedToBeDeleted, svc.ObjectMeta) |
| 87 | + continue |
| 88 | + } |
| 89 | + if err = waitForServiceDeletion(ctx, c, svc); err != nil { |
| 90 | + log.Error( |
| 91 | + err, |
| 92 | + fmt.Sprintf( |
| 93 | + "Error waiting for Service to be deleted %s/%s", |
| 94 | + svc.Namespace, |
| 95 | + svc.Name, |
| 96 | + ), |
| 97 | + ) |
| 98 | + svcsFailedToBeDeleted = append(svcsFailedToBeDeleted, svc.ObjectMeta) |
| 99 | + } |
| 100 | + } |
| 101 | + } |
| 102 | + if len(svcsFailedToBeDeleted) > 0 { |
| 103 | + return failedToDeleteServicesError(svcsFailedToBeDeleted) |
| 104 | + } |
| 105 | + |
| 106 | + return nil |
| 107 | +} |
| 108 | + |
| 109 | +// needsDelete will return true if the Service needs to be deleted to allow for cluster cleanup. |
| 110 | +func needsDelete(service *corev1.Service) bool { |
| 111 | + if service.Spec.Type != corev1.ServiceTypeLoadBalancer || |
| 112 | + len(service.Status.LoadBalancer.Ingress) == 0 { |
| 113 | + return false |
| 114 | + } |
| 115 | + return service.Status.LoadBalancer.Ingress[0].IP != "" || |
| 116 | + service.Status.LoadBalancer.Ingress[0].Hostname != "" |
| 117 | +} |
| 118 | + |
| 119 | +func waitForServiceDeletion( |
| 120 | + ctx context.Context, |
| 121 | + c client.Client, |
| 122 | + service *corev1.Service, |
| 123 | +) (err error) { |
| 124 | + backoff := wait.Backoff{ |
| 125 | + Duration: 1 * time.Second, |
| 126 | + Factor: 1.5, |
| 127 | + Jitter: 0, |
| 128 | + Steps: 13, |
| 129 | + } |
| 130 | + // the error is always nil to retry but is captured in the named return err |
| 131 | + _ = wait.ExponentialBackoff(backoff, func() (bool, error) { |
| 132 | + key := client.ObjectKey{ |
| 133 | + Namespace: service.Namespace, |
| 134 | + Name: service.Name, |
| 135 | + } |
| 136 | + err = c.Get(ctx, key, service) |
| 137 | + if err != nil { |
| 138 | + if errors.IsNotFound(err) { |
| 139 | + err = nil |
| 140 | + return true, nil |
| 141 | + } |
| 142 | + } |
| 143 | + return false, nil |
| 144 | + }) |
| 145 | + |
| 146 | + return |
| 147 | +} |
| 148 | + |
| 149 | +func failedToDeleteServicesError(svcsFailedToBeDeleted objectMetaList) error { |
| 150 | + //nolint:goerr113 // This error is specific to this function |
| 151 | + return fmt.Errorf("the following Services could not be deleted "+ |
| 152 | + "and must cleaned up manually before deleting the cluster: %s", svcsFailedToBeDeleted.asCommaSeparatedString()) |
| 153 | +} |
| 154 | + |
| 155 | +func ShouldDeleteServicesWithLoadBalancer(cluster *v1beta1.Cluster) (bool, error) { |
| 156 | + // use the Cluster annotations to skip deleting |
| 157 | + val, found := annotations.Get(cluster, constants.LoadBalancerGCAnnotation) |
| 158 | + if !found { |
| 159 | + val = "true" |
| 160 | + } |
| 161 | + shouldDeleteBasedOnAnnotation, err := strconv.ParseBool(val) |
| 162 | + if err != nil { |
| 163 | + return false, fmt.Errorf( |
| 164 | + "converting value %s of annotation %s to bool: %w", |
| 165 | + val, |
| 166 | + constants.LoadBalancerGCAnnotation, |
| 167 | + err, |
| 168 | + ) |
| 169 | + } |
| 170 | + |
| 171 | + // use the Cluster phase to determine if its safe to skip deleting |
| 172 | + // |
| 173 | + // when ClusterPhasePending or ClusterPhaseProvisioning Kubernetes API has not been created |
| 174 | + // and the user would not have been able to create any Kubernetes resources that would prevent cleanup |
| 175 | + //nolint:lll // long URL cannot be split up |
| 176 | + // https://github.com/kubernetes-sigs/cluster-api/blob/7f879be68d15737e335b6cb39d380d1d163e06e6/controllers/cluster_controller_phases.go#L44-L50 |
| 177 | + // |
| 178 | + // when ClusterPhaseDeleting its too late to try to cleanup |
| 179 | + phase := cluster.Status.GetTypedPhase() |
| 180 | + skipDeleteBasedOnPhase := phase == v1beta1.ClusterPhasePending || |
| 181 | + phase == v1beta1.ClusterPhaseProvisioning || |
| 182 | + phase == v1beta1.ClusterPhaseDeleting |
| 183 | + |
| 184 | + // use the Cluster conditions to determine if the API server is even reachable |
| 185 | + controlPlaneReachable := conditions.IsTrue(cluster, v1beta1.ControlPlaneInitializedCondition) |
| 186 | + |
| 187 | + return shouldDeleteBasedOnAnnotation && controlPlaneReachable && !skipDeleteBasedOnPhase, nil |
| 188 | +} |
0 commit comments