abi

package
v4.1.2 Latest Latest
Warning

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

Go to latest
Published: Jun 10, 2022 License: Apache-2.0 Imports: 75 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ContainerEngine

type ContainerEngine struct {
	Libpod *libpod.Runtime
}

Container-related runtime linked against libpod library

func (*ContainerEngine) AutoUpdate

func (*ContainerEngine) Config

func (ic *ContainerEngine) Config(_ context.Context) (*config.Config, error)

GetConfig returns a copy of the configuration used by the runtime

func (*ContainerEngine) ContainerAttach

func (ic *ContainerEngine) ContainerAttach(ctx context.Context, nameOrID string, options entities.AttachOptions) error

func (*ContainerEngine) ContainerCheckpoint

func (ic *ContainerEngine) ContainerCheckpoint(ctx context.Context, namesOrIds []string, options entities.CheckpointOptions) ([]*entities.CheckpointReport, error)

func (*ContainerEngine) ContainerCleanup

func (ic *ContainerEngine) ContainerCleanup(ctx context.Context, namesOrIds []string, options entities.ContainerCleanupOptions) ([]*entities.ContainerCleanupReport, error)

func (*ContainerEngine) ContainerClone

func (*ContainerEngine) ContainerCommit

func (ic *ContainerEngine) ContainerCommit(ctx context.Context, nameOrID string, options entities.CommitOptions) (*entities.CommitReport, error)

func (*ContainerEngine) ContainerCopyFromArchive

func (ic *ContainerEngine) ContainerCopyFromArchive(ctx context.Context, nameOrID, containerPath string, reader io.Reader, options entities.CopyOptions) (entities.ContainerCopyFunc, error)

func (*ContainerEngine) ContainerCopyToArchive

func (ic *ContainerEngine) ContainerCopyToArchive(ctx context.Context, nameOrID, containerPath string, writer io.Writer) (entities.ContainerCopyFunc, error)

func (*ContainerEngine) ContainerCreate

func (*ContainerEngine) ContainerExec

func (ic *ContainerEngine) ContainerExec(ctx context.Context, nameOrID string, options entities.ExecOptions, streams define.AttachStreams) (int, error)

func (*ContainerEngine) ContainerExecDetached

func (ic *ContainerEngine) ContainerExecDetached(ctx context.Context, nameOrID string, options entities.ExecOptions) (string, error)

func (*ContainerEngine) ContainerExists

func (ic *ContainerEngine) ContainerExists(ctx context.Context, nameOrID string, options entities.ContainerExistsOptions) (*entities.BoolReport, error)

ContainerExists returns whether the container exists in container storage

func (*ContainerEngine) ContainerExport

func (ic *ContainerEngine) ContainerExport(ctx context.Context, nameOrID string, options entities.ContainerExportOptions) error

func (*ContainerEngine) ContainerInit

func (ic *ContainerEngine) ContainerInit(ctx context.Context, namesOrIds []string, options entities.ContainerInitOptions) ([]*entities.ContainerInitReport, error)

func (*ContainerEngine) ContainerInspect

func (ic *ContainerEngine) ContainerInspect(ctx context.Context, namesOrIds []string, options entities.InspectOptions) ([]*entities.ContainerInspectReport, []error, error)

func (*ContainerEngine) ContainerKill

func (ic *ContainerEngine) ContainerKill(ctx context.Context, namesOrIds []string, options entities.KillOptions) ([]*entities.KillReport, error)

func (*ContainerEngine) ContainerList

func (*ContainerEngine) ContainerListExternal

func (ic *ContainerEngine) ContainerListExternal(ctx context.Context) ([]entities.ListContainer, error)

func (*ContainerEngine) ContainerLogs

func (ic *ContainerEngine) ContainerLogs(ctx context.Context, containers []string, options entities.ContainerLogsOptions) error

func (*ContainerEngine) ContainerMount

func (ic *ContainerEngine) ContainerMount(ctx context.Context, nameOrIDs []string, options entities.ContainerMountOptions) ([]*entities.ContainerMountReport, error)

func (*ContainerEngine) ContainerPause

func (ic *ContainerEngine) ContainerPause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)

func (*ContainerEngine) ContainerPort

func (ic *ContainerEngine) ContainerPort(ctx context.Context, nameOrID string, options entities.ContainerPortOptions) ([]*entities.ContainerPortReport, error)

func (*ContainerEngine) ContainerPrune

func (ic *ContainerEngine) ContainerPrune(ctx context.Context, options entities.ContainerPruneOptions) ([]*reports.PruneReport, error)

func (*ContainerEngine) ContainerRename

func (ic *ContainerEngine) ContainerRename(ctx context.Context, nameOrID string, opts entities.ContainerRenameOptions) error

ContainerRename renames the given container.

func (*ContainerEngine) ContainerRestart

func (ic *ContainerEngine) ContainerRestart(ctx context.Context, namesOrIds []string, options entities.RestartOptions) ([]*entities.RestartReport, error)

func (*ContainerEngine) ContainerRestore

func (ic *ContainerEngine) ContainerRestore(ctx context.Context, namesOrIds []string, options entities.RestoreOptions) ([]*entities.RestoreReport, error)

func (*ContainerEngine) ContainerRm

func (ic *ContainerEngine) ContainerRm(ctx context.Context, namesOrIds []string, options entities.RmOptions) ([]*reports.RmReport, error)

func (*ContainerEngine) ContainerRun

func (*ContainerEngine) ContainerRunlabel

func (ic *ContainerEngine) ContainerRunlabel(ctx context.Context, label string, imageRef string, args []string, options entities.ContainerRunlabelOptions) error

func (*ContainerEngine) ContainerStart

func (ic *ContainerEngine) ContainerStart(ctx context.Context, namesOrIds []string, options entities.ContainerStartOptions) ([]*entities.ContainerStartReport, error)

func (*ContainerEngine) ContainerStat

func (ic *ContainerEngine) ContainerStat(ctx context.Context, nameOrID string, containerPath string) (*entities.ContainerStatReport, error)

func (*ContainerEngine) ContainerStats

func (ic *ContainerEngine) ContainerStats(ctx context.Context, namesOrIds []string, options entities.ContainerStatsOptions) (statsChan chan entities.ContainerStatsReport, err error)

func (*ContainerEngine) ContainerStop

func (ic *ContainerEngine) ContainerStop(ctx context.Context, namesOrIds []string, options entities.StopOptions) ([]*entities.StopReport, error)

func (*ContainerEngine) ContainerTop

func (*ContainerEngine) ContainerUnmount

func (ic *ContainerEngine) ContainerUnmount(ctx context.Context, nameOrIDs []string, options entities.ContainerUnmountOptions) ([]*entities.ContainerUnmountReport, error)

func (*ContainerEngine) ContainerUnpause

func (ic *ContainerEngine) ContainerUnpause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)

func (*ContainerEngine) ContainerWait

func (ic *ContainerEngine) ContainerWait(ctx context.Context, namesOrIds []string, options entities.WaitOptions) ([]entities.WaitReport, error)

func (*ContainerEngine) Diff

func (ic *ContainerEngine) Diff(ctx context.Context, namesOrIDs []string, opts entities.DiffOptions) (*entities.DiffReport, error)

Diff provides changes to given container

func (*ContainerEngine) Events

func (*ContainerEngine) GenerateKube

func (ic *ContainerEngine) GenerateKube(ctx context.Context, nameOrIDs []string, options entities.GenerateKubeOptions) (*entities.GenerateKubeReport, error)

func (*ContainerEngine) GenerateSystemd

func (*ContainerEngine) GetContainerExitCode

func (ic *ContainerEngine) GetContainerExitCode(ctx context.Context, ctr *libpod.Container) int

func (*ContainerEngine) HealthCheckRun

func (ic *ContainerEngine) HealthCheckRun(ctx context.Context, nameOrID string, options entities.HealthCheckOptions) (*define.HealthCheckResults, error)

func (*ContainerEngine) Info

func (ic *ContainerEngine) Info(ctx context.Context) (*define.Info, error)

func (*ContainerEngine) NetworkConnect

func (ic *ContainerEngine) NetworkConnect(ctx context.Context, networkname string, options entities.NetworkConnectOptions) error

func (*ContainerEngine) NetworkCreate

func (ic *ContainerEngine) NetworkCreate(ctx context.Context, network types.Network) (*types.Network, error)

func (*ContainerEngine) NetworkDisconnect

func (ic *ContainerEngine) NetworkDisconnect(ctx context.Context, networkname string, options entities.NetworkDisconnectOptions) error

NetworkDisconnect removes a container from a given network

func (*ContainerEngine) NetworkExists

func (ic *ContainerEngine) NetworkExists(ctx context.Context, networkname string) (*entities.BoolReport, error)

NetworkExists checks if the given network exists

func (*ContainerEngine) NetworkInspect

func (ic *ContainerEngine) NetworkInspect(ctx context.Context, namesOrIds []string, options entities.InspectOptions) ([]types.Network, []error, error)

func (*ContainerEngine) NetworkList

func (ic *ContainerEngine) NetworkList(ctx context.Context, options entities.NetworkListOptions) ([]types.Network, error)

func (*ContainerEngine) NetworkPrune

Network prune removes unused cni networks

func (*ContainerEngine) NetworkReload

func (ic *ContainerEngine) NetworkReload(ctx context.Context, names []string, options entities.NetworkReloadOptions) ([]*entities.NetworkReloadReport, error)

func (*ContainerEngine) NetworkRm

func (ic *ContainerEngine) NetworkRm(ctx context.Context, namesOrIds []string, options entities.NetworkRmOptions) ([]*entities.NetworkRmReport, error)

func (*ContainerEngine) PlayKube

func (ic *ContainerEngine) PlayKube(ctx context.Context, body io.Reader, options entities.PlayKubeOptions) (_ *entities.PlayKubeReport, finalErr error)

func (*ContainerEngine) PlayKubeDown

func (*ContainerEngine) PodCreate

func (*ContainerEngine) PodExists

func (ic *ContainerEngine) PodExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

func (*ContainerEngine) PodInspect

func (*ContainerEngine) PodKill

func (ic *ContainerEngine) PodKill(ctx context.Context, namesOrIds []string, options entities.PodKillOptions) ([]*entities.PodKillReport, error)

func (*ContainerEngine) PodLogs

func (ic *ContainerEngine) PodLogs(ctx context.Context, nameOrID string, options entities.PodLogsOptions) error

func (*ContainerEngine) PodPause

func (ic *ContainerEngine) PodPause(ctx context.Context, namesOrIds []string, options entities.PodPauseOptions) ([]*entities.PodPauseReport, error)

func (*ContainerEngine) PodPrune

func (*ContainerEngine) PodPs

func (*ContainerEngine) PodRestart

func (ic *ContainerEngine) PodRestart(ctx context.Context, namesOrIds []string, options entities.PodRestartOptions) ([]*entities.PodRestartReport, error)

func (*ContainerEngine) PodRm

func (ic *ContainerEngine) PodRm(ctx context.Context, namesOrIds []string, options entities.PodRmOptions) ([]*entities.PodRmReport, error)

func (*ContainerEngine) PodStart

func (ic *ContainerEngine) PodStart(ctx context.Context, namesOrIds []string, options entities.PodStartOptions) ([]*entities.PodStartReport, error)

func (*ContainerEngine) PodStats

func (ic *ContainerEngine) PodStats(ctx context.Context, namesOrIds []string, options entities.PodStatsOptions) ([]*entities.PodStatsReport, error)

PodStats implements printing stats about pods.

func (*ContainerEngine) PodStop

func (ic *ContainerEngine) PodStop(ctx context.Context, namesOrIds []string, options entities.PodStopOptions) ([]*entities.PodStopReport, error)

func (*ContainerEngine) PodTop

func (*ContainerEngine) PodUnpause

func (ic *ContainerEngine) PodUnpause(ctx context.Context, namesOrIds []string, options entities.PodunpauseOptions) ([]*entities.PodUnpauseReport, error)

func (*ContainerEngine) SecretCreate

func (ic *ContainerEngine) SecretCreate(ctx context.Context, name string, reader io.Reader, options entities.SecretCreateOptions) (*entities.SecretCreateReport, error)

func (*ContainerEngine) SecretInspect

func (ic *ContainerEngine) SecretInspect(ctx context.Context, nameOrIDs []string) ([]*entities.SecretInfoReport, []error, error)

func (*ContainerEngine) SecretList

func (*ContainerEngine) SecretRm

func (ic *ContainerEngine) SecretRm(ctx context.Context, nameOrIDs []string, options entities.SecretRmOptions) ([]*entities.SecretRmReport, error)

func (*ContainerEngine) SetupRootless

func (ic *ContainerEngine) SetupRootless(_ context.Context, noMoveProcess bool) error

func (*ContainerEngine) ShouldRestart

func (ic *ContainerEngine) ShouldRestart(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

ShouldRestart returns whether the container should be restarted

func (*ContainerEngine) Shutdown

func (ic *ContainerEngine) Shutdown(_ context.Context)

Shutdown Libpod engine

func (*ContainerEngine) SystemDf

func (*ContainerEngine) SystemPrune

SystemPrune removes unused data from the system. Pruning pods, containers, volumes and images.

func (*ContainerEngine) Unshare

func (ic *ContainerEngine) Unshare(ctx context.Context, args []string, options entities.SystemUnshareOptions) error

func (ContainerEngine) Version

func (*ContainerEngine) VolumeCreate

func (*ContainerEngine) VolumeExists

func (ic *ContainerEngine) VolumeExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

VolumeExists check if a given volume name exists

func (*ContainerEngine) VolumeInspect

func (ic *ContainerEngine) VolumeInspect(ctx context.Context, namesOrIds []string, opts entities.InspectOptions) ([]*entities.VolumeInspectReport, []error, error)

func (*ContainerEngine) VolumeList

func (*ContainerEngine) VolumeMount

func (ic *ContainerEngine) VolumeMount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeMountReport, error)

func (*ContainerEngine) VolumeMounted

func (ic *ContainerEngine) VolumeMounted(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

Volumemounted check if a given volume using plugin or filesystem is mounted or not.

func (*ContainerEngine) VolumePrune

func (ic *ContainerEngine) VolumePrune(ctx context.Context, options entities.VolumePruneOptions) ([]*reports.PruneReport, error)

func (*ContainerEngine) VolumeRm

func (ic *ContainerEngine) VolumeRm(ctx context.Context, namesOrIds []string, opts entities.VolumeRmOptions) ([]*entities.VolumeRmReport, error)

func (*ContainerEngine) VolumeUnmount

func (ic *ContainerEngine) VolumeUnmount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeUnmountReport, error)

type ImageEngine

type ImageEngine struct {
	Libpod *libpod.Runtime
}

Image-related runtime linked against libpod library

func (*ImageEngine) Build

func (ir *ImageEngine) Build(ctx context.Context, containerFiles []string, opts entities.BuildOptions) (*entities.BuildReport, error)

func (*ImageEngine) Config

func (ir *ImageEngine) Config(_ context.Context) (*config.Config, error)

Config returns a copy of the configuration used by the runtime

func (*ImageEngine) Exists

func (ir *ImageEngine) Exists(_ context.Context, nameOrID string) (*entities.BoolReport, error)

func (*ImageEngine) History

func (*ImageEngine) Import

func (*ImageEngine) Inspect

func (ir *ImageEngine) Inspect(ctx context.Context, namesOrIDs []string, opts entities.InspectOptions) ([]*entities.ImageInspectReport, []error, error)

func (*ImageEngine) List

func (*ImageEngine) Load

func (*ImageEngine) ManifestAdd

func (ir *ImageEngine) ManifestAdd(ctx context.Context, name string, images []string, opts entities.ManifestAddOptions) (string, error)

ManifestAdd adds images to the manifest list

func (*ImageEngine) ManifestAnnotate

func (ir *ImageEngine) ManifestAnnotate(ctx context.Context, name, image string, opts entities.ManifestAnnotateOptions) (string, error)

ManifestAnnotate updates an entry of the manifest list

func (*ImageEngine) ManifestCreate

func (ir *ImageEngine) ManifestCreate(ctx context.Context, name string, images []string, opts entities.ManifestCreateOptions) (string, error)

ManifestCreate implements logic for creating manifest lists via ImageEngine

func (*ImageEngine) ManifestExists

func (ir *ImageEngine) ManifestExists(ctx context.Context, name string) (*entities.BoolReport, error)

ManifestExists checks if a manifest list with the given name exists in local storage

func (*ImageEngine) ManifestInspect

func (ir *ImageEngine) ManifestInspect(ctx context.Context, name string) ([]byte, error)

ManifestInspect returns the content of a manifest list or image

func (*ImageEngine) ManifestPush

func (ir *ImageEngine) ManifestPush(ctx context.Context, name, destination string, opts entities.ImagePushOptions) (string, error)

ManifestPush pushes a manifest list or image index to the destination

func (*ImageEngine) ManifestRemoveDigest

func (ir *ImageEngine) ManifestRemoveDigest(ctx context.Context, name, image string) (string, error)

ManifestRemoveDigest removes specified digest from the specified manifest list

func (*ImageEngine) ManifestRm

func (ir *ImageEngine) ManifestRm(ctx context.Context, names []string) (report *entities.ImageRemoveReport, rmErrors []error)

ManifestRm removes the specified manifest list from storage

func (*ImageEngine) Mount

func (ir *ImageEngine) Mount(ctx context.Context, nameOrIDs []string, opts entities.ImageMountOptions) ([]*entities.ImageMountReport, error)

func (*ImageEngine) Prune

func (*ImageEngine) Pull

func (*ImageEngine) PullImage

func (ir *ImageEngine) PullImage(ctx context.Context, rawImage string, pullOptions *libimage.PullOptions) (io.ReadCloser, error)

func (*ImageEngine) Push

func (ir *ImageEngine) Push(ctx context.Context, source string, destination string, options entities.ImagePushOptions) error

func (*ImageEngine) Remove

func (ir *ImageEngine) Remove(ctx context.Context, images []string, opts entities.ImageRemoveOptions) (report *entities.ImageRemoveReport, rmErrors []error)

Remove removes one or more images from local storage.

func (*ImageEngine) Save

func (ir *ImageEngine) Save(ctx context.Context, nameOrID string, tags []string, options entities.ImageSaveOptions) error

func (*ImageEngine) Search

Search for images using term and filters

func (*ImageEngine) SetTrust

func (ir *ImageEngine) SetTrust(ctx context.Context, args []string, options entities.SetTrustOptions) error

func (*ImageEngine) ShowTrust

func (ir *ImageEngine) ShowTrust(ctx context.Context, args []string, options entities.ShowTrustOptions) (*entities.ShowTrustReport, error)

func (*ImageEngine) Shutdown

func (ir *ImageEngine) Shutdown(_ context.Context)

Shutdown Libpod engine

func (*ImageEngine) Sign

func (ir *ImageEngine) Sign(ctx context.Context, names []string, options entities.SignOptions) (*entities.SignReport, error)

func (*ImageEngine) Tag

func (ir *ImageEngine) Tag(ctx context.Context, nameOrID string, tags []string, options entities.ImageTagOptions) error

func (*ImageEngine) Transfer

func (ir *ImageEngine) Transfer(ctx context.Context, source entities.ImageScpOptions, dest entities.ImageScpOptions, parentFlags []string) error

Transfer moves images between root and rootless storage so the user specified in the scp call can access and use the image modified by root

func (*ImageEngine) Tree

func (*ImageEngine) Unmount

func (ir *ImageEngine) Unmount(ctx context.Context, nameOrIDs []string, options entities.ImageUnmountOptions) ([]*entities.ImageUnmountReport, error)

func (*ImageEngine) Untag

func (ir *ImageEngine) Untag(ctx context.Context, nameOrID string, tags []string, options entities.ImageUntagOptions) error

type SystemEngine

type SystemEngine struct {
	Libpod *libpod.Runtime
}

Container-related runtime linked against libpod library

func (SystemEngine) Migrate

func (*SystemEngine) Renumber

func (se *SystemEngine) Renumber(ctx context.Context, flags *pflag.FlagSet, config *entities.PodmanConfig) error

func (*SystemEngine) Reset

func (se *SystemEngine) Reset(ctx context.Context) error

func (SystemEngine) Shutdown

func (se SystemEngine) Shutdown(ctx context.Context)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL