cli

package
v1.42.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2025 License: Apache-2.0 Imports: 28 Imported by: 42

Documentation

Index

Constants

View Source 
const (
	MaxPullPushRetries = 3
	PullPushRetryDelay = 2 * time.Second
)
View Source 
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
)

Variables

This section is empty.

Functions

func AliasFlags added in v1.16.0 

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

AliasFlags is a function to handle backwards compatibility with old flags

func DecryptConfig added in v1.31.0 

func DecryptConfig(decryptionKeys []string) (*encconfig.DecryptConfig, error)

DecryptConfig translates decryptionKeys into a DescriptionConfig structure

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 EncryptConfig added in v1.31.0 

func EncryptConfig(encryptionKeys []string, encryptLayers []int) (*encconfig.EncryptConfig, *[]int, error)

EncryptConfig translates encryptionKeys into a EncriptionsConfig structure

func GenBuildOptions added in v1.26.10 

func GenBuildOptions(c *cobra.Command, inputArgs []string, iopts BuildOptions) (define.BuildOptions, []string, []string, error)

GenBuildOptions translates command line flags into a BuildOptions structure

func GetBudFlags 

func GetBudFlags(flags *BudResults) pflag.FlagSet

GetBudFlags returns common build flags

func GetBudFlagsCompletions added in v1.17.0 

func GetBudFlagsCompletions() commonComp.FlagCompletions

GetBudFlagsCompletions returns the FlagCompletions for the common build flags

func GetFormat added in v1.31.0 

func GetFormat(format string) (string, error)

GetFormat translates format string into either docker or OCI format constant

func GetFromAndBudFlags 

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

GetFromAndBudFlags returns from and build flags

func GetFromAndBudFlagsCompletions added in v1.17.0 

func GetFromAndBudFlagsCompletions() commonComp.FlagCompletions

GetFromAndBudFlagsCompletions returns the FlagCompletions for the from and build flags

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 GetNameSpaceFlagsCompletions added in v1.17.0 

func GetNameSpaceFlagsCompletions() commonComp.FlagCompletions

GetNameSpaceFlagsCompletions returns the FlagCompletions for the namespace flags

func GetUserNSFlags 

func GetUserNSFlags(flags *UserNSResults) pflag.FlagSet

GetUserNSFlags returns the common flags for usernamespace

func GetUserNSFlagsCompletions added in v1.17.0 

func GetUserNSFlagsCompletions() commonComp.FlagCompletions

GetUserNSFlagsCompletions returns the FlagCompletions for the userns flags

func LookupEnvVarReferences added in v1.30.0 

func LookupEnvVarReferences(specs, environ []string) []string

LookupEnvVarReferences returns a copy of specs with keys and values resolved from environ. Strings are in "key=value" form, the same as os.Environ.

  • When a string in specs lacks "=", it is treated as a key and the value is retrieved from environ. When the key is missing from environ, neither the key nor value are returned.

  • When a string in specs lacks "=" and ends with "*", it is treated as a key prefix and any keys with the same prefix in environ are returned.

  • When a string in specs is exactly "*", all keys and values in environ are returned.

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 {
	AllPlatforms        bool
	Annotation          []string
	Authfile            string
	BuildArg            []string
	BuildArgFile        []string
	BuildContext        []string
	CacheFrom           []string
	CacheTo             []string
	CacheTTL            string
	CertDir             string
	Compress            bool
	Creds               string
	CPPFlags            []string
	DisableCompression  bool
	DisableContentTrust bool
	IgnoreFile          string
	File                []string
	Format              string
	From                string
	Iidfile             string
	InheritLabels       bool
	InheritAnnotations  bool
	Label               []string
	LayerLabel          []string
	Logfile             string
	LogSplitByPlatform  bool
	Manifest            string
	NoHostname          bool
	NoHosts             bool
	NoCache             bool
	Timestamp           int64
	OmitHistory         bool
	OCIHooksDir         []string
	Pull                string
	PullAlways          bool
	PullNever           bool
	Quiet               bool
	IdentityLabel       bool
	Rm                  bool
	Runtime             string
	RuntimeFlags        []string
	SbomPreset          string
	SbomScannerImage    string
	SbomScannerCommand  []string
	SbomMergeStrategy   string
	SbomOutput          string
	SbomImgOutput       string
	SbomPurlOutput      string
	SbomImgPurlOutput   string
	Secrets             []string
	SSH                 []string
	SignaturePolicy     string
	SignBy              string
	Squash              bool
	SkipUnusedStages    bool
	Stdin               bool
	Tag                 []string
	BuildOutputs        []string
	Target              string
	TLSVerify           bool
	Jobs                int
	LogRusage           bool
	RusageLogFile       string
	UnsetEnvs           []string
	UnsetLabels         []string
	UnsetAnnotations    []string
	Envs                []string
	OSFeatures          []string
	OSVersion           string
	CWOptions           string
	SBOMOptions         []string
	CompatVolumes       bool
	SourceDateEpoch     string
	RewriteTimestamp    bool
	CreatedAnnotation   bool
}

BudResults represents the results for Build flags

type BuildOptions added in v1.26.10 

type BuildOptions struct {
	*LayerResults
	*BudResults
	*UserNSResults
	*FromAndBudResults
	*NameSpaceResults
	Logwriter *os.File
}

type FromAndBudResults 

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

FromAndBugResults represents the results for common flags in build and from

type LayerResults 

type LayerResults struct {
	ForceRm bool
	Layers  bool
}

LayerResults represents the results of the layer flags

type NameSpaceResults 

type NameSpaceResults struct {
	Cgroup        string
	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
	GroupAdd          []string
	UserNSUIDMap      []string
	UserNSGIDMap      []string
	UserNSUIDMapUser  string
	UserNSGIDMapGroup string
}

UserNSResults represents the results for the UserNS flags

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.