shared

Documentation

Index

• Variables
• func CreateContainer(ctx context.Context, c *cliconfig.PodmanCommand, 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]libpod.ContainerStatus) (string, error)
• func CreatePortBindings(ports []string) ([]ocicni.PortMapping, error)
• func GenerateCommand(command, imageName, name string) ([]string, error)
• func GenerateEventOptions(filters []string, since, until string) ([]events.EventFilter, 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 GetCtrInspectInfo(config *libpod.ContainerConfig, ctrInspectData *inspect.ContainerInspectData, ...) (*inspect.ContainerData, 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 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 *cliconfig.PodmanCommand, runtime *libpod.Runtime, ...) (*cc.CreateConfig, error)
• func ValidateVolumeCtrDir(ctrDir string) error
• func ValidateVolumeHostDir(hostDir string) error
• type BatchContainerStruct
  • func BatchContainerOp(ctr *libpod.Container, opts PsOptions) (BatchContainerStruct, error)
• type ContainerSize
• type Namespace
  • func GetNamespaces(pid int) *Namespace
• type ParallelWorkerInput
• type PsContainerOutput
  • func NewBatchContainer(ctr *libpod.Container, opts PsOptions) (PsContainerOutput, error)
  • func PBatch(containers []*libpod.Container, workers int, opts PsOptions) []PsContainerOutput
• type PsOptions

Variables

var DefaultKernelNamespaces = "cgroup,ipc,net,uts"

Functions

func CreateContainer

func CreateContainer(ctx context.Context, c *cliconfig.PodmanCommand, runtime *libpod.Runtime) (*libpod.Container, *cc.CreateConfig, error)

func CreateContainerFromCreateConfig

func CreateContainerFromCreateConfig(r *libpod.Runtime, createConfig *cc.CreateConfig, ctx context.Context, pod *libpod.Pod) (*libpod.Container, error)

func CreatePodStatusResults

func CreatePodStatusResults(ctrStatuses map[string]libpod.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 GenerateCommand

func GenerateCommand(command, imageName, name string) ([]string, error)

GenerateCommand takes a label (string) and converts it to an executable command

func GenerateEventOptions

func GenerateEventOptions(filters []string, since, until string) ([]events.EventFilter, error)

func GenerateRunEnvironment

func GenerateRunEnvironment(name, imageName string, opts map[string]string) []string

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) ([]string, []string, error)

GenerateRunlabelCommand generates the command that will eventually be execucted by podman

func GetAllLabels

func GetAllLabels(labelFile, inputLabels []string) (map[string]string, error)

GetAllLabels ...

func GetCtrInspectInfo

func GetCtrInspectInfo(config *libpod.ContainerConfig, ctrInspectData *inspect.ContainerInspectData, createArtifact *cc.CreateConfig) (*inspect.ContainerData, error)

GetCtrInspectInfo takes container inspect data and collects all its info into a ContainerData structure for inspection related methods

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

func GetPodStatus(pod *libpod.Pod) (string, error)

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 contruction of the runlabel output and environment variables

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

func Parallelize(job string) int

Parallelize provides the maximum number of parallel workers (int) as calculated by a basic heuristic. This can be overriden by the --max-workers primary switch to podman.

func ParseCreateOpts

func ParseCreateOpts(ctx context.Context, c *cliconfig.PodmanCommand, 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 ValidateVolumeCtrDir

func ValidateVolumeCtrDir(ctrDir string) error

ValidateVolumeCtrDir ...

func ValidateVolumeHostDir

func ValidateVolumeHostDir(hostDir string) error

ValidateVolumeHostDir ...

Types

type BatchContainerStruct

type BatchContainerStruct struct {
	ConConfig   *libpod.ContainerConfig
	ConState    libpod.ContainerStatus
	ExitCode    int32
	Exited      bool
	Pid         int
	StartedTime time.Time
	ExitedTime  time.Time
	Size        *ContainerSize
}

BatchContainerStruct is the return obkect from BatchContainer and contains container related information

func BatchContainerOp

func BatchContainerOp(ctr *libpod.Container, opts PsOptions) (BatchContainerStruct, error)

BatchContainer is used in ps to reduce performance hits by "batching" locks.

type ContainerSize

type ContainerSize struct {
	RootFsSize int64 `json:"rootFsSize"`
	RwSize     int64 `json:"rwSize"`
}

ContainerSize holds the size of the container's root filesystem and top read-write layer

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

func GetNamespaces(pid int) *Namespace

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 PsContainerOutput

type PsContainerOutput struct {
	ID        string
	Image     string
	Command   string
	Created   string
	Ports     string
	Names     string
	IsInfra   bool
	Status    string
	State     libpod.ContainerStatus
	Pid       int
	Size      *ContainerSize
	Pod       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 NewBatchContainer

func NewBatchContainer(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

func PBatch

func PBatch(containers []*libpod.Container, workers int, opts PsOptions) []PsContainerOutput

PBatch is performs batch operations on a container in parallel. It spawns the number of workers relative to the the number of parallel operations desired.

type PsOptions

type PsOptions struct {
	All       bool
	Format    string
	Last      int
	Latest    bool
	NoTrunc   bool
	Pod       bool
	Quiet     bool
	Size      bool
	Sort      string
	Label     string
	Namespace bool
	Sync      bool
}

PsOptions describes the struct being formed for ps