|
| 1 | +// Copyright 2023 The Kubernetes Authors. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package set |
| 5 | + |
| 6 | +import ( |
| 7 | + "fmt" |
| 8 | + |
| 9 | + "github.com/spf13/cobra" |
| 10 | + "golang.org/x/exp/slices" |
| 11 | + "sigs.k8s.io/kustomize/api/ifc" |
| 12 | + "sigs.k8s.io/kustomize/api/resource" |
| 13 | + "sigs.k8s.io/kustomize/api/types" |
| 14 | + "sigs.k8s.io/kustomize/kustomize/v5/commands/internal/kustfile" |
| 15 | + "sigs.k8s.io/kustomize/kustomize/v5/commands/internal/util" |
| 16 | + "sigs.k8s.io/kustomize/kyaml/filesys" |
| 17 | +) |
| 18 | + |
| 19 | +func newCmdSetConfigMap( |
| 20 | + fSys filesys.FileSystem, |
| 21 | + ldr ifc.KvLoader, |
| 22 | + rf *resource.Factory, |
| 23 | +) *cobra.Command { |
| 24 | + var flags util.ConfigMapSecretFlagsAndArgs |
| 25 | + cmd := &cobra.Command{ |
| 26 | + Use: "configmap NAME [--from-literal=key1=value1] [--namespace=namespace-name] [--new-namespace=new-namespace-name]", |
| 27 | + Short: "Edits the value for an existing key for a configmap in the kustomization file", |
| 28 | + Long: `Edits the value for an existing key in an existing configmap in the kustomization file. |
| 29 | +Both configmap name and key name must exist for this command to succeed.`, |
| 30 | + Example: ` |
| 31 | + # Edits an existing configmap in the kustomization file, changing value of key1 to 2 |
| 32 | + kustomize edit set configmap my-configmap --from-literal=key1=2 |
| 33 | +
|
| 34 | + # Edits an existing configmap in the kustomization file, changing namespace to 'new-namespace' |
| 35 | + kustomize edit set configmap my-configmap --namespace=current-namespace --new-namespace=new-namespace |
| 36 | +`, |
| 37 | + RunE: func(_ *cobra.Command, args []string) error { |
| 38 | + return runEditSetConfigMap(flags, fSys, args, ldr, rf) |
| 39 | + }, |
| 40 | + } |
| 41 | + |
| 42 | + cmd.Flags().StringArrayVar( |
| 43 | + &flags.LiteralSources, |
| 44 | + util.FromLiteralFlag, |
| 45 | + []string{}, |
| 46 | + "Specify an existing key and a new value to update a ConfigMap (i.e. mykey=newvalue)") |
| 47 | + cmd.Flags().StringVar( |
| 48 | + &flags.Namespace, |
| 49 | + util.NamespaceFlag, |
| 50 | + "", |
| 51 | + "Current namespace of the target ConfigMap") |
| 52 | + cmd.Flags().StringVar( |
| 53 | + &flags.NewNamespace, |
| 54 | + util.NewNamespaceFlag, |
| 55 | + "", |
| 56 | + "New namespace value for the target ConfigMap") |
| 57 | + |
| 58 | + return cmd |
| 59 | +} |
| 60 | + |
| 61 | +func runEditSetConfigMap( |
| 62 | + flags util.ConfigMapSecretFlagsAndArgs, |
| 63 | + fSys filesys.FileSystem, |
| 64 | + args []string, |
| 65 | + ldr ifc.KvLoader, |
| 66 | + rf *resource.Factory, |
| 67 | +) error { |
| 68 | + err := flags.ExpandFileSource(fSys) |
| 69 | + if err != nil { |
| 70 | + return fmt.Errorf("failed to expand file source: %w", err) |
| 71 | + } |
| 72 | + |
| 73 | + err = flags.ValidateSet(args) |
| 74 | + if err != nil { |
| 75 | + return fmt.Errorf("failed to validate flags: %w", err) |
| 76 | + } |
| 77 | + |
| 78 | + // Load the kustomization file. |
| 79 | + mf, err := kustfile.NewKustomizationFile(fSys) |
| 80 | + if err != nil { |
| 81 | + return fmt.Errorf("failed to load kustomization file: %w", err) |
| 82 | + } |
| 83 | + |
| 84 | + kustomization, err := mf.Read() |
| 85 | + if err != nil { |
| 86 | + return fmt.Errorf("failed to read kustomization file: %w", err) |
| 87 | + } |
| 88 | + |
| 89 | + // Updates the existing ConfigMap |
| 90 | + err = setConfigMap(ldr, kustomization, flags, rf) |
| 91 | + if err != nil { |
| 92 | + return fmt.Errorf("failed to create configmap: %w", err) |
| 93 | + } |
| 94 | + |
| 95 | + // Write out the kustomization file with added configmap. |
| 96 | + err = mf.Write(kustomization) |
| 97 | + if err != nil { |
| 98 | + return fmt.Errorf("failed to write kustomization file: %w", err) |
| 99 | + } |
| 100 | + |
| 101 | + return nil |
| 102 | +} |
| 103 | + |
| 104 | +func setConfigMap( |
| 105 | + ldr ifc.KvLoader, |
| 106 | + k *types.Kustomization, |
| 107 | + flags util.ConfigMapSecretFlagsAndArgs, |
| 108 | + rf *resource.Factory, |
| 109 | +) error { |
| 110 | + args, err := findConfigMapArgs(k, flags.Name, flags.Namespace) |
| 111 | + if err != nil { |
| 112 | + return fmt.Errorf("could not set new ConfigMap value: %w", err) |
| 113 | + } |
| 114 | + |
| 115 | + if len(flags.LiteralSources) > 0 { |
| 116 | + err := util.UpdateLiteralSources(&args.GeneratorArgs, flags) |
| 117 | + if err != nil { |
| 118 | + return fmt.Errorf("failed to update literal sources: %w", err) |
| 119 | + } |
| 120 | + } |
| 121 | + |
| 122 | + // update namespace to new one |
| 123 | + if flags.NewNamespace != "" { |
| 124 | + args.Namespace = flags.NewNamespace |
| 125 | + } |
| 126 | + |
| 127 | + // Validate by trying to create corev1.configmap. |
| 128 | + args.Options = types.MergeGlobalOptionsIntoLocal( |
| 129 | + args.Options, k.GeneratorOptions) |
| 130 | + |
| 131 | + _, err = rf.MakeConfigMap(ldr, args) |
| 132 | + if err != nil { |
| 133 | + return fmt.Errorf("failed to validate ConfigMap structure: %w", err) |
| 134 | + } |
| 135 | + |
| 136 | + return nil |
| 137 | +} |
| 138 | + |
| 139 | +// findConfigMapArgs finds the generator arguments corresponding to the specified |
| 140 | +// ConfigMap name. ConfigMap must exist for this command to be successful. |
| 141 | +func findConfigMapArgs(m *types.Kustomization, name, namespace string) (*types.ConfigMapArgs, error) { |
| 142 | + cmIndex := slices.IndexFunc(m.ConfigMapGenerator, func(cmArgs types.ConfigMapArgs) bool { |
| 143 | + return name == cmArgs.Name && util.NamespaceEqual(namespace, cmArgs.Namespace) |
| 144 | + }) |
| 145 | + |
| 146 | + if cmIndex == -1 { |
| 147 | + return nil, fmt.Errorf("unable to find ConfigMap with name '%q'", name) |
| 148 | + } |
| 149 | + |
| 150 | + return &m.ConfigMapGenerator[cmIndex], nil |
| 151 | +} |
0 commit comments