pods

Documentation

Index

• func CreatePod() error
• func Exists(ctx context.Context, nameOrID string) (bool, error)
• func Inspect(ctx context.Context, nameOrID string) (*libpod.PodInspect, error)
• func Kill(ctx context.Context, nameOrID string, signal *string) error
• func List(ctx context.Context, filters map[string][]string) ([]*libpod.PodInspect, error)
• func Pause(ctx context.Context, nameOrID string) error
• func Prune(ctx context.Context) error
• func Remove(ctx context.Context, nameOrID string, force *bool) error
• func Restart(ctx context.Context, nameOrID string) error
• func Start(ctx context.Context, nameOrID string) error
• func Stats() error
• func Stop(ctx context.Context, nameOrID string, timeout *int) error
• func Top() error
• func Unpause(ctx context.Context, nameOrID string) error

Functions

func CreatePod

func CreatePod() error

func Exists

func Exists(ctx context.Context, nameOrID string) (bool, error)

Exists is a lightweight method to determine if a pod exists in local storage

func Inspect

func Inspect(ctx context.Context, nameOrID string) (*libpod.PodInspect, error)

Inspect returns low-level information about the given pod.

func Kill

func Kill(ctx context.Context, nameOrID string, signal *string) error

Kill sends a SIGTERM to all the containers in a pod. The optional signal parameter can be used to override SIGTERM.

func List

func List(ctx context.Context, filters map[string][]string) ([]*libpod.PodInspect, error)

List returns all pods in local storage. The optional filters parameter can be used to refine which pods should be listed.

func Pause

func Pause(ctx context.Context, nameOrID string) error

Pause pauses all running containers in a given pod.

func Prune

func Prune(ctx context.Context) error

Prune removes all non-running pods in local storage.

func Remove

func Remove(ctx context.Context, nameOrID string, force *bool) error

Remove deletes a Pod from from local storage. The optional force parameter denotes that the Pod can be removed even if in a running state.

func Restart

func Restart(ctx context.Context, nameOrID string) error

Restart restarts all containers in a pod.

func Start

func Start(ctx context.Context, nameOrID string) error

Start starts all containers in a pod.

func Stats

func Stats() error

func Stop

func Stop(ctx context.Context, nameOrID string, timeout *int) error

Stop stops all containers in a Pod. The optional timeout parameter can be used to override the timeout before the container is killed.

func Top

func Top() error

func Unpause

func Unpause(ctx context.Context, nameOrID string) error

Unpause unpauses all paused containers in a Pod.