Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

libpod

package

Go to main page

Versions in this module

v1

v1.0.9

Feb 8, 2018

v1.0.8

Dec 11, 2017

v1.0.7

Nov 30, 2017

v1.0.6

Nov 28, 2017

v1.0.5

Nov 22, 2017

v1.0.4

Nov 11, 2017

v1.0.3

Nov 9, 2017

v1.0.0

Oct 13, 2017

Changes in this version

+ const DefaultRegistry

+ const IPCNamespace

+ const MountNamespace

+ const NetNamespace

+ const OCIv1ImageManifest

+ const PIDNamespace

+ const Package

+ const UTSNamespace

+ const UserNamespace

+ var DockerArchive = dockerarchive.Transport.Name()

+ var ErrCtrExists = errors.New("container already exists")

+ var ErrCtrFinalized = errors.New("container has been finalized")

+ var ErrCtrRemoved = errors.New("container has already been removed")

+ var ErrCtrStopped = errors.New("container is stopped")

+ var ErrImageExists = errors.New("image already exists")

+ var ErrInvalidArg = errors.New("invalid argument")

+ var ErrNoSuchCtr = errors.New("no such container")

+ var ErrNoSuchImage = errors.New("no such image")

+ var ErrNoSuchPod = errors.New("no such pod")

+ var ErrNotImplemented = errors.New("not yet implemented")

+ var ErrPodExists = errors.New("pod already exists")

+ var ErrPodFinalized = errors.New("pod has been finalized")

+ var ErrPodRemoved = errors.New("pod has already been removed")

+ var ErrRuntimeFinalized = errors.New("runtime has been finalized")

+ var ErrRuntimeStopped = errors.New("runtime has already been stopped")

+ var OCIArchive = ociarchive.Transport.Name()

+ func MatchesID(id, argID string) bool

+ func MatchesReference(name, argName string) bool

+ func ParseImageNames(names []string) (tags, digests []string, err error)

+ type Container struct

+ func (c *Container) Attach(stdin, tty bool) (string, error)

+ func (c *Container) Commit() (*storage.Image, error)

+ func (c *Container) Create() error

+ func (c *Container) Exec(cmd []string, tty bool, stdin bool) (string, error)

+ func (c *Container) Export(path string) error

+ func (c *Container) ID() string

+ func (c *Container) Kill(signal uint) error

+ func (c *Container) Mount() (string, error)

+ func (c *Container) Name() string

+ func (c *Container) Spec() *spec.Spec

+ func (c *Container) Start() error

+ func (c *Container) Status() error

+ func (c *Container) Stop() error

+ type ContainerFilter func(*Container) bool

+ type CopyData struct

+ Config []byte

+ Container string

+ ContainerID string

+ Docker docker.V2Image

+ FromImage string

+ FromImageID string

+ ImageAnnotations map[string]string

+ ImageCreatedBy string

+ Manifest []byte

+ MountPoint string

+ OCIv1 v1.Image

+ Type string

+ func (c *CopyData) Annotations() map[string]string

+ func (c *CopyData) Architecture() string

+ func (c *CopyData) MakeImageRef(manifestType string, compress archive.Compression, names []string, ...) (types.ImageReference, error)

+ func (c *CopyData) OS() string

+ func (c *CopyData) Save() error

+ func (c *CopyData) SetArchitecture(arch string)

+ func (c *CopyData) SetOS(os string)

+ func (c *CopyData) SetWorkDir(there string)

+ func (c *CopyData) WorkDir() string

+ type CopyOptions struct

+ Compression archive.Compression

+ SignaturePolicyPath string

+ type CopyRef struct

+ func (c *CopyRef) DeleteImage(*types.SystemContext) error

+ func (c *CopyRef) DockerReference() reference.Named

+ func (c *CopyRef) NewImage(sc *types.SystemContext) (types.Image, error)

+ func (c *CopyRef) NewImageDestination(sc *types.SystemContext) (types.ImageDestination, error)

+ func (c *CopyRef) NewImageSource(sc *types.SystemContext) (src types.ImageSource, err error)

+ func (c *CopyRef) PolicyConfigurationIdentity() string

+ func (c *CopyRef) PolicyConfigurationNamespaces() []string

+ func (c *CopyRef) StringWithinTransport() string

+ func (c *CopyRef) Transport() types.ImageTransport

+ type CtrCreateOption func(*Container) error

+ func WithAnnotations(annotations map[string]string) CtrCreateOption

+ func WithLabels(labels map[string]string) CtrCreateOption

+ func WithName(name string) CtrCreateOption

+ func WithRootFSFromImage(image string, useImageConfig bool) CtrCreateOption

+ func WithRootFSFromPath(path string) CtrCreateOption

+ func WithSharedNamespaces(from *Container, namespaces map[string]string) CtrCreateOption

+ func WithStopSignal(signal uint) CtrCreateOption

+ type Data struct

+ Annotations map[string]string

+ Architecture string

+ Author string

+ Comment string

+ Config ociv1.ImageConfig

+ Container string

+ Created *time.Time

+ CreatedBy string

+ Digests []string

+ GraphDriver driver.Data

+ ID string

+ ManifestDigest digest.Digest

+ OS string

+ RootFS ociv1.RootFS

+ Size uint

+ Tags []string

+ VirtualSize uint

+ type ImageFilter func(*storage.Image, *types.ImageInspectInfo) bool

+ type ImageFilterParams struct

+ BeforeImage time.Time

+ Dangling string

+ ImageInput string

+ ImageName string

+ Label string

+ ReferencePattern string

+ SinceImage time.Time

+ type Pod struct

+ func (p *Pod) GetContainers() ([]*Container, error)

+ func (p *Pod) ID() string

+ func (p *Pod) Kill(signal uint) error

+ func (p *Pod) Name() string

+ func (p *Pod) Start() error

+ func (p *Pod) Status() error

+ func (p *Pod) Stop() error

+ type PodCreateOption func(*Pod) error

+ func WithPodName(name string) PodCreateOption

+ type PodFilter func(*Pod) bool

+ type Runtime struct

+ func NewRuntime(options ...RuntimeOption) (*Runtime, error)

+ func (r *Runtime) GetConfig() *RuntimeConfig

+ func (r *Runtime) GetContainer(id string) (*Container, error)

+ func (r *Runtime) GetContainerCopyData(name string) (*CopyData, error)

+ func (r *Runtime) GetContainers(filters ...ContainerFilter) ([]*Container, error)

+ func (r *Runtime) GetData(name string) (*Data, error)

+ func (r *Runtime) GetDiff(from, to string) ([]archive.Change, error)

+ func (r *Runtime) GetHistory(image string) ([]ociv1.History, []types.BlobInfo, string, error)

+ func (r *Runtime) GetImage(image string) (*storage.Image, error)

+ func (r *Runtime) GetImageCopyData(image string) (*CopyData, error)

+ func (r *Runtime) GetImageInspectInfo(image storage.Image) (*types.ImageInspectInfo, error)

+ func (r *Runtime) GetImageRef(image string) (types.Image, error)

+ func (r *Runtime) GetImages(params *ImageFilterParams, filters ...ImageFilter) ([]*storage.Image, error)

+ func (r *Runtime) GetPod(id string) (*Pod, error)

+ func (r *Runtime) HasContainer(id string) (bool, error)

+ func (r *Runtime) HasPod(id string) (bool, error)

+ func (r *Runtime) ImportCopyDataFromImage(systemContext *types.SystemContext, imageID, containerName, containerID string) (*CopyData, error)

+ func (r *Runtime) ImportImage(path string) (*storage.Image, error)

+ func (r *Runtime) InfoAndDigestAndSize(img storage.Image) (*types.ImageInspectInfo, digest.Digest, int64, error)

+ func (r *Runtime) LookupContainer(idOrName string) (*Container, error)

+ func (r *Runtime) LookupPod(idOrName string) (*Pod, error)

+ func (r *Runtime) NewContainer(spec *spec.Spec, options ...CtrCreateOption) (*Container, error)

+ func (r *Runtime) NewPod(options ...PodCreateOption) (*Pod, error)

+ func (r *Runtime) ParseImageFilter(imageInput, filter string) (*ImageFilterParams, error)

+ func (r *Runtime) Pods(filters ...PodFilter) ([]*Pod, error)

+ func (r *Runtime) PullImage(imgName string, allTags bool, signaturePolicyPath string, ...) error

+ func (r *Runtime) PushImage(source string, destination string, options CopyOptions, reportWriter io.Writer) error

+ func (r *Runtime) RemoveContainer(c *Container, force bool) error

+ func (r *Runtime) RemoveImage(image *storage.Image, force bool) (string, error)

+ func (r *Runtime) RemovePod(p *Pod, force bool) error

+ func (r *Runtime) Shutdown(force bool) error

+ func (r *Runtime) TagImage(image *storage.Image, tag string) error

+ func (r *Runtime) UntagImage(image *storage.Image, tag string) (string, error)

+ func (r *Runtime) WithPod(pod *Pod) CtrCreateOption

+ type RuntimeConfig struct

+ CgroupManager string

+ ConmonEnvVars []string

+ ConmonPath string

+ ImageDefaultTransport string

+ InsecureRegistries []string

+ PidsLimit int64

+ Registries []string

+ RuntimePath string

+ SelinuxEnabled bool

+ SignaturePolicyPath string

+ StorageConfig storage.StoreOptions

+ type RuntimeOption func(*Runtime) error

+ func WithCgroupManager(manager string) RuntimeOption

+ func WithConmonEnv(environment []string) RuntimeOption

+ func WithConmonPath(path string) RuntimeOption

+ func WithImageConfig(defaultTransport string, insecureRegistries, registries []string) RuntimeOption

+ func WithOCIRuntime(runtimePath string) RuntimeOption

+ func WithPidsLimit(limit int64) RuntimeOption

+ func WithSELinux() RuntimeOption

+ func WithSignaturePolicy(path string) RuntimeOption

+ func WithStorageConfig(config storage.StoreOptions) RuntimeOption

+ type State interface

+ AddContainer func(ctr *Container) error

+ AddPod func(pod *Pod) error

+ GetAllContainers func() ([]*Container, error)

+ GetAllPods func() ([]*Pod, error)

+ GetContainer func(id string) (*Container, error)

+ GetPod func(id string) (*Pod, error)

+ HasContainer func(id string) (bool, error)

+ HasPod func(id string) (bool, error)

+ LookupContainer func(idOrName string) (*Container, error)

+ LookupPod func(idOrName string) (*Pod, error)

+ RemoveContainer func(ctr *Container) error

+ RemovePod func(pod *Pod) error

v1.0.0-rc3

Oct 5, 2017

v1.0.0-rc2

Sep 13, 2017

v1.0.0-rc1

Sep 8, 2017