commands

Documentation

Index

• Constants
• Variables
• func CreateSetterCommand(parent string) *cobra.Command
• func CreateSubstCommand(parent string) *cobra.Command
• func DeleteSetterCommand(parent string) *cobra.Command
• func DeleteSubstitutionCommand(parent string) *cobra.Command
• func GetAnthosCommands(name string) []*cobra.Command
• func GetConfigCommand(name string) *cobra.Command
• func GetFnCommand(name string) *cobra.Command
• func GetGuideCommand(name string) *cobra.Command
• func GetKptCommands(name string, f util.Factory) []*cobra.Command
• func GetLiveCommand(name string, f util.Factory) *cobra.Command
• func GetPkgCommand(name string) *cobra.Command
• func GetTTLCommand(name string) *cobra.Command
• func NewCmdInit(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command
• func NewCmdMigrate(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command
• func NormalizeCommand(c ...*cobra.Command)
• func SetCommand(parent string) *cobra.Command
• type InvExistsError
  • func (i *InvExistsError) Error() string
• type KptInitOptions
  • func NewKptInitOptions(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *KptInitOptions
  • func (io *KptInitOptions) Run(args []string) error
• type MigrateRunner
  • func GetMigrateRunner(cmProvider provider.Provider, rgProvider provider.Provider, ...) *MigrateRunner
  • func (mr *MigrateRunner) Run(reader io.Reader, args []string) error

Constants

const ShortHandRef = "$kpt-set"

Variables

var READMEExamples = `
    # run the tutorial for ` + "`" + `kpt cfg annotate` + "`" + `
    kpt ttl cfg annotate

    # run the tutorial at 2x speed
    kpt ttl cfg annotate -s 2

    # run the tutorial at 1/2x speed
    kpt ttl cfg annotate -s 0.5

    # print the full tutorial rather than playing it
    kpt ttl cfg annotate --print`

var READMELong = `
Tutorials simulates running a sequence of commands and their output by playing
an asciinema cast.

Requires [asciinema].
`

var READMEShort = `Run command tutorials`

Functions

func CreateSetterCommand

func CreateSetterCommand(parent string) *cobra.Command

func CreateSubstCommand

func CreateSubstCommand(parent string) *cobra.Command

func DeleteSetterCommand

func DeleteSetterCommand(parent string) *cobra.Command

func DeleteSubstitutionCommand

func DeleteSubstitutionCommand(parent string) *cobra.Command

func GetAnthosCommands

func GetAnthosCommands(name string) []*cobra.Command

func GetConfigCommand

func GetConfigCommand(name string) *cobra.Command

func GetFnCommand

func GetFnCommand(name string) *cobra.Command

func GetGuideCommand

func GetGuideCommand(name string) *cobra.Command

func GetKptCommands

func GetKptCommands(name string, f util.Factory) []*cobra.Command

GetKptCommands returns the set of kpt commands to be registered

func GetLiveCommand

func GetLiveCommand(name string, f util.Factory) *cobra.Command

func GetPkgCommand

func GetPkgCommand(name string) *cobra.Command

func GetTTLCommand

func GetTTLCommand(name string) *cobra.Command

func NewCmdInit

func NewCmdInit(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

NewCmdInit returns the cobra command for the init command.

func NewCmdMigrate

func NewCmdMigrate(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command

NewCmdMigrate returns the cobra command for the migrate command.

func NormalizeCommand

func NormalizeCommand(c ...*cobra.Command)

NormalizeCommand will modify commands to be consistent, e.g. silencing errors

func SetCommand

func SetCommand(parent string) *cobra.Command

SetCommand wraps the kustomize set command in order to automatically update a project number if a project id is set.

Types

type InvExistsError

type InvExistsError struct{}

InvExistsError defines new error when the inventory values have already been set on the Kptfile.

func (*InvExistsError) Error

func (i *InvExistsError) Error() string

type KptInitOptions

type KptInitOptions struct {
	// contains filtered or unexported fields
}

KptInitOptions encapsulates fields for kpt init command. This init command fills in inventory values in the Kptfile.

func NewKptInitOptions

func NewKptInitOptions(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *KptInitOptions

NewKptInitOptions returns a pointer to an initial KptInitOptions structure.

func (*KptInitOptions) Run

func (io *KptInitOptions) Run(args []string) error

Complete fills in fields for KptInitOptions based on the passed "args".

type MigrateRunner

type MigrateRunner struct {
	Command *cobra.Command
	// contains filtered or unexported fields
}

MigrateRunner encapsulates fields for the kpt migrate command.

func GetMigrateRunner

func GetMigrateRunner(cmProvider provider.Provider, rgProvider provider.Provider, ioStreams genericclioptions.IOStreams) *MigrateRunner

NewMigrateRunner returns a pointer to an initial MigrateRunner structure.

func (*MigrateRunner) Run

func (mr *MigrateRunner) Run(reader io.Reader, args []string) error

Run executes the migration from the ConfigMap based inventory to the ResourceGroup based inventory.