adapter

Documentation

Index

• func BatchContainerOp(ctr *libpod.Container, opts shared.PsOptions) (shared.BatchContainerStruct, error)
• func IsImageNotFound(err error) bool
• type Container
• type ContainerImage
• type LocalRuntime
  • func GetRuntime(c *cliconfig.PodmanCommand) (*LocalRuntime, error)
  • func (r *LocalRuntime) Build(ctx context.Context, c *cliconfig.BuildValues, ...) error
  • func (r *LocalRuntime) CreatePod(ctx context.Context, cli *cliconfig.PodCreateValues, labels map[string]string) (string, error)
  • func (r *LocalRuntime) CreateVolume(ctx context.Context, c *cliconfig.VolumeCreateValues, ...) (string, error)
  • func (r *LocalRuntime) Export(name string, path string) error
  • func (r *LocalRuntime) GetAllContainers() ([]*Container, error)
  • func (r *LocalRuntime) GetAllPods() ([]*Pod, error)
  • func (r *LocalRuntime) GetImages() ([]*ContainerImage, error)
  • func (r *LocalRuntime) GetLatestContainer() (*Container, error)
  • func (r *LocalRuntime) GetLatestPod() (*Pod, error)
  • func (r *LocalRuntime) Import(ctx context.Context, source, reference string, changes []string, ...) (string, error)
  • func (r *LocalRuntime) InspectVolumes(ctx context.Context, c *cliconfig.VolumeInspectValues) ([]*Volume, error)
  • func (r *LocalRuntime) KillPods(ctx context.Context, cli *cliconfig.PodKillValues, signal uint) ([]string, []error)
  • func (r *LocalRuntime) LoadFromArchiveReference(ctx context.Context, srcRef types.ImageReference, signaturePolicyPath string, ...) ([]*ContainerImage, error)
  • func (r *LocalRuntime) LoadImage(ctx context.Context, name string, cli *cliconfig.LoadValues) (string, error)
  • func (r *LocalRuntime) LookupContainer(idOrName string) (*Container, error)
  • func (r *LocalRuntime) LookupPod(nameOrID string) (*Pod, error)
  • func (r *LocalRuntime) New(ctx context.Context, name, signaturePolicyPath, authfile string, ...) (*ContainerImage, error)
  • func (r *LocalRuntime) NewImageFromLocal(name string) (*ContainerImage, error)
  • func (r *LocalRuntime) PausePods(c *cliconfig.PodPauseValues) ([]string, map[string]error, []error)
  • func (r *LocalRuntime) PruneImages(all bool) ([]string, error)
  • func (r *LocalRuntime) PruneVolumes(ctx context.Context) ([]string, []error)
  • func (r *LocalRuntime) Push(ctx context.Context, ...) error
  • func (r *LocalRuntime) RemoveImage(ctx context.Context, img *ContainerImage, force bool) (string, error)
  • func (r *LocalRuntime) RemovePods(ctx context.Context, cli *cliconfig.PodRmValues) ([]string, []error)
  • func (r *LocalRuntime) RemoveVolumes(ctx context.Context, c *cliconfig.VolumeRmValues) ([]string, error)
  • func (r *LocalRuntime) RestartPods(ctx context.Context, c *cliconfig.PodRestartValues) ([]string, map[string]error, []error)
  • func (r *LocalRuntime) SaveImage(ctx context.Context, c *cliconfig.SaveValues) error
  • func (r *LocalRuntime) StartPods(ctx context.Context, cli *cliconfig.PodStartValues) ([]string, []error)
  • func (r *LocalRuntime) StopContainers(ctx context.Context, cli *cliconfig.StopValues) ([]string, map[string]error, error)
  • func (r *LocalRuntime) StopPods(ctx context.Context, cli *cliconfig.PodStopValues) ([]string, []error)
  • func (r *LocalRuntime) UnpausePods(c *cliconfig.PodUnpauseValues) ([]string, map[string]error, []error)
  • func (r *LocalRuntime) Volumes(ctx context.Context) ([]*Volume, error)
• type Pod
  • func (p *Pod) GetPodStatus() (string, error)
• type Volume
• type VolumeFilter

Functions

func BatchContainerOp

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

BatchContainerOp is a wrapper for the shared function of the same name

func IsImageNotFound

func IsImageNotFound(err error) bool

IsImageNotFound checks if the error indicates that no image was found.

Types

type Container

type Container struct {
	*libpod.Container
}

Container ...

type ContainerImage

type ContainerImage struct {
	*image.Image
}

ContainerImage ...

type LocalRuntime

type LocalRuntime struct {
	*libpod.Runtime
	Remote bool
}

LocalRuntime describes a typical libpod runtime

func GetRuntime

func GetRuntime(c *cliconfig.PodmanCommand) (*LocalRuntime, error)

GetRuntime returns a LocalRuntime struct with the actual runtime embedded in it

func (*LocalRuntime) Build

func (r *LocalRuntime) Build(ctx context.Context, c *cliconfig.BuildValues, options imagebuildah.BuildOptions, dockerfiles []string) error

Build is the wrapper to build images

func (*LocalRuntime) CreatePod

func (r *LocalRuntime) CreatePod(ctx context.Context, cli *cliconfig.PodCreateValues, labels map[string]string) (string, error)

CreatePod is a wrapper for libpod and creating a new pod from the cli context

func (*LocalRuntime) CreateVolume

func (r *LocalRuntime) CreateVolume(ctx context.Context, c *cliconfig.VolumeCreateValues, labels, opts map[string]string) (string, error)

CreateVolume is a wrapper to create volumes

func (*LocalRuntime) Export

func (r *LocalRuntime) Export(name string, path string) error

Export is a wrapper to container export to a tarfile

func (*LocalRuntime) GetAllContainers

func (r *LocalRuntime) GetAllContainers() ([]*Container, error)

GetAllContainers gets all Containers and wraps each one in an adapter Container

func (*LocalRuntime) GetAllPods

func (r *LocalRuntime) GetAllPods() ([]*Pod, error)

GetAllPods gets all pods and wraps it in an adapter pod

func (*LocalRuntime) GetImages

func (r *LocalRuntime) GetImages() ([]*ContainerImage, error)

GetImages returns a slice of images in containerimages

func (*LocalRuntime) GetLatestContainer

func (r *LocalRuntime) GetLatestContainer() (*Container, error)

GetLatestContainer gets the latest Container and wraps it in an adapter Container

func (*LocalRuntime) GetLatestPod

func (r *LocalRuntime) GetLatestPod() (*Pod, error)

GetLatestPod gets the latest pod and wraps it in an adapter pod

func (*LocalRuntime) Import

func (r *LocalRuntime) Import(ctx context.Context, source, reference string, changes []string, history string, quiet bool) (string, error)

Import is a wrapper to import a container image

func (*LocalRuntime) InspectVolumes

func (r *LocalRuntime) InspectVolumes(ctx context.Context, c *cliconfig.VolumeInspectValues) ([]*Volume, error)

InspectVolumes returns a slice of volumes based on an arg list or --all

func (*LocalRuntime) KillPods

func (r *LocalRuntime) KillPods(ctx context.Context, cli *cliconfig.PodKillValues, signal uint) ([]string, []error)

KillPods is a wrapper to libpod to start pods based on the cli context

func (*LocalRuntime) LoadFromArchiveReference

func (r *LocalRuntime) LoadFromArchiveReference(ctx context.Context, srcRef types.ImageReference, signaturePolicyPath string, writer io.Writer) ([]*ContainerImage, error)

LoadFromArchiveReference calls into local storage to load an image from an archive

func (*LocalRuntime) LoadImage

func (r *LocalRuntime) LoadImage(ctx context.Context, name string, cli *cliconfig.LoadValues) (string, error)

LoadImage is a wrapper function for libpod PruneVolumes

func (*LocalRuntime) LookupContainer

func (r *LocalRuntime) LookupContainer(idOrName string) (*Container, error)

LookupContainer gets a Container by name or id and wraps it in an adapter Container

func (*LocalRuntime) LookupPod

func (r *LocalRuntime) LookupPod(nameOrID string) (*Pod, error)

LookupPod gets a pod by name or id and wraps it in an adapter pod

func (*LocalRuntime) New

func (r *LocalRuntime) New(ctx context.Context, name, signaturePolicyPath, authfile string, writer io.Writer, dockeroptions *image.DockerRegistryOptions, signingoptions image.SigningOptions, forcePull bool, label *string) (*ContainerImage, error)

New calls into local storage to look for an image in local storage or to pull it

func (*LocalRuntime) NewImageFromLocal

func (r *LocalRuntime) NewImageFromLocal(name string) (*ContainerImage, error)

NewImageFromLocal returns a containerimage representation of a image from local storage

func (*LocalRuntime) PausePods

func (r *LocalRuntime) PausePods(c *cliconfig.PodPauseValues) ([]string, map[string]error, []error)

PausePods is a wrapper for pausing pods via libpod

func (*LocalRuntime) PruneImages

func (r *LocalRuntime) PruneImages(all bool) ([]string, error)

PruneImages is wrapper into PruneImages within the image pkg

func (*LocalRuntime) PruneVolumes

func (r *LocalRuntime) PruneVolumes(ctx context.Context) ([]string, []error)

PruneVolumes is a wrapper function for libpod PruneVolumes

func (*LocalRuntime) Push

func (r *LocalRuntime) Push(ctx context.Context, srcName, destination, manifestMIMEType, authfile, signaturePolicyPath string, writer io.Writer, forceCompress bool, signingOptions image.SigningOptions, dockerRegistryOptions *image.DockerRegistryOptions, additionalDockerArchiveTags []reference.NamedTagged) error

Push is a wrapper to push an image to a registry

func (*LocalRuntime) RemoveImage

func (r *LocalRuntime) RemoveImage(ctx context.Context, img *ContainerImage, force bool) (string, error)

RemoveImage calls into local storage and removes an image

func (*LocalRuntime) RemovePods

func (r *LocalRuntime) RemovePods(ctx context.Context, cli *cliconfig.PodRmValues) ([]string, []error)

RemovePods ...

func (*LocalRuntime) RemoveVolumes

func (r *LocalRuntime) RemoveVolumes(ctx context.Context, c *cliconfig.VolumeRmValues) ([]string, error)

RemoveVolumes is a wrapper to remove volumes

func (*LocalRuntime) RestartPods

func (r *LocalRuntime) RestartPods(ctx context.Context, c *cliconfig.PodRestartValues) ([]string, map[string]error, []error)

RestartPods is a wrapper to restart pods via libpod

func (*LocalRuntime) SaveImage

func (r *LocalRuntime) SaveImage(ctx context.Context, c *cliconfig.SaveValues) error

SaveImage is a wrapper function for saving an image to the local filesystem

func (*LocalRuntime) StartPods

func (r *LocalRuntime) StartPods(ctx context.Context, cli *cliconfig.PodStartValues) ([]string, []error)

StartPods is a wrapper to start pods based on the cli context

func (*LocalRuntime) StopContainers

func (r *LocalRuntime) StopContainers(ctx context.Context, cli *cliconfig.StopValues) ([]string, map[string]error, error)

StopContainers stops container(s) based on CLI inputs. Returns list of successful id(s), map of failed id(s) + error, or error not from container

func (*LocalRuntime) StopPods

func (r *LocalRuntime) StopPods(ctx context.Context, cli *cliconfig.PodStopValues) ([]string, []error)

StopPods is a wrapper to libpod to stop pods based on a cli context

func (*LocalRuntime) UnpausePods

func (r *LocalRuntime) UnpausePods(c *cliconfig.PodUnpauseValues) ([]string, map[string]error, []error)

UnpausePods is a wrapper for unpausing pods via libpod

func (*LocalRuntime) Volumes

func (r *LocalRuntime) Volumes(ctx context.Context) ([]*Volume, error)

Volumes returns a slice of localruntime volumes

type Pod

type Pod struct {
	*libpod.Pod
}

Pod ...

func (*Pod) GetPodStatus

func (p *Pod) GetPodStatus() (string, error)

GetPodStatus is a wrapper to get the status of a local libpod pod

type Volume

type Volume struct {
	*libpod.Volume
}

Volume ...

type VolumeFilter

type VolumeFilter func(*Volume) bool

VolumeFilter is for filtering volumes on the client