-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Philip Laine <philip.laine@gmail.com>
- Loading branch information
1 parent
669777a
commit 78ce3dc
Showing
5 changed files
with
266 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // SPDX-FileCopyrightText: 2021-Present The Zarf Authors | ||
|
|
||
| package packager2 | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "runtime" | ||
| "slices" | ||
|
|
||
| "helm.sh/helm/v3/pkg/action" | ||
| "helm.sh/helm/v3/pkg/cli" | ||
| "helm.sh/helm/v3/pkg/storage/driver" | ||
|
|
||
| "github.com/zarf-dev/zarf/src/api/v1alpha1" | ||
| "github.com/zarf-dev/zarf/src/config" | ||
| "github.com/zarf-dev/zarf/src/pkg/cluster" | ||
| "github.com/zarf-dev/zarf/src/pkg/message" | ||
| "github.com/zarf-dev/zarf/src/pkg/packager/actions" | ||
| "github.com/zarf-dev/zarf/src/pkg/packager/filters" | ||
| "github.com/zarf-dev/zarf/src/types" | ||
| ) | ||
|
|
||
| // RemoveOptions are the options for Remove. | ||
| type RemoveOptions struct { | ||
| Cluster *cluster.Cluster | ||
| OptionalComponents string | ||
| Pkg v1alpha1.ZarfPackage | ||
| } | ||
|
|
||
| // Remove removes a package that was already deployed onto a cluster, uninstalling all installed helm charts. | ||
| func Remove(ctx context.Context, opt RemoveOptions) error { | ||
| // If components were provided; just remove the things we were asked to remove | ||
| filter := filters.Combine( | ||
| filters.ByLocalOS(runtime.GOOS), | ||
| filters.BySelectState(opt.OptionalComponents), | ||
| ) | ||
| components, err := filter.Apply(opt.Pkg) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // Check that cluster is configured if required. | ||
| requiresCluster := false | ||
| componentIdx := map[string]v1alpha1.ZarfComponent{} | ||
| for _, component := range components { | ||
| componentIdx[component.Name] = component | ||
| if component.RequiresCluster() { | ||
| if opt.Cluster == nil { | ||
| return fmt.Errorf("component %s requires cluster access but none was configured", component.Name) | ||
| } | ||
| requiresCluster = true | ||
| } | ||
| } | ||
|
|
||
| // Get or build the secret for the deployed package | ||
| depPkg := &types.DeployedPackage{} | ||
| if requiresCluster { | ||
| depPkg, err = opt.Cluster.GetDeployedPackage(ctx, opt.Pkg.Metadata.Name) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to load the secret for the package we are attempting to remove: %s", err.Error()) | ||
| } | ||
| } else { | ||
| // If we do not need the cluster, create a deployed components object based on the info we have | ||
| depPkg.Name = opt.Pkg.Metadata.Name | ||
| depPkg.Data = opt.Pkg | ||
| for _, component := range components { | ||
| depPkg.DeployedComponents = append(depPkg.DeployedComponents, types.DeployedComponent{Name: component.Name}) | ||
| } | ||
| } | ||
|
|
||
| reverseDepComps := depPkg.DeployedComponents | ||
| slices.Reverse(reverseDepComps) | ||
| for i, depComp := range reverseDepComps { | ||
| // Only remove the component if it was requested or if we are removing the whole package. | ||
| comp, ok := componentIdx[depComp.Name] | ||
| if !ok { | ||
| continue | ||
| } | ||
|
|
||
| err := func() error { | ||
| err := actions.Run(ctx, comp.Actions.OnRemove.Defaults, comp.Actions.OnRemove.Before, nil) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to run the before action: %w", err) | ||
| } | ||
|
|
||
| reverseInstalledCharts := depComp.InstalledCharts | ||
| slices.Reverse(reverseInstalledCharts) | ||
| if opt.Cluster != nil { | ||
| for _, chart := range reverseInstalledCharts { | ||
| settings := cli.New() | ||
| actionConfig := &action.Configuration{} | ||
| // TODO (phillebaba): Get credentials from cluster instead of reading again. | ||
| err := actionConfig.Init(settings.RESTClientGetter(), chart.Namespace, "", nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| client := action.NewUninstall(actionConfig) | ||
| client.KeepHistory = false | ||
| client.Wait = true | ||
| client.Timeout = config.ZarfDefaultTimeout | ||
| _, err = client.Run(chart.ChartName) | ||
| if err != nil && !errors.Is(err, driver.ErrReleaseNotFound) { | ||
| return fmt.Errorf("unable to uninstall the helm chart %s in the namespace %s: %w", chart.ChartName, chart.Namespace, err) | ||
| } | ||
| if errors.Is(err, driver.ErrReleaseNotFound) { | ||
| message.Warnf("Helm release for helm chart '%s' in the namespace '%s' was not found. Was it already removed?", chart.ChartName, chart.Namespace) | ||
| } | ||
|
|
||
| // Pop the removed helm chart from the installed charts slice. | ||
| depPkg.DeployedComponents[len(depPkg.DeployedComponents)-i].InstalledCharts = depComp.InstalledCharts[:len(depComp.InstalledCharts)-1] | ||
| err = opt.Cluster.UpdateDeployedPackage(ctx, *depPkg) | ||
| if err != nil { | ||
| // We warn and ignore errors because we may have removed the cluster that this package was inside of | ||
| message.Warnf("Unable to update the secret for package %s, this may be normal if the cluster was removed: %s", depPkg.Name, err.Error()) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| err = actions.Run(ctx, comp.Actions.OnRemove.Defaults, comp.Actions.OnRemove.After, nil) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to run the after action: %w", err) | ||
| } | ||
| err = actions.Run(ctx, comp.Actions.OnRemove.Defaults, comp.Actions.OnRemove.OnSuccess, nil) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to run the success action: %w", err) | ||
| } | ||
|
|
||
| // Pop the removed component from deploy components slice. | ||
| if opt.Cluster != nil { | ||
| depPkg.DeployedComponents = depPkg.DeployedComponents[:len(depPkg.DeployedComponents)-1] | ||
| err = opt.Cluster.UpdateDeployedPackage(ctx, *depPkg) | ||
| if err != nil { | ||
| // We warn and ignore errors because we may have removed the cluster that this package was inside of | ||
| message.Warnf("Unable to update the secret for package %s, this may be normal if the cluster was removed: %s", depPkg.Name, err.Error()) | ||
| } | ||
| } | ||
| return nil | ||
| }() | ||
| if err != nil { | ||
| err := actions.Run(ctx, comp.Actions.OnRemove.Defaults, comp.Actions.OnRemove.OnFailure, nil) | ||
| if err != nil { | ||
| // TODO: I think we should return an error if failure action fails. Does this break existing use cases? | ||
| return fmt.Errorf("unable to run the failure action: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| // All the installed components were deleted, therefore this package is no longer actually deployed | ||
| if opt.Cluster != nil && len(depPkg.DeployedComponents) == 0 { | ||
| err := opt.Cluster.DeleteDeployedPackage(ctx, depPkg.Name) | ||
| if err != nil { | ||
| message.Warnf("Unable to delete the secret for package %s, tis may be normal if the cluster was removed: %s", depPkg.Name, err.Error()) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters