common

Documentation

Index

• Constants
• Variables
• func AliasFlags(_ *pflag.FlagSet, name string) pflag.NormalizedName
• func FillOutSpecGen(s *specgen.SpecGenerator, c *ContainerCLIOpts, args []string) error
• func GetCreateFlags(cf *ContainerCLIOpts) *pflag.FlagSet
• func GetNetFlags() *pflag.FlagSet
• func NetFlagsToNetOptions(cmd *cobra.Command) (*entities.NetOptions, error)
• func ReadPodIDFile(path string) (string, error)
• func ReadPodIDFiles(files []string) ([]string, error)
• type ContainerCLIOpts

Constants

const (
	// TypeBind is the type for mounting host dir
	TypeBind = "bind"
	// TypeVolume is the type for named volumes
	TypeVolume = "volume"
	// TypeTmpfs is the type for mounting tmpfs
	TypeTmpfs = "tmpfs"
)

Variables

var (
	// DefaultHealthCheckInterval default value
	DefaultHealthCheckInterval = "30s"
	// DefaultHealthCheckRetries default value
	DefaultHealthCheckRetries uint = 3
	// DefaultHealthCheckStartPeriod default value
	DefaultHealthCheckStartPeriod = "0s"
	// DefaultHealthCheckTimeout default value
	DefaultHealthCheckTimeout = "30s"
	// DefaultImageVolume default value
	DefaultImageVolume = "bind"
)

Functions

func AliasFlags

func AliasFlags(_ *pflag.FlagSet, name string) pflag.NormalizedName

func FillOutSpecGen

func FillOutSpecGen(s *specgen.SpecGenerator, c *ContainerCLIOpts, args []string) error

func GetCreateFlags

func GetCreateFlags(cf *ContainerCLIOpts) *pflag.FlagSet

func GetNetFlags

func GetNetFlags() *pflag.FlagSet

func NetFlagsToNetOptions

func NetFlagsToNetOptions(cmd *cobra.Command) (*entities.NetOptions, error)

func ReadPodIDFile

func ReadPodIDFile(path string) (string, error)

ReadPodIDFile reads the specified file and returns its content (i.e., first line).

func ReadPodIDFiles

func ReadPodIDFiles(files []string) ([]string, error)

ReadPodIDFiles reads the specified files and returns their content (i.e., first line).

Types

type ContainerCLIOpts

type ContainerCLIOpts struct {
	Annotation        []string
	Attach            []string
	Authfile          string
	BlkIOWeight       string
	BlkIOWeightDevice []string
	CapAdd            []string
	CapDrop           []string
	CgroupNS          string
	CGroupsMode       string
	CGroupParent      string
	CIDFile           string
	ConmonPIDFile     string
	CPUPeriod         uint64
	CPUQuota          int64
	CPURTPeriod       uint64
	CPURTRuntime      int64
	CPUShares         uint64
	CPUS              float64
	CPUSetCPUs        string
	CPUSetMems        string
	Detach            bool
	DetachKeys        string
	Devices           []string
	DeviceCGroupRule  []string
	DeviceReadBPs     []string
	DeviceReadIOPs    []string
	DeviceWriteBPs    []string
	DeviceWriteIOPs   []string
	Entrypoint        *string
	Env               []string
	EnvHost           bool
	EnvFile           []string
	Expose            []string
	GIDMap            []string
	GroupAdd          []string
	HealthCmd         string
	HealthInterval    string
	HealthRetries     uint
	HealthStartPeriod string
	HealthTimeout     string
	Hostname          string
	HTTPProxy         bool
	ImageVolume       string
	Init              bool
	InitPath          string
	Interactive       bool
	IPC               string
	KernelMemory      string
	Label             []string
	LabelFile         []string
	LogDriver         string
	LogOptions        []string
	Memory            string
	MemoryReservation string
	MemorySwap        string
	MemorySwappiness  int64
	Name              string
	NoHealthCheck     bool
	OOMKillDisable    bool
	OOMScoreAdj       int
	OverrideArch      string
	OverrideOS        string
	PID               string
	PIDsLimit         *int64
	Pod               string
	PodIDFile         string
	Privileged        bool
	PublishAll        bool
	Pull              string
	Quiet             bool
	ReadOnly          bool
	ReadOnlyTmpFS     bool
	Restart           string
	Replace           bool
	Rm                bool
	RootFS            bool
	SecurityOpt       []string
	ShmSize           string
	StopSignal        string
	StopTimeout       uint
	StoreageOpt       []string
	SubUIDName        string
	SubGIDName        string
	Sysctl            []string
	Systemd           string
	TmpFS             []string
	TTY               bool
	UIDMap            []string
	Ulimit            []string
	User              string
	UserNS            string
	UTS               string
	Mount             []string
	Volume            []string
	VolumesFrom       []string
	Workdir           string
	SeccompPolicy     string

	Net *entities.NetOptions
}