mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-22 06:47:00 +00:00
b9f05dd357
The PR exposes some of the top level kustomize commands (especially `build`) for reuse in other command line tools (expecially `kubectl`, see #1500). This PR represents option 3 from the following list of ways this exposure could be arranged. 1. Expose the commands in the `api` module. ``` REPO/api/go.mod REPO/api/builtins REPO/api/commands <- new REPO/api/... ``` Disadvantage: This would make `api` module depend on cobra. That's bad for clients that want to depend on the api, but want to write their own commands at their own version of cobra. The `api` module shouldn't depend on UX libraries like cobra. 2. Expose the commands in their own `commands` module. They'd appear alongside `api`, e.g. ` ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/commands/go.mod REPO/commands/build REPO/commands/edit REPO/commands/... ``` Advantage: The commands would be consumed by the kustomize binary and the kubectl binary in the same way. Disadvantage: The kustomize binary module and the commands module could evolve separately with their own version numbers, creating confusion. 3. Expose the commands in the existing `kustomize` module ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/kustomize/go.mod REPO/kustomize/main.go REPO/kustomize/commands/build REPO/kustomize/commands/edit REPO/kustomize/commands/... ``` Outside users, e.g. kubectl, could then ``` import sigs.k8s.io/kustomize/kustomize/v3/commands/build ``` and hopefully still get the `main` package as they do now via: ``` go get sigs.k8s.io/kustomize/kustomize/v3 ``` Advantage: 1) The kustomize binary ships at the same version as the commands - which makes sense as the binary's _version_ refers to how the CLI operates (command names, flags, etc.). This makes it easy to related the version of a kustomize binary with the version of commands running in some other CLI binary. 2) The path to the kustomize binary doesn't change. Disadvantage: It's an atypical Go module arrangement. Usually `main` packages live as leaves under a directory called `cmd` inside a module, rather than at the _top_ of the module. This might cause some problems. If so, we can go with option 4. 4. Same as 3, but move `main.go` (the `main` package) down one step. ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/kustomize/go.mod REPO/kustomize/cmd/main.go REPO/kustomize/commands/build REPO/kustomize/commands/edit REPO/kustomize/commands/... ```
95 lines
3.0 KiB
Go
95 lines
3.0 KiB
Go
// Copyright 2019 The Kubernetes Authors.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package remove
|
|
|
|
import (
|
|
"log"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
"sigs.k8s.io/kustomize/api/filesys"
|
|
"sigs.k8s.io/kustomize/api/konfig"
|
|
"sigs.k8s.io/kustomize/api/types"
|
|
"sigs.k8s.io/kustomize/kustomize/v3/commands/internal/kustfile"
|
|
)
|
|
|
|
type removePatchOptions struct {
|
|
Patch types.Patch
|
|
}
|
|
|
|
// newCmdRemovePatch removes the name of a file containing a patch from the kustomization file.
|
|
func newCmdRemovePatch(fSys filesys.FileSystem) *cobra.Command {
|
|
var o removePatchOptions
|
|
o.Patch.Target = &types.Selector{}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "patch",
|
|
Short: "Removes a patch from " +
|
|
konfig.DefaultKustomizationFileName(),
|
|
Long: `Removes a patch from patches field. The fields specified by flags must
|
|
exactly match the patch item to successfully remote the item.`,
|
|
Example: `
|
|
remove patch --path {filepath} --group {target group name} --version {target version}`,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
err := o.Validate()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return o.RunRemovePatch(fSys)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&o.Patch.Path, "path", "", "Path to the patch file. Cannot be used with --patch at the same time.")
|
|
cmd.Flags().StringVar(&o.Patch.Patch, "patch", "", "Literal string of patch content. Cannot be used with --path at the same time.")
|
|
cmd.Flags().StringVar(&o.Patch.Target.Group, "group", "", "API group in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.Version, "version", "", "API version in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.Kind, "kind", "", "Resource kind in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.Name, "name", "", "Resource name in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.Namespace, "namespace", "", "Resource namespace in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.AnnotationSelector, "annotation-selector", "", "annotationSelector in patch target")
|
|
cmd.Flags().StringVar(&o.Patch.Target.LabelSelector, "label-selector", "", "labelSelector in patch target")
|
|
|
|
return cmd
|
|
}
|
|
|
|
// Validate validates removePatch command.
|
|
func (o *removePatchOptions) Validate() error {
|
|
if o.Patch.Patch != "" && o.Patch.Path != "" {
|
|
return errors.New("patch and path can't be set at the same time")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// RunRemovePatch runs removePatch command (do real work).
|
|
func (o *removePatchOptions) RunRemovePatch(fSys filesys.FileSystem) error {
|
|
mf, err := kustfile.NewKustomizationFile(fSys)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
m, err := mf.Read()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Omit target if it's empty
|
|
emptyTarget := types.Selector{}
|
|
if o.Patch.Target != nil && *o.Patch.Target == emptyTarget {
|
|
o.Patch.Target = nil
|
|
}
|
|
|
|
var patches []types.Patch
|
|
for _, p := range m.Patches {
|
|
if !p.Equals(o.Patch) {
|
|
patches = append(patches, p)
|
|
}
|
|
}
|
|
if len(patches) == len(m.Patches) {
|
|
log.Printf("patch %s doesn't exist in kustomization file", o.Patch)
|
|
return nil
|
|
}
|
|
m.Patches = patches
|
|
|
|
return mf.Write(m)
|
|
}
|