Skip to content

K
k3s
Commit a010d3b1 authored by Kubernetes Submit Queue's avatar Kubernetes Submit Queue Committed by GitHub
Browse files
Options

Merge pull request #34028 from juanvallejo/jvallejo/add-dry-run-flag-kubectl-apply

Automatic merge from submit-queue add --dry-run flag to `kubectl apply, kubectl create` Partially addresses https://github.com/kubernetes/kubernetes/issues/11488 **Release note**: ```release-note release-note-none ``` Related StackOverflow: http://stackoverflow.com/questions/38824409/validate-openshift-objects-defined-in-yaml-before-actually-applying-or-executing This patch adds a `--dry-run` flag to the `apply` command in order to allow validation of objects, without patching or creating them. If a `--dry-run` flag is present and no validation errors are found, the command will exit before "configuring" or creating any objects. @ncdc @fabianofranz
parents 7e6fda2e 63e0279d
Hide whitespace changes
Inline Side-by-side
Showing with 48 additions and 34 deletions
pkg/kubectl/cmd/apply.go
View file @ a010d3b1
...@@ -101,7 +101,8 @@ func NewCmdApply(f cmdutil.Factory, out io.Writer) *cobra.Command { ...@@ -101,7 +101,8 @@ func NewCmdApply(f cmdutil.Factory, out io.Writer) *cobra.Command {
cmdutil.AddValidateFlags(cmd) cmdutil.AddValidateFlags(cmd)
cmd.Flags().StringVarP(&options.Selector, "selector", "l", "", "Selector (label query) to filter on") cmd.Flags().StringVarP(&options.Selector, "selector", "l", "", "Selector (label query) to filter on")
cmd.Flags().Bool("all", false, "[-all] to select all the specified resources.") cmd.Flags().Bool("all", false, "[-all] to select all the specified resources.")
cmdutil.AddOutputFlagsForMutation(cmd) cmdutil.AddDryRunFlag(cmd)
cmdutil.AddPrinterFlags(cmd)
cmdutil.AddRecordFlag(cmd) cmdutil.AddRecordFlag(cmd)
cmdutil.AddInclude3rdPartyFlags(cmd) cmdutil.AddInclude3rdPartyFlags(cmd)
return cmd return cmd
...@@ -148,6 +149,8 @@ func RunApply(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *App ...@@ -148,6 +149,8 @@ func RunApply(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *App
return err return err
} }
dryRun := cmdutil.GetFlagBool(cmd, "dry-run")
encoder := f.JSONEncoder() encoder := f.JSONEncoder()
decoder := f.Decoder(false) decoder := f.Decoder(false)
...@@ -195,47 +198,52 @@ func RunApply(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *App ...@@ -195,47 +198,52 @@ func RunApply(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *App
} }
} }
// Then create the resource and skip the three-way merge if !dryRun {
if err := createAndRefresh(info); err != nil { // Then create the resource and skip the three-way merge
return cmdutil.AddSourceToErr("creating", info.Source, err) if err := createAndRefresh(info); err != nil {
} return cmdutil.AddSourceToErr("creating", info.Source, err)
if uid, err := info.Mapping.UID(info.Object); err != nil { }
return err if uid, err := info.Mapping.UID(info.Object); err != nil {
} else { return err
visitedUids.Insert(string(uid)) } else {
visitedUids.Insert(string(uid))
}
} }
count++ count++
cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, false, "created") cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, dryRun, "created")
return nil return nil
} }
overwrite := cmdutil.GetFlagBool(cmd, "overwrite") if !dryRun {
helper := resource.NewHelper(info.Client, info.Mapping) overwrite := cmdutil.GetFlagBool(cmd, "overwrite")
patcher := NewPatcher(encoder, decoder, info.Mapping, helper, overwrite) helper := resource.NewHelper(info.Client, info.Mapping)
patcher := NewPatcher(encoder, decoder, info.Mapping, helper, overwrite)
patchBytes, err := patcher.patch(info.Object, modified, info.Source, info.Namespace, info.Name)
if err != nil {
return cmdutil.AddSourceToErr(fmt.Sprintf("applying patch:\n%s\nto:\n%v\nfor:", patchBytes, info), info.Source, err)
}
if cmdutil.ShouldRecord(cmd, info) { patchBytes, err := patcher.patch(info.Object, modified, info.Source, info.Namespace, info.Name)
patch, err := cmdutil.ChangeResourcePatch(info, f.Command())
if err != nil { if err != nil {
return err return cmdutil.AddSourceToErr(fmt.Sprintf("applying patch:\n%s\nto:\n%v\nfor:", patchBytes, info), info.Source, err)
} }
_, err = helper.Patch(info.Namespace, info.Name, api.StrategicMergePatchType, patch)
if err != nil { if cmdutil.ShouldRecord(cmd, info) {
return cmdutil.AddSourceToErr(fmt.Sprintf("applying patch:\n%s\nto:\n%v\nfor:", patch, info), info.Source, err) patch, err := cmdutil.ChangeResourcePatch(info, f.Command())
if err != nil {
return err
}
_, err = helper.Patch(info.Namespace, info.Name, api.StrategicMergePatchType, patch)
if err != nil {
return cmdutil.AddSourceToErr(fmt.Sprintf("applying patch:\n%s\nto:\n%v\nfor:", patch, info), info.Source, err)
}
} }
}
if uid, err := info.Mapping.UID(info.Object); err != nil { if uid, err := info.Mapping.UID(info.Object); err != nil {
return err return err
} else { } else {
visitedUids.Insert(string(uid)) visitedUids.Insert(string(uid))
}
} }
count++ count++
cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, false, "configured") cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, dryRun, "configured")
return nil return nil
}) })
......
pkg/kubectl/cmd/create.go
View file @ a010d3b1
...@@ -66,9 +66,10 @@ func NewCmdCreate(f cmdutil.Factory, out io.Writer) *cobra.Command { ...@@ -66,9 +66,10 @@ func NewCmdCreate(f cmdutil.Factory, out io.Writer) *cobra.Command {
cmdutil.AddFilenameOptionFlags(cmd, options, usage) cmdutil.AddFilenameOptionFlags(cmd, options, usage)
cmd.MarkFlagRequired("filename") cmd.MarkFlagRequired("filename")
cmdutil.AddValidateFlags(cmd) cmdutil.AddValidateFlags(cmd)
cmdutil.AddOutputFlagsForMutation(cmd) cmdutil.AddPrinterFlags(cmd)
cmdutil.AddApplyAnnotationFlags(cmd) cmdutil.AddApplyAnnotationFlags(cmd)
cmdutil.AddRecordFlag(cmd) cmdutil.AddRecordFlag(cmd)
cmdutil.AddDryRunFlag(cmd)
cmdutil.AddInclude3rdPartyFlags(cmd) cmdutil.AddInclude3rdPartyFlags(cmd)
// create subcommands // create subcommands
...@@ -116,6 +117,8 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re ...@@ -116,6 +117,8 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re
return err return err
} }
dryRun := cmdutil.GetFlagBool(cmd, "dry-run")
count := 0 count := 0
err = r.Visit(func(info *resource.Info, err error) error { err = r.Visit(func(info *resource.Info, err error) error {
if err != nil { if err != nil {
...@@ -131,8 +134,10 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re ...@@ -131,8 +134,10 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re
} }
} }
if err := createAndRefresh(info); err != nil { if !dryRun {
return cmdutil.AddSourceToErr("creating", info.Source, err) if err := createAndRefresh(info); err != nil {
return cmdutil.AddSourceToErr("creating", info.Source, err)
}
} }
count++ count++
...@@ -140,7 +145,8 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re ...@@ -140,7 +145,8 @@ func RunCreate(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, options *re
if !shortOutput { if !shortOutput {
f.PrintObjectSpecificMessage(info.Object, out) f.PrintObjectSpecificMessage(info.Object, out)
} }
cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, false, "created")
cmdutil.PrintSuccess(mapper, shortOutput, out, info.Mapping.Resource, info.Name, dryRun, "created")
return nil return nil
}) })
if err != nil { if err != nil {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment