f2ac9671f0
Automatic merge from submit-queue (batch tested with PRs 57229, 58907). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Abstract cmd valid args get behind the factory **What this PR does / why we need it**: This abstract retrieving the list of handled resources for valid args as a function to follow more conventions. **Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*: Fixes # **Special notes for your reviewer**: **Release note**: ```release-note NONE ```
96 lines
3.6 KiB
Go
96 lines
3.6 KiB
Go
/*
|
|
Copyright 2017 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"io"
|
|
"runtime"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"k8s.io/kubernetes/pkg/kubectl"
|
|
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
|
|
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
|
|
"k8s.io/kubernetes/pkg/kubectl/cmd/util/editor"
|
|
)
|
|
|
|
var (
|
|
applyEditLastAppliedLong = templates.LongDesc(`
|
|
Edit the latest last-applied-configuration annotations of resources from the default editor.
|
|
|
|
The edit-last-applied command allows you to directly edit any API resource you can retrieve via the
|
|
command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR
|
|
environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows.
|
|
You can edit multiple objects, although changes are applied one at a time. The command
|
|
accepts filenames as well as command line arguments, although the files you point to must
|
|
be previously saved versions of resources.
|
|
|
|
The default format is YAML. To edit in JSON, specify "-o json".
|
|
|
|
The flag --windows-line-endings can be used to force Windows line endings,
|
|
otherwise the default for your operating system will be used.
|
|
|
|
In the event an error occurs while updating, a temporary file will be created on disk
|
|
that contains your unapplied changes. The most common error when updating a resource
|
|
is another editor changing the resource on the server. When this occurs, you will have
|
|
to apply your changes to the newer version of the resource, or update your temporary
|
|
saved copy to include the latest resource version.`)
|
|
|
|
applyEditLastAppliedExample = templates.Examples(`
|
|
# Edit the last-applied-configuration annotations by type/name in YAML.
|
|
kubectl apply edit-last-applied deployment/nginx
|
|
|
|
# Edit the last-applied-configuration annotations by file in JSON.
|
|
kubectl apply edit-last-applied -f deploy.yaml -o json`)
|
|
)
|
|
|
|
func NewCmdApplyEditLastApplied(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command {
|
|
options := &editor.EditOptions{
|
|
EditMode: editor.ApplyEditMode,
|
|
}
|
|
validArgs := cmdutil.ValidArgList(f)
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "edit-last-applied (RESOURCE/NAME | -f FILENAME)",
|
|
DisableFlagsInUseLine: true,
|
|
Short: "Edit latest last-applied-configuration annotations of a resource/object",
|
|
Long: applyEditLastAppliedLong,
|
|
Example: applyEditLastAppliedExample,
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
options.ChangeCause = f.Command(cmd, false)
|
|
if err := options.Complete(f, out, errOut, args, cmd); err != nil {
|
|
cmdutil.CheckErr(err)
|
|
}
|
|
if err := options.Run(); err != nil {
|
|
cmdutil.CheckErr(err)
|
|
}
|
|
},
|
|
ValidArgs: validArgs,
|
|
ArgAliases: kubectl.ResourceAliases(validArgs),
|
|
}
|
|
|
|
usage := "to use to edit the resource"
|
|
cmdutil.AddFilenameOptionFlags(cmd, &options.FilenameOptions, usage)
|
|
cmd.Flags().StringVarP(&options.Output, "output", "o", "yaml", "Output format. One of: yaml|json.")
|
|
cmd.Flags().BoolVar(&options.WindowsLineEndings, "windows-line-endings", runtime.GOOS == "windows",
|
|
"Defaults to the line ending native to your platform.")
|
|
cmdutil.AddRecordVarFlag(cmd, &options.Record)
|
|
cmdutil.AddIncludeUninitializedFlag(cmd)
|
|
|
|
return cmd
|
|
}
|