diff --git a/cmd/config/docs/commands/delete-setter.md b/cmd/config/docs/commands/delete-setter.md new file mode 100644 index 000000000..9a08e10e4 --- /dev/null +++ b/cmd/config/docs/commands/delete-setter.md @@ -0,0 +1,65 @@ +## delete-setter + +[Alpha] Delete a custom setter for a Resource field + +### Synopsis + +Delete a custom setter for a Resource field. + + DIR + + A directory containing Resource configuration. + + NAME + + The name of the setter to create. + +### Deleting a Custom Setter + +**Given the YAML:** + + # resource.yaml + apiVersion: v1 + kind: Service + metadata: + ... + spec: + ... + ports: + ... + - name: http + port: 8080 # {"type":"integer","x-kustomize":{"partialFieldSetters":[{"name":"http-port","value":"8080"}]}} + ... + +**Delete setter:** + + # delete a setter for ports + $ kustomize cfg set create DIR/ http-port + +comment will be removed for this field is not settable any more. + +**Newly modified YAML:** + + # resource.yaml + apiVersion: v1 + kind: Service + metadata: + ... + spec: + ... + ports: + ... + - name: http + port: 8080 + ... + + +### Deleting a setter used in substitution + +If the setter is also used in substitution, it will ask you to delete the substitution first. + + +### Examples + + # delete a setter for port + kustomize cfg create-setter DIR/ port \ No newline at end of file diff --git a/cmd/config/internal/commands/cmddeletesetter.go b/cmd/config/internal/commands/cmddeletesetter.go index 19fc9253a..5607046f2 100644 --- a/cmd/config/internal/commands/cmddeletesetter.go +++ b/cmd/config/internal/commands/cmddeletesetter.go @@ -6,6 +6,7 @@ package commands import ( "github.com/spf13/cobra" "sigs.k8s.io/kustomize/cmd/config/ext" + "sigs.k8s.io/kustomize/cmd/config/internal/generateddocs/commands" "sigs.k8s.io/kustomize/kyaml/openapi" "sigs.k8s.io/kustomize/kyaml/setters2/settersutil" ) @@ -16,9 +17,9 @@ func NewDeleteSetterRunner(parent string) *DeleteSetterRunner { c := &cobra.Command{ Use: "delete-setter DIR NAME", Args: cobra.MinimumNArgs(2), - Short: "delete values on Resources fields.", - Long: "", - Example: "", + Short: commands.DeleteSetterShort, + Long: commands.DeleteSetterLong, + Example: commands.DeleteSetterExamples, PreRunE: r.preRunE, RunE: r.runE, } diff --git a/cmd/config/internal/generateddocs/commands/docs.go b/cmd/config/internal/generateddocs/commands/docs.go index fb567dbff..9daca802c 100644 --- a/cmd/config/internal/generateddocs/commands/docs.go +++ b/cmd/config/internal/generateddocs/commands/docs.go @@ -89,6 +89,22 @@ var CreateSetterExamples = ` kustomize cfg create-setter DIR/ image-tag v1.0.1 --type "string" \ --field image --description "current stable release"` +var DeleteSetterShort = `[Alpha] Delete a custom setter for a Resource field` +var DeleteSetterLong = ` +Delete a custom setter for a Resource field. + + DIR + + A directory containing Resource configuration. + + NAME + + The name of the setter to create. +` +var DeleteSetterExamples = ` + # delete a setter for port + kustomize cfg create-setter DIR/ port` + var FmtShort = `[Alpha] Format yaml configuration files.` var FmtLong = ` [Alpha] Format yaml configuration files.