pods

Documentation

Index

• func CreatePodFromSpec(ctx context.Context, s *specgen.PodSpecGenerator) (*entities.PodCreateReport, error)
• func Exists(ctx context.Context, nameOrID string) (bool, error)
• func Inspect(ctx context.Context, nameOrID string) (*entities.PodInspectReport, error)
• func Kill(ctx context.Context, nameOrID string, signal *string) (*entities.PodKillReport, error)
• func List(ctx context.Context, filters map[string][]string) ([]*entities.ListPodsReport, error)
• func Pause(ctx context.Context, nameOrID string) (*entities.PodPauseReport, error)
• func Prune(ctx context.Context) ([]*entities.PodPruneReport, error)
• func Remove(ctx context.Context, nameOrID string, force *bool) (*entities.PodRmReport, error)
• func Restart(ctx context.Context, nameOrID string) (*entities.PodRestartReport, error)
• func Start(ctx context.Context, nameOrID string) (*entities.PodStartReport, error)
• func Stats(ctx context.Context, namesOrIDs []string, options entities.PodStatsOptions) ([]*entities.PodStatsReport, error)
• func Stop(ctx context.Context, nameOrID string, timeout *int) (*entities.PodStopReport, error)
• func Top(ctx context.Context, nameOrID string, descriptors []string) ([]string, error)
• func Unpause(ctx context.Context, nameOrID string) (*entities.PodUnpauseReport, error)

Functions

func CreatePodFromSpec

func CreatePodFromSpec(ctx context.Context, s *specgen.PodSpecGenerator) (*entities.PodCreateReport, 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) (*entities.PodInspectReport, error)

Inspect returns low-level information about the given pod.

func Kill

func Kill(ctx context.Context, nameOrID string, signal *string) (*entities.PodKillReport, 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) ([]*entities.ListPodsReport, 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) (*entities.PodPauseReport, error)

Pause pauses all running containers in a given pod.

func Prune

func Prune(ctx context.Context) ([]*entities.PodPruneReport, error)

Prune by default removes all non-running pods in local storage. And with force set true removes all pods.

func Remove

func Remove(ctx context.Context, nameOrID string, force *bool) (*entities.PodRmReport, 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) (*entities.PodRestartReport, error)

Restart restarts all containers in a pod.

func Start

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

Start starts all containers in a pod.

func Stats

func Stats(ctx context.Context, namesOrIDs []string, options entities.PodStatsOptions) ([]*entities.PodStatsReport, error)

Stats display resource-usage statistics of one or more pods.

func Stop

func Stop(ctx context.Context, nameOrID string, timeout *int) (*entities.PodStopReport, 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(ctx context.Context, nameOrID string, descriptors []string) ([]string, error)

Top gathers statistics about the running processes in a pod. The nameOrID can be a pod name or a partial/full ID. The descriptors allow for specifying which data to collect from each process.

func Unpause

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

Unpause unpauses all paused containers in a Pod.