Documentation ¶
Index ¶
- Constants
- Variables
- func CreateContainer(ctx context.Context, c *GenericCLIResults, runtime *libpod.Runtime) (*libpod.Container, *cc.CreateConfig, error)
- func CreateContainerFromCreateConfig(r *libpod.Runtime, createConfig *cc.CreateConfig, ctx context.Context, ...) (*libpod.Container, error)
- func CreatePodStatusResults(ctrStatuses map[string]define.ContainerStatus) (string, error)
- func CreatePortBindings(ports []string) ([]ocicni.PortMapping, error)
- func DefaultPoolSize(name string) int
- func EnvVariablesFromData(data *inspect.ImageData) map[string]string
- func GenerateCommand(command, imageName, name, globalOpts string) ([]string, error)
- func GenerateContainerFilterFuncs(filter, filterValue string, r *libpod.Runtime) (func(container *libpod.Container) bool, error)
- func GenerateKube(name string, service bool, r *libpod.Runtime) (*v1.Pod, *v1.Service, error)
- func GenerateRunEnvironment(name, imageName string, opts map[string]string) []string
- func GenerateRunlabelCommand(runLabel, imageName, name string, opts map[string]string, extraArgs []string, ...) ([]string, []string, error)
- func GetAllLabels(labelFile, inputLabels []string) (map[string]string, error)
- func GetNamespaceOptions(ns []string) ([]libpod.PodCreateOption, error)
- func GetPodStatus(pod *libpod.Pod) (string, error)
- func GetRunlabel(label string, runlabelImage string, ctx context.Context, ...) (string, string, error)
- func GetSystemContext(authfile string) (*types.SystemContext, error)
- func ParallelExecuteWorkerPool(workers int, functions []ParallelWorkerInput) (map[string]error, int)
- func ParallelWorker(wg *sync.WaitGroup, jobs <-chan ParallelWorkerInput, ...)
- func Parallelize(job string) int
- func ParseCreateOpts(ctx context.Context, c *GenericCLIResults, runtime *libpod.Runtime, ...) (*cc.CreateConfig, error)
- func ParseVolumeOptions(opts map[string]string) ([]libpod.VolumeCreateOption, error)
- func SharedRemoveVolumes(ctx context.Context, runtime *libpod.Runtime, vols []string, all, force bool) ([]string, map[string]error, error)
- type BatchContainerStruct
- type CRBool
- type CRFloat64
- type CRInt
- type CRInt64
- type CRString
- type CRStringArray
- type CRStringSlice
- type CRUint
- type CRUint64
- type ContainerSize
- type GenericCLIResult
- type GenericCLIResults
- func (f GenericCLIResults) Bool(flag string) bool
- func (f GenericCLIResults) Changed(flag string) bool
- func (f GenericCLIResults) Float64(flag string) float64
- func (f GenericCLIResults) Int(flag string) int
- func (f GenericCLIResults) Int64(flag string) int64
- func (f GenericCLIResults) IsSet(flag string) bool
- func (f GenericCLIResults) String(flag string) string
- func (f GenericCLIResults) StringArray(flag string) []string
- func (f GenericCLIResults) StringSlice(flag string) []string
- func (f GenericCLIResults) Uint(flag string) uint
- func (f GenericCLIResults) Uint64(flag string) uint64
- func (f GenericCLIResults) Value(flag string) interface{}
- type Job
- type JobFunc
- type JobResult
- type Namespace
- type ParallelWorkerInput
- type Pool
- type PsContainerOutput
- func GetPsContainerOutput(r *libpod.Runtime, opts PsOptions, filters []string, maxWorkers int) ([]PsContainerOutput, error)
- func NewBatchContainer(r *libpod.Runtime, ctr *libpod.Container, opts PsOptions) (PsContainerOutput, error)
- func PBatch(r *libpod.Runtime, containers []*libpod.Container, workers int, opts PsOptions) []PsContainerOutput
- type PsOptions
Constants ¶
const ( PodStateStopped = "Stopped" PodStateRunning = "Running" PodStatePaused = "Paused" PodStateExited = "Exited" PodStateErrored = "Error" PodStateCreated = "Created" )
Variables ¶
var DefaultKernelNamespaces = "cgroup,ipc,net,uts"
Functions ¶
func CreateContainer ¶
func CreateContainer(ctx context.Context, c *GenericCLIResults, runtime *libpod.Runtime) (*libpod.Container, *cc.CreateConfig, error)
func CreatePodStatusResults ¶
func CreatePodStatusResults(ctrStatuses map[string]define.ContainerStatus) (string, error)
func CreatePortBindings ¶
func CreatePortBindings(ports []string) ([]ocicni.PortMapping, error)
CreatePortBindings iterates ports mappings and exposed ports into a format CNI understands
func DefaultPoolSize ¶
DefaultPoolSize provides the maximum number of parallel workers (int) as calculated by a basic heuristic. This can be overridden by the --max-workers primary switch to podman.
func EnvVariablesFromData ¶
EnvVariablesFromData gets sets the default environment variables for containers, and reads the variables from the image data, if present.
func GenerateCommand ¶
GenerateCommand takes a label (string) and converts it to an executable command
func GenerateContainerFilterFuncs ¶
func GenerateContainerFilterFuncs(filter, filterValue string, r *libpod.Runtime) (func(container *libpod.Container) bool, error)
GenerateContainerFilterFuncs return ContainerFilter functions based of filter.
func GenerateKube ¶
GenerateKube generates kubernetes yaml based on a pod or container.
func GenerateRunEnvironment ¶
GenerateRunEnvironment merges the current environment variables with optional environment variables provided by the user
func GenerateRunlabelCommand ¶
func GenerateRunlabelCommand(runLabel, imageName, name string, opts map[string]string, extraArgs []string, globalOpts string) ([]string, []string, error)
GenerateRunlabelCommand generates the command that will eventually be execucted by Podman.
func GetAllLabels ¶
GetAllLabels ...
func GetNamespaceOptions ¶
func GetNamespaceOptions(ns []string) ([]libpod.PodCreateOption, error)
GetNamespaceOptions transforms a slice of kernel namespaces into a slice of pod create options. Currently, not all kernel namespaces are supported, and they will be returned in an error
func GetPodStatus ¶
GetPodStatus determines the status of the pod based on the statuses of the containers in the pod. Returns a string representation of the pod status
func GetRunlabel ¶
func GetRunlabel(label string, runlabelImage string, ctx context.Context, runtime *libpod.Runtime, pull bool, inputCreds string, dockerRegistryOptions image.DockerRegistryOptions, authfile string, signaturePolicyPath string, output io.Writer) (string, string, error)
GetRunlabel is a helper function for runlabel; it gets the image if needed and begins the construction of the runlabel output and environment variables.
func GetSystemContext ¶
func GetSystemContext(authfile string) (*types.SystemContext, error)
func ParallelExecuteWorkerPool ¶
func ParallelExecuteWorkerPool(workers int, functions []ParallelWorkerInput) (map[string]error, int)
ParallelExecuteWorkerPool takes container jobs and performs them in parallel. The worker int determines how many workers/threads should be premade.
func ParallelWorker ¶
func ParallelWorker(wg *sync.WaitGroup, jobs <-chan ParallelWorkerInput, results chan<- containerError)
ParallelWorker is a "threaded" worker that takes jobs from the channel "queue"
func Parallelize ¶
Parallelize provides the maximum number of parallel workers (int) as calculated by a basic heuristic. This can be overridden by the --max-workers primary switch to podman.
func ParseCreateOpts ¶
func ParseCreateOpts(ctx context.Context, c *GenericCLIResults, runtime *libpod.Runtime, imageName string, data *inspect.ImageData) (*cc.CreateConfig, error)
Parses CLI options related to container creation into a config which can be parsed into an OCI runtime spec
func ParseVolumeOptions ¶
func ParseVolumeOptions(opts map[string]string) ([]libpod.VolumeCreateOption, error)
Handle volume options from CLI. Parse "o" option to find UID, GID.
Types ¶
type BatchContainerStruct ¶
type BatchContainerStruct struct { ConConfig *libpod.ContainerConfig ConState define.ContainerStatus ExitCode int32 Exited bool Pid int StartedTime time.Time ExitedTime time.Time Size *ContainerSize }
BatchContainerStruct is the return object from BatchContainer and contains container related information.
func BatchContainerOp ¶
func BatchContainerOp(ctr *libpod.Container, opts PsOptions) (BatchContainerStruct, error)
BatchContainerOp is used in ps to reduce performance hits by "batching" locks.
type CRBool ¶
type CRBool struct { Val bool // contains filtered or unexported fields }
CRBool describes a bool cli struct
type CRFloat64 ¶
type CRFloat64 struct { Val float64 // contains filtered or unexported fields }
CRFloat64 describes a float64 cli struct
type CRInt ¶
type CRInt struct { Val int // contains filtered or unexported fields }
CRInt describes an int cli struct
type CRInt64 ¶
type CRInt64 struct { Val int64 // contains filtered or unexported fields }
CRInt64 describes an int64 cli struct
type CRString ¶
type CRString struct { Val string // contains filtered or unexported fields }
CRString describes a string cli struct
type CRStringArray ¶
type CRStringArray struct { Val []string // contains filtered or unexported fields }
CRStringArray describes a stringarray cli struct
func (CRStringArray) ToVarlink ¶
func (c CRStringArray) ToVarlink() interface{}
ToString wrapper for build without varlink
type CRStringSlice ¶
type CRStringSlice struct { Val []string // contains filtered or unexported fields }
CRStringSlice describes a string slice cli struct
func (CRStringSlice) ToVarlink ¶
func (c CRStringSlice) ToVarlink() interface{}
ToString wrapper for build without varlink
type CRUint ¶
type CRUint struct { Val uint // contains filtered or unexported fields }
CRUint describes a uint cli struct
type CRUint64 ¶
type CRUint64 struct { Val uint64 // contains filtered or unexported fields }
CRUint64 describes a uint64 cli struct
type ContainerSize ¶
ContainerSize holds the size of the container's root filesystem and top read-write layer.
type GenericCLIResult ¶
GenericCLIResult describes the overall interface for dealing with the create command cli in both local and remote uses
type GenericCLIResults ¶
type GenericCLIResults struct { InputArgs []string // contains filtered or unexported fields }
GenericCLIResults in the intermediate object between the cobra cli and createconfig
func NewIntermediateLayer ¶
func NewIntermediateLayer(c *cliconfig.PodmanCommand, remote bool) GenericCLIResults
NewIntermediateLayer creates a GenericCLIResults from a create or run cli-command
func (GenericCLIResults) Bool ¶
func (f GenericCLIResults) Bool(flag string) bool
Bool is a wrapper to get a bool value from GenericCLIResults
func (GenericCLIResults) Changed ¶
func (f GenericCLIResults) Changed(flag string) bool
Float64 is a wrapper to get an float64 value from GenericCLIResults
func (GenericCLIResults) Float64 ¶
func (f GenericCLIResults) Float64(flag string) float64
Float64 is a wrapper to get an float64 value from GenericCLIResults
func (GenericCLIResults) Int ¶
func (f GenericCLIResults) Int(flag string) int
Int is a wrapper to get an int value from GenericCLIResults
func (GenericCLIResults) Int64 ¶
func (f GenericCLIResults) Int64(flag string) int64
Int64 is a wrapper to get an int64 value from GenericCLIResults
func (GenericCLIResults) IsSet ¶
func (f GenericCLIResults) IsSet(flag string) bool
IsSet returns a bool if the flag was changed
func (GenericCLIResults) String ¶
func (f GenericCLIResults) String(flag string) string
String is a wrapper to get a string value from GenericCLIResults
func (GenericCLIResults) StringArray ¶
func (f GenericCLIResults) StringArray(flag string) []string
StringArray is a wrapper to get a stringslice value from GenericCLIResults
func (GenericCLIResults) StringSlice ¶
func (f GenericCLIResults) StringSlice(flag string) []string
StringSlice is a wrapper to get a stringslice value from GenericCLIResults
func (GenericCLIResults) Uint ¶
func (f GenericCLIResults) Uint(flag string) uint
Uint is a wrapper to get an uint value from GenericCLIResults
func (GenericCLIResults) Uint64 ¶
func (f GenericCLIResults) Uint64(flag string) uint64
Uint64 is a wrapper to get an uint64 value from GenericCLIResults
func (GenericCLIResults) Value ¶
func (f GenericCLIResults) Value(flag string) interface{}
Value returns the value of the cli flag
type JobFunc ¶
type JobFunc func() error
JobFunc provides the function signature for the pool'ed functions
type Namespace ¶
type Namespace struct { PID string `json:"pid,omitempty"` Cgroup string `json:"cgroup,omitempty"` IPC string `json:"ipc,omitempty"` MNT string `json:"mnt,omitempty"` NET string `json:"net,omitempty"` PIDNS string `json:"pidns,omitempty"` User string `json:"user,omitempty"` UTS string `json:"uts,omitempty"` }
Namespace describes output for ps namespace.
func GetNamespaces ¶
GetNamespaces returns a populated namespace struct.
type ParallelWorkerInput ¶
type ParallelWorkerInput struct { ContainerID string ParallelFunc pFunc }
ParallelWorkerInput is a struct used to pass in a slice of parallel funcs to be performed on a container ID
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Pool defines the worker pool and queues
type PsContainerOutput ¶
type PsContainerOutput struct { ID string Image string Command string Created string Ports string Names string IsInfra bool Status string State define.ContainerStatus Pid int Size *ContainerSize Pod string PodName string CreatedAt time.Time ExitedAt time.Time StartedAt time.Time Labels map[string]string PID string Cgroup string IPC string MNT string NET string PIDNS string User string UTS string Mounts string }
PsContainerOutput is the struct being returned from a parallel batch operation.
func GetPsContainerOutput ¶
func GetPsContainerOutput(r *libpod.Runtime, opts PsOptions, filters []string, maxWorkers int) ([]PsContainerOutput, error)
GetPsContainerOutput returns a slice of containers specifically for ps output.
func NewBatchContainer ¶
func NewBatchContainer(r *libpod.Runtime, ctr *libpod.Container, opts PsOptions) (PsContainerOutput, error)
NewBatchContainer runs a batch process under one lock to get container information and only be called in PBatch.