kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-05-17 18:25:26 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

chore: update help to include bit about default namespace

Browse Source 
Add a blurb to the help output for both 'edit set configmap' and 'edit set secret'
to clarify that whenever a namespace is not specified, the default namespace is
implicitly defined as part of the commands.
This commit is contained in:
Mauren Berti
2024-01-29 22:48:00 -05:00
parent fd09a6ed50
commit ca8d629230
2 changed files with 28 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
kustomize/commands/edit/set/setconfigmap.go
View File

@@ -1,11 +1,14 @@
// Copyright 2023 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
//
//nolint:dupl
package set
import (
"fmt"
"sigs.k8s.io/kustomize/api/konfig"
"github.com/spf13/cobra"
"golang.org/x/exp/slices"
"sigs.k8s.io/kustomize/api/ifc"
@@ -24,16 +27,20 @@ func newCmdSetConfigMap(
var flags util.ConfigMapSecretFlagsAndArgs
cmd := &cobra.Command{
Use: "configmap NAME [--from-literal=key1=value1] [--namespace=namespace-name] [--new-namespace=new-namespace-name]",
Short: "Edits the value for an existing key for a configmap in the kustomization file",
Long: `Edits the value for an existing key in an existing configmap in the kustomization file.
Both configmap name and key name must exist for this command to succeed.`,
Example: `
# Edits an existing configmap in the kustomization file, changing value of key1 to 2
Short: fmt.Sprintf("Edits the value for an existing key for a ConfigMap in the %s file", konfig.DefaultKustomizationFileName()),
Long: fmt.Sprintf(`Edits the value for an existing key in an existing ConfigMap in the %[1]s file.
ConfigMap name, ConfigMap namespace, and key name must match an existing entry in the %[1]s file for this command to succeed.
When namespace is omitted, the default namespace is used.`, konfig.DefaultKustomizationFileName()),
Example: fmt.Sprintf(`
# Edits an existing ConfigMap in the %[1]s file, changing value of key1 to 2, and namespace is implicitly defined as "default"
kustomize edit set configmap my-configmap --from-literal=key1=2
# Edits an existing configmap in the kustomization file, changing namespace to 'new-namespace'
# Edits an existing ConfigMap in the %[1]s file, changing value of key1 to 2, and explicitly define namespace as "default"
kustomize edit set configmap my-configmap --from-literal=key1=2 --namespace default
# Edits an existing ConfigMap in the %[1]s file, changing namespace to "new-namespace"
kustomize edit set configmap my-configmap --namespace=current-namespace --new-namespace=new-namespace
`,
`, konfig.DefaultKustomizationFileName()),
RunE: func(_ *cobra.Command, args []string) error {
return runEditSetConfigMap(flags, fSys, args, ldr, rf)
},

21
kustomize/commands/edit/set/setsecret.go
View File

@@ -1,6 +1,7 @@
// Copyright 2023 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
//
//nolint:dupl
package set
import (
@@ -25,15 +26,19 @@ func newCmdSetSecret(
var flags util.ConfigMapSecretFlagsAndArgs
cmd := &cobra.Command{
Use: "secret NAME [--from-literal=key1=value1] [--namespace=namespace-name] [--new-namespace=new-namespace-name]",
Short: fmt.Sprintf("Edits the value for an existing key for a secret in the %s file", konfig.DefaultKustomizationFileName()),
Long: fmt.Sprintf(`Edits the value for an existing key in an existing secret in the %s file.
Both secret name and key name must exist for this command to succeed.`, konfig.DefaultKustomizationFileName()),
Short: fmt.Sprintf("Edits the value for an existing key for a Secret in the %s file", konfig.DefaultKustomizationFileName()),
Long: fmt.Sprintf(`Edits the value for an existing key in an existing Secret in the %[1]s file.
Secret name, Secret namespace, and key name must match an existing entry in the %[1]s file for this command to succeed.
When namespace is omitted, the default namespace is used.`, konfig.DefaultKustomizationFileName()),
Example: fmt.Sprintf(`
# Edits an existing secret in the %[1]s file, changing the value of key1 to 2
kustomize edit set secret my-secret --from-literal=key1=2
# Edits an existing Secret in the %[1]s file, changing the value of key1 to 2, and namespace is implicitly defined as "default"
kustomize edit set secret my-secret --from-literal=key1=2
# Edits an existing secret in the %[1]s file, changing namespace to 'new-namespace'
kustomize edit set secret my-secret --namespace=current-namespace --new-namespace=new-namespace
# Edits an existing Secret in the %[1]s file, changing the value of key1 to 2, and explicitly define namespace as "default"
kustomize edit set secret my-secret --from-literal=key1=2 --namespace default
# Edits an existing Secret in the %[1]s file, changing namespace to "new-namespace"
kustomize edit set secret my-secret --namespace=current-namespace --new-namespace=new-namespace
`, konfig.DefaultKustomizationFileName()),
RunE: func(_ *cobra.Command, args []string) error {
return runEditSetSecret(flags, fSys, args, ldr, rf)