adapter

package
v1.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 22, 2020 License: Apache-2.0 Imports: 56 Imported by: 6

Documentation

Index

Constants

View Source 
const (
	Unknown          = iota - 1 // Unknown connection type
	BridgeConnection            // BridgeConnection proxy connection via ssh
	DirectConnection            // DirectConnection socket connection to server
)

Enum of connection types

View Source 
const DefaultAPIAddress = "unix:/run/podman/podman.sock"

DefaultAPIAddress is the default address of the REST socket

View Source 
const DefaultVarlinkAddress = "unix:/run/podman/io.podman"

DefaultVarlinkAddress is the default address of the varlink socket

Variables

This section is empty.

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 ExecAttachCtr added in v1.5.0 

func ExecAttachCtr(ctx context.Context, ctr *libpod.Container, tty, privileged bool, env map[string]string, cmd []string, user, workDir string, streams *define.AttachStreams, preserveFDs uint, detachKeys string) (int, error)

ExecAttachCtr execs and attaches to a container

func IsImageNotFound added in v1.1.1 

func IsImageNotFound(err error) bool

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

func ProxySignals added in v1.3.0 

func ProxySignals(ctr *libpod.Container)

ProxySignals ...

func StartAttachCtr added in v1.3.0 

func StartAttachCtr(ctx context.Context, ctr *libpod.Container, stdout, stderr, stdin *os.File, detachKeys string, sigProxy bool, startContainer bool, recursive bool) error

StartAttachCtr starts and (if required) attaches to a container if you change the signature of this function from os.File to io.Writer, it will trigger a downstream error. we may need to just lint disable this one.

Types

type Container 

type Container struct {
	*libpod.Container
}

Container ...

type ContainerImage 

type ContainerImage struct {
	*image.Image
}

ContainerImage ...

type Endpoint added in v1.4.0 

type Endpoint struct {
	Type       EndpointType
	Connection string
}

Endpoint type and connection string to use

type EndpointType added in v1.4.0 

type EndpointType int

EndpointType declares the type of server connection

func (EndpointType) String added in v1.4.0 

func (e EndpointType) String() string

String prints ASCII string for EndpointType

type LocalRuntime 

type LocalRuntime struct {
	*libpod.Runtime
	Remote bool
}

LocalRuntime describes a typical libpod runtime

func GetRuntime 

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

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

func GetRuntimeNoStore added in v1.5.0 

func GetRuntimeNoStore(ctx context.Context, c *cliconfig.PodmanCommand) (*LocalRuntime, error)

GetRuntimeNoStore returns a localruntime struct with an embedded runtime but without a configured storage.

func (*LocalRuntime) Attach added in v1.3.0 

func (r *LocalRuntime) Attach(ctx context.Context, c *cliconfig.AttachValues) error

Attach ...

func (*LocalRuntime) AutoUpdate added in v1.8.2 

func (r *LocalRuntime) AutoUpdate() ([]string, []error)

func (*LocalRuntime) Build 

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

Build is the wrapper to build images

func (*LocalRuntime) Checkpoint added in v1.3.0 

func (r *LocalRuntime) Checkpoint(c *cliconfig.CheckpointValues) error

Checkpoint one or more containers

func (*LocalRuntime) CleanupContainers added in v1.3.0 

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

CleanupContainers any leftovers bits of stopped containers

func (*LocalRuntime) Commit added in v1.4.0 

func (r *LocalRuntime) Commit(ctx context.Context, c *cliconfig.CommitValues, container, imageName string) (string, error)

Commit creates a local image from a container

func (*LocalRuntime) CreateContainer added in v1.3.0 

func (r *LocalRuntime) CreateContainer(ctx context.Context, c *cliconfig.CreateValues) (string, error)

CreateContainer creates a libpod container

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) Diff added in v1.3.0 

func (r *LocalRuntime) Diff(c *cliconfig.DiffValues, to string) ([]archive.Change, error)

Diff shows the difference in two objects

func (*LocalRuntime) Events added in v1.2.0 

func (r *LocalRuntime) Events(c *cliconfig.EventValues) error

Events is a wrapper to libpod to obtain libpod/podman events

func (*LocalRuntime) ExecContainer added in v1.5.0 

func (r *LocalRuntime) ExecContainer(ctx context.Context, cli *cliconfig.ExecValues) (int, error)

ExecContainer executes a command in the container

func (*LocalRuntime) Export 

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

Export is a wrapper to container export to a tarfile

func (*LocalRuntime) GenerateKube added in v1.3.0 

func (r *LocalRuntime) GenerateKube(c *cliconfig.GenerateKubeValues) (*v1.Pod, *v1.Service, error)

GenerateKube creates kubernetes email from containers and pods

func (*LocalRuntime) GenerateSystemd added in v1.3.0 

func (r *LocalRuntime) GenerateSystemd(c *cliconfig.GenerateSystemdValues) (string, error)

GenerateSystemd creates a unit file for a container or pod.

func (*LocalRuntime) GetAllContainers added in v1.1.2 

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) GetFilteredImages added in v1.7.0 

func (r *LocalRuntime) GetFilteredImages(filters []string, rwOnly bool) ([]*ContainerImage, error)

GetFilteredImages returns a slice of images in containerimages that are "filtered"

func (*LocalRuntime) GetImages 

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

GetImages returns a slice of images in containerimages

func (*LocalRuntime) GetLatestContainer added in v1.1.2 

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) GetNamespaces added in v1.3.1 

func (r *LocalRuntime) GetNamespaces(container shared.PsContainerOutput) *shared.Namespace

GetNamespaces returns namespace information about a container for PS

func (*LocalRuntime) GetPodsByStatus added in v1.3.0 

func (r *LocalRuntime) GetPodsByStatus(statuses []string) ([]*libpod.Pod, error)

GetPodsByStatus returns a slice of pods filtered by a libpod status

func (*LocalRuntime) GetPodsWithFilters added in v1.8.2 

func (r *LocalRuntime) GetPodsWithFilters(filters string) ([]*Pod, error)

GetPodsWithFilters gets the filtered list of pods based on the filter parameters provided.

func (*LocalRuntime) GetRWImages added in v1.5.0 

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

GetRWImages returns a slice of read/write images in containerimages

func (*LocalRuntime) GetStatPods added in v1.2.0 

func (r *LocalRuntime) GetStatPods(c *cliconfig.PodStatsValues) ([]*Pod, error)

GetStatPods returns pods for use in pod stats

func (*LocalRuntime) GetVersion added in v1.3.1 

func (r *LocalRuntime) GetVersion() (define.Version, error)

GetVersion is an alias to satisfy interface{}

func (*LocalRuntime) HealthCheck added in v1.2.0 

func (r *LocalRuntime) HealthCheck(c *cliconfig.HealthCheckValues) (string, error)

HealthCheck is a wrapper to same named function in libpod

func (*LocalRuntime) ImageTree added in v1.8.1 

func (r *LocalRuntime) ImageTree(imageOrID string, whatRequires bool) (string, error)

ImageTree reutnrs an new image.Tree for the provided `imageOrID` and `whatrequires` flag

func (*LocalRuntime) ImagestoContainerImages added in v1.7.0 

func (r *LocalRuntime) ImagestoContainerImages(images []*image.Image, rwOnly bool) ([]*ContainerImage, error)

ImagestoContainerImages converts the slice of *image.Image to a slice of *ContainerImage. ReadOnly images are skipped when rwOnly is set.

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) InitContainers added in v1.3.0 

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

InitContainers initializes container(s) based on CLI inputs. Returns list of successful id(s), map of failed id(s) to errors, or a general error not from the container.

func (*LocalRuntime) InspectVolumes 

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

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

func (*LocalRuntime) KillContainers added in v1.2.0 

func (r *LocalRuntime) KillContainers(ctx context.Context, cli *cliconfig.KillValues, signal syscall.Signal) ([]string, map[string]error, error)

KillContainers sends signal to 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) 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 LoadImage

func (*LocalRuntime) Log added in v1.2.0 

func (r *LocalRuntime) Log(c *cliconfig.LogsValues, options *logs.LogOptions) error

Log logs one or more containers

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) NetworkCreateBridge added in v1.7.0 

func (r *LocalRuntime) NetworkCreateBridge(cli *cliconfig.NetworkCreateValues) (string, error)

NetworkCreateBridge creates a CNI network

func (*LocalRuntime) NetworkCreateMacVLAN added in v1.7.0 

func (r *LocalRuntime) NetworkCreateMacVLAN(cli *cliconfig.NetworkCreateValues) (string, error)

NetworkCreateMacVLAN creates a CNI network

func (*LocalRuntime) NetworkInspect added in v1.6.0 

func (r *LocalRuntime) NetworkInspect(cli *cliconfig.NetworkInspectValues) error

NetworkInspect displays the raw CNI configuration for one or more CNI networks

func (*LocalRuntime) NetworkList added in v1.6.0 

func (r *LocalRuntime) NetworkList(cli *cliconfig.NetworkListValues) error

NetworkList displays summary information about CNI networks

func (*LocalRuntime) NetworkRemove added in v1.6.0 

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

NetworkRemove deletes one or more CNI networks

func (*LocalRuntime) New 

func (r *LocalRuntime) New(ctx context.Context, name, signaturePolicyPath, authfile string, writer io.Writer, dockeroptions *image.DockerRegistryOptions, signingoptions image.SigningOptions, label *string, pullType util.PullType) (*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) PauseContainers added in v1.3.0 

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

PauseContainers removes container(s) based on CLI inputs.

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) PlayKubeYAML added in v1.4.4 

func (r *LocalRuntime) PlayKubeYAML(ctx context.Context, c *cliconfig.KubePlayValues, yamlFile string) (*Pod, error)

PlayKubeYAML creates pods and containers from a kube YAML file

func (*LocalRuntime) PodTop added in v1.2.0 

func (r *LocalRuntime) PodTop(c *cliconfig.PodTopValues, descriptors []string) ([]string, error)

PodTop is a wrapper function to call GetPodPidInformation in libpod and return its results for output

func (*LocalRuntime) Port added in v1.3.0 

func (r *LocalRuntime) Port(c *cliconfig.PortValues) ([]*Container, error)

Port displays port information about existing containers

func (*LocalRuntime) Prune added in v1.3.0 

func (r *LocalRuntime) Prune(ctx context.Context, maxWorkers int, filters []string) ([]string, map[string]error, error)

Prune removes stopped containers

func (*LocalRuntime) PruneImages 

func (r *LocalRuntime) PruneImages(ctx context.Context, all bool, filter []string) ([]string, error)

PruneImages is wrapper into PruneImages within the image pkg

func (*LocalRuntime) PrunePods added in v1.3.0 

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

PrunePods removes pods

func (*LocalRuntime) PruneVolumes 

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

PruneVolumes is a wrapper function for libpod PruneVolumes

func (*LocalRuntime) Ps added in v1.3.0 

func (r *LocalRuntime) Ps(c *cliconfig.PsValues, opts shared.PsOptions) ([]shared.PsContainerOutput, error)

Ps ...

func (*LocalRuntime) Push 

func (r *LocalRuntime) Push(ctx context.Context, srcName, destination, manifestMIMEType, authfile, digestfile, 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) RemoteEndpoint added in v1.4.0 

func (r *LocalRuntime) RemoteEndpoint() (*Endpoint, error)

RemoteEndpoint resolve interface requirement

func (*LocalRuntime) RemoveContainers added in v1.3.0 

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

RemoveContainers removes container(s) based on CLI inputs.

func (*LocalRuntime) RemoveImage 

func (r *LocalRuntime) RemoveImage(ctx context.Context, img *ContainerImage, force bool) (*image.ImageDeleteResponse, 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, map[string]error, error)

RemoveVolumes is a wrapper to remove volumes

func (*LocalRuntime) Reset added in v1.7.0 

func (r *LocalRuntime) Reset() error

Reset the container storage back to initial states. Removes all Pods, Containers, Images and Volumes.

func (*LocalRuntime) Restart added in v1.3.0 

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

Restart containers without or without a timeout

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) Restore added in v1.3.0 

func (r *LocalRuntime) Restore(ctx context.Context, c *cliconfig.RestoreValues) error

Restore one or more containers

func (*LocalRuntime) Run added in v1.3.0 

func (r *LocalRuntime) Run(ctx context.Context, c *cliconfig.RunValues, exitCode int) (int, error)

Run a libpod container

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) Start added in v1.3.0 

func (r *LocalRuntime) Start(ctx context.Context, c *cliconfig.StartValues, sigProxy bool) (int, error)

Start will start a container

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 added in v1.1.2 

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) Top added in v1.3.0 

func (r *LocalRuntime) Top(cli *cliconfig.TopValues) ([]string, error)

Top display the running processes of a container

func (*LocalRuntime) UmountRootFilesystems added in v1.3.0 

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

UmountRootFilesystems removes container(s) based on CLI inputs.

func (*LocalRuntime) UnpauseContainers added in v1.3.0 

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

UnpauseContainers removes container(s) based on CLI inputs.

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

func (*LocalRuntime) WaitOnContainers added in v1.2.0 

func (r *LocalRuntime) WaitOnContainers(ctx context.Context, cli *cliconfig.WaitValues, interval time.Duration) ([]string, map[string]error, error)

WaitOnContainers waits for all given container(s) to stop

type Pod 

type Pod struct {
	*libpod.Pod
}

Pod encapsulates the libpod.Pod structure, helps with remote vs. local

func (*Pod) GetPodStatus 

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

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

type PodContainerStats added in v1.2.0 

type PodContainerStats struct {
	Pod            *Pod
	ContainerStats map[string]*libpod.ContainerStats
}

PodContainerStats is struct containing an adapter Pod and a libpod ContainerStats and is used primarily for outputting pod stats.

type RawTtyFormatter added in v1.3.0 

type RawTtyFormatter struct {
}

RawTtyFormatter ...

func (*RawTtyFormatter) Format added in v1.3.0 

func (f *RawTtyFormatter) Format(entry *logrus.Entry) ([]byte, error)

Format ...

type Volume 

type Volume struct {
	*libpod.Volume
}

Volume ...

type VolumeFilter 

type VolumeFilter func(*Volume) bool

VolumeFilter is for filtering volumes on the client

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.