cmd

Documentation

Index

• func DefaultContainerOpt() mpb.ContainerOption
• func DefaultProgressFormat(p *mpb.Progress) virter.ProgressOpt
• func Execute()
• func GetLocalImage(ctx context.Context, imageName string, source string, v *virter.Virter, ...) (*virter.LocalImage, error)
• func InitVirter() (*virter.Virter, error)
• func LocalImageName(img string) string
• type DiskArg
  • func (d *DiskArg) GetBus() string
  • func (d *DiskArg) GetFormat() string
  • func (d *DiskArg) GetName() string
  • func (d *DiskArg) GetPool() string
  • func (d *DiskArg) GetSizeKiB() uint64
  • func (d *DiskArg) Set(str string) error
  • func (d *DiskArg) Type() string
• type FileVar
  • func (f *FileVar) Set(s string) error
  • func (f *FileVar) String() string
  • func (f *FileVar) Type() string
• type MountArg
  • func (s *MountArg) GetHostPath() string
  • func (s *MountArg) GetVMPath() string
  • func (s *MountArg) Set(str string) error
  • func (s *MountArg) Type() string
• type NICArg
  • func (n *NICArg) GetMAC() string
  • func (n *NICArg) GetModel() string
  • func (n *NICArg) GetSource() string
  • func (n *NICArg) GetType() string
  • func (n *NICArg) Set(str string) error
  • func (n *NICArg) Type() string
• type SSHClientBuilder
  • func (SSHClientBuilder) NewShellClient(hostPort string, sshConfig ssh.ClientConfig) virter.ShellClient
• type ShortFormatter
  • func (f *ShortFormatter) Format(entry *log.Entry) ([]byte, error)
• type Size
  • func (s *Size) UnmarshalText(text []byte) error

Functions

func DefaultContainerOpt

func DefaultContainerOpt() mpb.ContainerOption

func DefaultProgressFormat

func DefaultProgressFormat(p *mpb.Progress) virter.ProgressOpt

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately

func GetLocalImage

func GetLocalImage(ctx context.Context, imageName string, source string, v *virter.Virter, policy pullpolicy.PullPolicy, p virter.ProgressOpt) (*virter.LocalImage, error)

GetLocalImage tries to find the image in local storage.

If the image, given by the imageName is not found in local storage, it is pulled from source. Image names are resolved according to LocalImageName. It is possible to specify: * A local image name. * A name matching an alias in the legacy image registry. * A container registry reference, which will be converted into a compatible local volume name.

func InitVirter

func InitVirter() (*virter.Virter, error)

InitVirter initializes virter by connecting to the local libvirt instance and configures the ssh keystore.

func LocalImageName

func LocalImageName(img string) string

LocalImageName returns the local name for the user-supplied image name.

If supplied with an image name without any registry location, this just returns the original string.

If supplied with an image name with registry location (the registry.example.com in registry.example.com/image:foo), the registry information will be stripped. "/" and ":" will be replaced by "-".

Examples: * local-image -> local-image * image:foo -> image:foo * registry.example.com/image:foo -> image-foo * registry.example.com/namespace/image -> namespace--image-latest

Types

type DiskArg

type DiskArg struct {
	Name   string `arg:"name"`
	Size   Size   `arg:"size"`
	Format string `arg:"format,qcow2"`
	Bus    string `arg:"bus,virtio"`
	Pool   string `arg:"pool,"`
}

DiskArg represents a disk that can be passed to virter via a command line argument.

func (*DiskArg) GetBus

func (d *DiskArg) GetBus() string

func (*DiskArg) GetFormat

func (d *DiskArg) GetFormat() string

func (*DiskArg) GetName

func (d *DiskArg) GetName() string

func (*DiskArg) GetPool

func (d *DiskArg) GetPool() string

func (*DiskArg) GetSizeKiB

func (d *DiskArg) GetSizeKiB() uint64

func (*DiskArg) Set

func (d *DiskArg) Set(str string) error

Set implements flag.Value.Set.

func (*DiskArg) Type

func (d *DiskArg) Type() string

Type implements pflag.Value.Type.

type FileVar

type FileVar struct {
	File *os.File
}

func (*FileVar) Set

func (f *FileVar) Set(s string) error

func (*FileVar) String

func (f *FileVar) String() string

func (*FileVar) Type

func (f *FileVar) Type() string

type MountArg

type MountArg struct {
	HostPath string `arg:"host"`
	VmPath   string `arg:"vm"`
}

func (*MountArg) GetHostPath

func (s *MountArg) GetHostPath() string

func (*MountArg) GetVMPath

func (s *MountArg) GetVMPath() string

func (*MountArg) Set

func (s *MountArg) Set(str string) error

func (*MountArg) Type

func (s *MountArg) Type() string

type NICArg

type NICArg struct {
	NicType string `arg:"type"`
	Source  string `arg:"source"`
	Model   string `arg:"model,virtio"`
	MAC     string `arg:"mac,"`
}

func (*NICArg) GetMAC

func (n *NICArg) GetMAC() string

func (*NICArg) GetModel

func (n *NICArg) GetModel() string

func (*NICArg) GetSource

func (n *NICArg) GetSource() string

func (*NICArg) GetType

func (n *NICArg) GetType() string

func (*NICArg) Set

func (n *NICArg) Set(str string) error

func (*NICArg) Type

func (n *NICArg) Type() string

type SSHClientBuilder

type SSHClientBuilder struct {
}

SSHClientBuilder builds SSH shell clients

func (SSHClientBuilder) NewShellClient

func (SSHClientBuilder) NewShellClient(hostPort string, sshConfig ssh.ClientConfig) virter.ShellClient

NewShellClient returns an SSH shell client

type ShortFormatter

type ShortFormatter struct {
	LevelDesc []string
}

func (*ShortFormatter) Format

func (f *ShortFormatter) Format(entry *log.Entry) ([]byte, error)

type Size

type Size struct {
	KiB uint64
}

func (*Size) UnmarshalText

func (s *Size) UnmarshalText(text []byte) error