cli

Documentation

Index

• Constants
• func AliasFlags(f *pflag.FlagSet, name string) pflag.NormalizedName
• func DefaultFormat() string
• func DefaultHistory() bool
• func DefaultIsolation() string
• func GetBudFlags(flags *BudResults) pflag.FlagSet
• func GetFromAndBudFlags(flags *FromAndBudResults, usernsResults *UserNSResults, ...) (pflag.FlagSet, error)
• func GetLayerFlags(flags *LayerResults) pflag.FlagSet
• func GetNameSpaceFlags(flags *NameSpaceResults) pflag.FlagSet
• func GetUserNSFlags(flags *UserNSResults) pflag.FlagSet
• func UseLayers() bool
• func VerifyFlagsArgsOrder(args []string) error
• type BudResults
• type FromAndBudResults
• type LayerResults
• type NameSpaceResults
• type UserNSResults

Constants

const (
	// ExecErrorCodeGeneric is the default error code to return from an exec session if libpod failed
	// prior to calling the runtime
	ExecErrorCodeGeneric = 125
	// ExecErrorCodeCannotInvoke is the error code to return when the runtime fails to invoke a command
	// an example of this can be found by trying to execute a directory:
	// `podman exec -l /etc`
	ExecErrorCodeCannotInvoke = 126
	// ExecErrorCodeNotFound is the error code to return when a command cannot be found
	ExecErrorCodeNotFound = 127
)

Functions

func AliasFlags

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

aliasFlags is a function to handle backwards compatibility with old flags

func DefaultFormat

func DefaultFormat() string

DefaultFormat returns the default image format

func DefaultHistory

func DefaultHistory() bool

DefaultHistory returns the default add-history setting

func DefaultIsolation

func DefaultIsolation() string

DefaultIsolation returns the default image format

func GetBudFlags

func GetBudFlags(flags *BudResults) pflag.FlagSet

GetBudFlags returns common bud flags

func GetFromAndBudFlags

func GetFromAndBudFlags(flags *FromAndBudResults, usernsResults *UserNSResults, namespaceResults *NameSpaceResults) (pflag.FlagSet, error)

func GetLayerFlags

func GetLayerFlags(flags *LayerResults) pflag.FlagSet

GetLayerFlags returns the common flags for layers

func GetNameSpaceFlags

func GetNameSpaceFlags(flags *NameSpaceResults) pflag.FlagSet

GetNameSpaceFlags returns the common flags for a namespace menu

func GetUserNSFlags

func GetUserNSFlags(flags *UserNSResults) pflag.FlagSet

GetUserNSFlags returns the common flags for usernamespace

func UseLayers

func UseLayers() bool

UseLayers returns true if BUILDAH_LAYERS is set to "1" or "true" otherwise it returns false

func VerifyFlagsArgsOrder

func VerifyFlagsArgsOrder(args []string) error

Types

type BudResults

type BudResults struct {
	Annotation          []string
	Arch                string
	Authfile            string
	BuildArg            []string
	CacheFrom           string
	CertDir             string
	Compress            bool
	Creds               string
	DisableCompression  bool
	DisableContentTrust bool
	DecryptionKeys      []string
	File                []string
	Format              string
	Iidfile             string
	Label               []string
	Logfile             string
	Loglevel            int
	NoCache             bool
	Timestamp           int64
	OS                  string
	Platform            string
	Pull                bool
	PullAlways          bool
	PullNever           bool
	Quiet               bool
	Rm                  bool
	Runtime             string
	RuntimeFlags        []string
	SignaturePolicy     string
	SignBy              string
	Squash              bool
	Tag                 []string
	Target              string
	TLSVerify           bool
	Jobs                int
	LogRusage           bool
}

BudResults represents the results for Bud flags

type FromAndBudResults

type FromAndBudResults struct {
	AddHost      []string
	BlobCache    string
	CapAdd       []string
	CapDrop      []string
	CgroupParent string
	CPUPeriod    uint64
	CPUQuota     int64
	CPUSetCPUs   string
	CPUSetMems   string
	CPUShares    uint64
	Devices      []string
	DNSSearch    []string
	DNSServers   []string
	DNSOptions   []string
	HTTPProxy    bool
	Isolation    string
	Memory       string
	MemorySwap   string
	OverrideArch string
	OverrideOS   string
	SecurityOpt  []string
	ShmSize      string
	Ulimit       []string
	Volumes      []string
}

FromAndBugResults represents the results for common flags in bud and from

type LayerResults

type LayerResults struct {
	ForceRm bool
	Layers  bool
}

LayerResults represents the results of the layer flags

type NameSpaceResults

type NameSpaceResults struct {
	IPC           string
	Network       string
	CNIConfigDir  string
	CNIPlugInPath string
	PID           string
	UTS           string
}

NameSpaceResults represents the results for Namespace flags

type UserNSResults

type UserNSResults struct {
	UserNS            string
	UserNSUIDMap      []string
	UserNSGIDMap      []string
	UserNSUIDMapUser  string
	UserNSGIDMapGroup string
}

UserNSResults represents the results for the UserNS flags