/
delete.go
381 lines (318 loc) · 12 KB
/
delete.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
// Copyright 2024 The Carvel Authors.
// SPDX-License-Identifier: Apache-2.0
package installed
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
"github.com/cppforlife/go-cli-ui/ui"
"github.com/spf13/cobra"
cmdapp "github.com/vmware-tanzu/carvel-kapp-controller/cli/pkg/kctrl/cmd/app"
cmdcore "github.com/vmware-tanzu/carvel-kapp-controller/cli/pkg/kctrl/cmd/core"
"github.com/vmware-tanzu/carvel-kapp-controller/cli/pkg/kctrl/logger"
kcv1alpha1 "github.com/vmware-tanzu/carvel-kapp-controller/pkg/apis/kappctrl/v1alpha1"
kcpkgv1alpha1 "github.com/vmware-tanzu/carvel-kapp-controller/pkg/apis/packaging/v1alpha1"
kcclient "github.com/vmware-tanzu/carvel-kapp-controller/pkg/client/clientset/versioned"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
)
type DeleteOptions struct {
ui ui.UI
statusUI cmdcore.StatusLoggingUI
depsFactory cmdcore.DepsFactory
logger logger.Logger
NamespaceFlags cmdcore.NamespaceFlags
Name string
NoOp bool
WaitFlags cmdcore.WaitFlags
pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts
}
func NewDeleteOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts) *DeleteOptions {
return &DeleteOptions{ui: ui, statusUI: cmdcore.NewStatusLoggingUI(ui), depsFactory: depsFactory, logger: logger, pkgCmdTreeOpts: pkgCmdTreeOpts}
}
func NewDeleteCmd(o *DeleteOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command {
cmd := &cobra.Command{
Use: "delete",
Short: "Uninstall installed package",
RunE: func(_ *cobra.Command, args []string) error { return o.Run(args) },
Example: cmdcore.Examples{
cmdcore.Example{"Delete package install",
[]string{"package", "installed", "delete", "-i", "sample-pkg-install"}},
}.Description("-i", o.pkgCmdTreeOpts),
SilenceUsage: true,
Annotations: map[string]string{cmdapp.TTYByDefaultKey: "",
cmdcore.PackageManagementCommandsHelpGroup.Key: cmdcore.PackageManagementCommandsHelpGroup.Value},
}
o.NamespaceFlags.SetWithPackageCommandTreeOpts(cmd, flagsFactory, o.pkgCmdTreeOpts)
if !o.pkgCmdTreeOpts.PositionalArgs {
cmd.Flags().StringVarP(&o.Name, "package-install", "i", "", "Set installed package name (required)")
cmd.Flags().BoolVar(&o.NoOp, "noop", false, "Ignore resources created by the package install and delete the custom resource itself")
} else {
cmd.Use = "delete INSTALLED_PACKAGE_NAME"
cmd.Args = cobra.ExactArgs(1)
}
o.WaitFlags.Set(cmd, flagsFactory, &cmdcore.WaitFlagsOpts{
AllowDisableWait: false || o.pkgCmdTreeOpts.AlwaysAllowTogglingWait,
DefaultInterval: 1 * time.Second,
DefaultTimeout: 5 * time.Minute,
})
return cmd
}
func (o *DeleteOptions) Run(args []string) error {
if o.pkgCmdTreeOpts.PositionalArgs {
if len(args) > 0 {
o.Name = args[0]
}
}
if len(o.Name) == 0 {
return fmt.Errorf("Expected package install name to be non empty")
}
o.ui.PrintLinef("Delete package install '%s' from namespace '%s'", o.Name, o.NamespaceFlags.Name)
err := o.ui.AskForConfirmation()
if err != nil {
return err
}
kcClient, err := o.depsFactory.KappCtrlClient()
if err != nil {
return nil
}
//TODO: Read warnings flag. Is it needed?
dynamicClient, err := o.depsFactory.DynamicClient(cmdcore.DynamicClientOpts{})
if err != nil {
return nil
}
pkgi, err := kcClient.PackagingV1alpha1().PackageInstalls(o.NamespaceFlags.Name).Get(
context.Background(), o.Name, metav1.GetOptions{})
if err != nil {
if !errors.IsNotFound(err) {
return err
}
o.ui.PrintLinef("Could not find package install '%s' in namespace '%s'. Cleaning up created resources.", o.Name, o.NamespaceFlags.Name)
return o.cleanUpIfInstallNotFound(dynamicClient)
}
o.statusUI.PrintMessagef("Deleting package install '%s' from namespace '%s'", o.Name, o.NamespaceFlags.Name)
if o.NoOp {
err = o.patchNoopDelete(kcClient)
if err != nil {
return err
}
}
err = kcClient.PackagingV1alpha1().PackageInstalls(o.NamespaceFlags.Name).Delete(
context.Background(), o.Name, metav1.DeleteOptions{})
if err != nil {
return err
}
if o.WaitFlags.Enabled {
o.statusUI.PrintMessagef("Waiting for deletion of package install '%s' from namespace '%s'", o.Name, o.NamespaceFlags.Name)
err = o.waitForResourceDelete(kcClient)
if err != nil {
return err
}
}
return o.deleteInstallCreatedResources(pkgi, dynamicClient)
}
func (o *DeleteOptions) patchNoopDelete(client kcclient.Interface) error {
noopDeletePatch := []map[string]interface{}{
{
"op": "add",
"path": "/spec/noopDelete",
"value": true,
},
}
patchJSON, err := json.Marshal(noopDeletePatch)
if err != nil {
return err
}
o.statusUI.PrintMessagef("Ignoring associated resources for package install '%s' in namespace '%s'", o.Name, o.NamespaceFlags.Name)
_, err = client.PackagingV1alpha1().PackageInstalls(o.NamespaceFlags.Name).Patch(context.Background(), o.Name, types.JSONPatchType, patchJSON, metav1.PatchOptions{})
if err != nil {
return err
}
return nil
}
// deletePkgPluginCreatedResources deletes the associated resources which were installed upon installation of the PackageInstall CR
func (o *DeleteOptions) deleteInstallCreatedResources(pkgInstall *kcpkgv1alpha1.PackageInstall, dynamicClient dynamic.Interface) error {
deletedResources := map[CreatedResourceKind]bool{}
for k, resourceName := range pkgInstall.GetAnnotations() {
split := strings.Split(k, "/")
if len(split) <= 1 {
continue
}
resourceKind := CreatedResourceKind(strings.TrimPrefix(split[1], KctrlPkgAnnotationPrefix))
// To support older versions of Tanzu CLI. To be deprecated
resourceKind = CreatedResourceKind(strings.TrimPrefix(resourceKind.AsString(), TanzuPkgAnnotationPrefix))
if deletedResources[resourceKind] {
continue
}
if CreatedResourceKind(resourceKind).Resource() == "" {
continue
}
deletedResources[resourceKind] = true
var apiGroup, version, namespace string
if resourceKind == KindClusterRole || resourceKind == KindClusterRoleBinding {
apiGroup = rbacv1.SchemeGroupVersion.Group
version = rbacv1.SchemeGroupVersion.Version
} else {
apiGroup = corev1.SchemeGroupVersion.Group
version = corev1.SchemeGroupVersion.Version
namespace = o.NamespaceFlags.Name
}
o.statusUI.PrintMessagef("Deleting '%s': %s", resourceKind, resourceName)
err := o.deleteResourceUsingGVR(schema.GroupVersionResource{
Group: apiGroup,
Version: version,
Resource: resourceKind.Resource(),
}, resourceName, namespace, dynamicClient)
if err != nil {
return err
}
}
overlaysSecretName, hasOverlays := pkgInstall.Annotations[yttOverlayAnnotation]
if hasOverlays {
err := o.deleteResourceUsingGVR(schema.GroupVersionResource{
Group: corev1.SchemeGroupVersion.Group,
Version: corev1.SchemeGroupVersion.Version,
Resource: KindSecret.Resource(),
}, overlaysSecretName, o.NamespaceFlags.Name, dynamicClient)
if err != nil {
return err
}
}
return nil
}
func (o *DeleteOptions) cleanUpIfInstallNotFound(dynamicClient dynamic.Interface) error {
err := o.deleteIfExistsAndOwned(
schema.GroupVersionResource{
Group: corev1.SchemeGroupVersion.Group,
Version: corev1.SchemeGroupVersion.Version,
Resource: KindServiceAccount.Resource(),
}, KindServiceAccount.Name(o.Name, o.NamespaceFlags.Name), o.NamespaceFlags.Name, dynamicClient)
if err != nil {
return err
}
err = o.deleteIfExistsAndOwned(
schema.GroupVersionResource{
Group: corev1.SchemeGroupVersion.Group,
Version: corev1.SchemeGroupVersion.Version,
Resource: KindServiceAccount.Resource(),
}, KindClusterRole.Name(o.Name, o.NamespaceFlags.Name), o.NamespaceFlags.Name, dynamicClient)
if err != nil {
return err
}
err = o.deleteIfExistsAndOwned(
schema.GroupVersionResource{
Group: rbacv1.SchemeGroupVersion.Group,
Version: rbacv1.SchemeGroupVersion.Version,
Resource: KindClusterRole.Resource(),
}, KindClusterRole.Name(o.Name, o.NamespaceFlags.Name), "", dynamicClient)
if err != nil {
return err
}
err = o.deleteIfExistsAndOwned(
schema.GroupVersionResource{
Group: rbacv1.SchemeGroupVersion.Group,
Version: rbacv1.SchemeGroupVersion.Version,
Resource: KindClusterRoleBinding.Resource(),
}, KindClusterRoleBinding.Name(o.Name, o.NamespaceFlags.Name), "", dynamicClient)
if err != nil {
return err
}
//Delete ytt overlays secret created by kctrl if any
err = o.deleteIfExistsAndOwned(
schema.GroupVersionResource{
Group: corev1.SchemeGroupVersion.Group,
Version: corev1.SchemeGroupVersion.Version,
Resource: KindSecret.Resource(),
}, fmt.Sprintf("%s-%s-overlays", o.Name, o.NamespaceFlags.Name), o.NamespaceFlags.Name, dynamicClient)
if err != nil {
return err
}
return nil
}
func (o *DeleteOptions) deleteIfExistsAndOwned(groupVersionResource schema.GroupVersionResource, name string, namespace string, dynamicClient dynamic.Interface) error {
resource, err := dynamicClient.Resource(groupVersionResource).Namespace(namespace).Get(context.TODO(), name, metav1.GetOptions{})
if err != nil {
if !errors.IsNotFound(err) {
// Ignoring NotFound errors
return err
}
return nil
}
annotations := resource.GetAnnotations()
pkgiIdentifier := fmt.Sprintf("%s-%s", o.Name, o.NamespaceFlags.Name)
val, found := annotations[KctrlPkgAnnotation]
if !found || val != pkgiIdentifier {
// Do not delete if the resource is not owned by the package, but no need to error out
// To support older version of Tanzu CLI. To be deprecated
val, found = annotations[TanzuPkgAnnotation]
if !found || val != pkgiIdentifier {
return nil
}
}
o.ui.PrintLinef("Deleting '%s': %s", groupVersionResource.Resource, name)
err = dynamicClient.Resource(groupVersionResource).Namespace(namespace).Delete(context.TODO(), name, metav1.DeleteOptions{})
if err != nil {
return err
}
return nil
}
func (o *DeleteOptions) deleteResourceUsingGVR(groupVersionResource schema.GroupVersionResource, name string, namespace string, dynamicClient dynamic.Interface) error {
err := dynamicClient.Resource(groupVersionResource).Namespace(namespace).Delete(context.TODO(), name, metav1.DeleteOptions{})
if err != nil {
return err
}
return nil
}
func (o *DeleteOptions) waitForResourceDelete(kcClient kcclient.Interface) error {
msgsUI := cmdcore.NewDedupingMessagesUI(cmdcore.NewPlainMessagesUI(o.ui))
description := getPackageInstallDescription(o.Name, o.NamespaceFlags.Name)
appStatusTailErrored := false
tailAppStatusOutput := func(tailErrored *bool) {
appWatcher := cmdapp.NewAppTailer(o.NamespaceFlags.Name, o.Name, o.ui, kcClient, cmdapp.AppTailerOpts{
IgnoreNotExists: true,
}, nil)
err := appWatcher.TailAppStatus()
if err != nil {
o.statusUI.PrintMessagef("Error tailing or reconciling app: %s", err.Error())
*tailErrored = true
}
}
go tailAppStatusOutput(&appStatusTailErrored)
if err := wait.Poll(o.WaitFlags.CheckInterval, o.WaitFlags.Timeout, func() (bool, error) {
resource, err := kcClient.PackagingV1alpha1().PackageInstalls(o.NamespaceFlags.Name).Get(
context.Background(), o.Name, metav1.GetOptions{},
)
if err != nil {
if errors.IsNotFound(err) {
msgsUI.NotifySection("%s: DeletionSucceeded", description)
return true, nil
}
return false, err
}
if resource.Generation != resource.Status.ObservedGeneration {
// Should wait for generation to be observed before checking the reconciliation status so that we know we are checking the new spec
return false, nil
}
status := resource.Status.GenericStatus
for _, cond := range status.Conditions {
if appStatusTailErrored {
msgsUI.NotifySection("%s: %s", description, cond.Type)
}
if cond.Type == kcv1alpha1.DeleteFailed && cond.Status == corev1.ConditionTrue {
return false, fmt.Errorf("%s: Deleting: %s. %s", description, status.UsefulErrorMessage, status.FriendlyDescription)
}
}
return false, nil
}); err != nil {
return fmt.Errorf("%s: Deleting: %s", description, err)
}
return nil
}