kubernetes: k8s.io/kubernetes/pkg/kubectl/cmd/util/editor Index | Files | Directories

package editor

import "k8s.io/kubernetes/pkg/kubectl/cmd/util/editor"

Index

Package Files

editoptions.go editor.go

func GetApplyPatch Uses

func GetApplyPatch(obj runtime.Unstructured) ([]byte, []byte, types.PatchType, error)

GetApplyPatch is used to get and apply patches

type EditMode Uses

type EditMode string

EditMode can be either NormalEditMode, EditBeforeCreateMode or ApplyEditMode

const (
    // NormalEditMode is an edit mode
    NormalEditMode EditMode = "normal_mode"

    // EditBeforeCreateMode is an edit mode
    EditBeforeCreateMode EditMode = "edit_before_create_mode"

    // ApplyEditMode is an edit mode
    ApplyEditMode EditMode = "edit_last_applied_mode"
)

type EditOptions Uses

type EditOptions struct {
    resource.FilenameOptions
    RecordFlags *genericclioptions.RecordFlags

    PrintFlags *genericclioptions.PrintFlags
    ToPrinter  func(string) (printers.ResourcePrinter, error)

    OutputPatch        bool
    WindowsLineEndings bool

    cmdutil.ValidateOptions

    OriginalResult *resource.Result

    EditMode EditMode

    CmdNamespace    string
    ApplyAnnotation bool
    ChangeCause     string

    genericclioptions.IOStreams

    Recorder genericclioptions.Recorder
    // contains filtered or unexported fields
}

EditOptions contains all the options for running edit cli command.

func NewEditOptions Uses

func NewEditOptions(editMode EditMode, ioStreams genericclioptions.IOStreams) *EditOptions

NewEditOptions returns an initialized EditOptions instance

func (*EditOptions) Complete Uses

func (o *EditOptions) Complete(f cmdutil.Factory, args []string, cmd *cobra.Command) error

Complete completes all the required options

func (*EditOptions) Run Uses

func (o *EditOptions) Run() error

Run performs the execution

func (*EditOptions) Validate Uses

func (o *EditOptions) Validate() error

Validate checks the EditOptions to see if there is sufficient information to run the command.

type Editor Uses

type Editor struct {
    Args  []string
    Shell bool
}

Editor holds the command-line args to fire up the editor

func NewDefaultEditor Uses

func NewDefaultEditor(envs []string) Editor

NewDefaultEditor creates a struct Editor that uses the OS environment to locate the editor program, looking at EDITOR environment variable to find the proper command line. If the provided editor has no spaces, or no quotes, it is treated as a bare command to be loaded. Otherwise, the string will be passed to the user's shell for execution.

func (Editor) Launch Uses

func (e Editor) Launch(path string) error

Launch opens the described or returns an error. The TTY will be protected, and SIGQUIT, SIGTERM, and SIGINT will all be trapped.

func (Editor) LaunchTempFile Uses

func (e Editor) LaunchTempFile(prefix, suffix string, r io.Reader) ([]byte, string, error)

LaunchTempFile reads the provided stream into a temporary file in the given directory and file prefix, and then invokes Launch with the path of that file. It will return the contents of the file after launch, any errors that occur, and the path of the temporary file so the caller can clean it up as needed.

Directories

PathSynopsis
crlf

Package editor imports 35 packages (graph) and is imported by 114 packages. Updated 2019-07-23. Refresh now. Tools for package owners.