abi

package
v3.2.1 Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2021 License: Apache-2.0 Imports: 70 Imported by: 4

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 (ic *ContainerEngine) AutoUpdate(ctx context.Context, options entities.AutoUpdateOptions) (*entities.AutoUpdateReport, []error)

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) 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 string, containerPath string, reader io.Reader) (entities.ContainerCopyFunc, error)

func (*ContainerEngine) ContainerCopyToArchive 

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

func (*ContainerEngine) ContainerCreate 

func (ic *ContainerEngine) ContainerCreate(ctx context.Context, s *specgen.SpecGenerator) (*entities.ContainerCreateReport, error)

func (*ContainerEngine) ContainerDiff 

func (ic *ContainerEngine) ContainerDiff(ctx context.Context, nameOrID string, opts entities.DiffOptions) (*entities.DiffReport, error)

ContainerDiff provides changes to given container

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 (ic *ContainerEngine) ContainerList(ctx context.Context, options entities.ContainerListOptions) ([]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) ([]*entities.RmReport, error)

func (*ContainerEngine) ContainerRun 

func (ic *ContainerEngine) ContainerRun(ctx context.Context, opts entities.ContainerRunOptions) (*entities.ContainerRunReport, error)

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 (ic *ContainerEngine) ContainerTop(ctx context.Context, options entities.TopOptions) (*entities.StringSliceReport, error)

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) Events 

func (ic *ContainerEngine) Events(ctx context.Context, opts entities.EventsOptions) error

func (*ContainerEngine) GenerateKube 

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

func (*ContainerEngine) GenerateSystemd 

func (ic *ContainerEngine) GenerateSystemd(ctx context.Context, nameOrID string, options entities.GenerateSystemdOptions) (*entities.GenerateSystemdReport, error)

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, name string, options entities.NetworkCreateOptions) (*entities.NetworkCreateReport, 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 added in v3.1.0 

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) ([]entities.NetworkInspectReport, []error, error)

func (*ContainerEngine) NetworkList 

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

func (*ContainerEngine) NetworkPrune added in v3.1.0 

func (ic *ContainerEngine) NetworkPrune(ctx context.Context, options entities.NetworkPruneOptions) ([]*entities.NetworkPruneReport, error)

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, path string, options entities.PlayKubeOptions) (*entities.PlayKubeReport, error)

func (*ContainerEngine) PodCreate 

func (ic *ContainerEngine) PodCreate(ctx context.Context, opts entities.PodCreateOptions) (*entities.PodCreateReport, error)

func (*ContainerEngine) PodExists 

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

func (*ContainerEngine) PodInspect 

func (ic *ContainerEngine) PodInspect(ctx context.Context, options entities.PodInspectOptions) (*entities.PodInspectReport, error)

func (*ContainerEngine) PodKill 

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

func (*ContainerEngine) PodPause 

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

func (*ContainerEngine) PodPrune 

func (ic *ContainerEngine) PodPrune(ctx context.Context, options entities.PodPruneOptions) ([]*entities.PodPruneReport, error)

func (*ContainerEngine) PodPs 

func (ic *ContainerEngine) PodPs(ctx context.Context, options entities.PodPSOptions) ([]*entities.ListPodsReport, error)

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 (ic *ContainerEngine) PodTop(ctx context.Context, options entities.PodTopOptions) (*entities.StringSliceReport, error)

func (*ContainerEngine) PodUnpause 

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

func (*ContainerEngine) SecretCreate added in v3.1.0 

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

func (*ContainerEngine) SecretInspect added in v3.1.0 

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

func (*ContainerEngine) SecretList added in v3.1.0 

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

func (*ContainerEngine) SecretRm added in v3.1.0 

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

func (*ContainerEngine) SetupRootless 

func (ic *ContainerEngine) SetupRootless(_ context.Context, cmd *cobra.Command) 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 (ic *ContainerEngine) SystemDf(ctx context.Context, options entities.SystemDfOptions) (*entities.SystemDfReport, error)

func (*ContainerEngine) SystemPrune 

func (ic *ContainerEngine) SystemPrune(ctx context.Context, options entities.SystemPruneOptions) (*entities.SystemPruneReport, error)

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 (ic ContainerEngine) Version(ctx context.Context) (*entities.SystemVersionReport, error)

func (*ContainerEngine) VolumeCreate 

func (ic *ContainerEngine) VolumeCreate(ctx context.Context, opts entities.VolumeCreateOptions) (*entities.IDOrNameResponse, error)

func (*ContainerEngine) VolumeExists added in v3.1.0 

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 (ic *ContainerEngine) VolumeList(ctx context.Context, opts entities.VolumeListOptions) ([]*entities.VolumeListReport, error)

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)

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)

GetConfig returns a copy of the configuration used by the runtime

func (*ImageEngine) Diff 

func (ir *ImageEngine) Diff(_ context.Context, nameOrID string, _ entities.DiffOptions) (*entities.DiffReport, error)

func (*ImageEngine) Exists 

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

func (*ImageEngine) History 

func (ir *ImageEngine) History(ctx context.Context, nameOrID string, opts entities.ImageHistoryOptions) (*entities.ImageHistoryReport, error)

func (*ImageEngine) Import 

func (ir *ImageEngine) Import(ctx context.Context, options entities.ImageImportOptions) (*entities.ImageImportReport, error)

func (*ImageEngine) Inspect 

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

func (*ImageEngine) List 

func (ir *ImageEngine) List(ctx context.Context, opts entities.ImageListOptions) ([]*entities.ImageSummary, error)

func (*ImageEngine) Load 

func (ir *ImageEngine) Load(ctx context.Context, options entities.ImageLoadOptions) (*entities.ImageLoadReport, error)

func (*ImageEngine) ManifestAdd 

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

ManifestAdd adds images to the manifest list

func (*ImageEngine) ManifestAnnotate 

func (ir *ImageEngine) ManifestAnnotate(ctx context.Context, names []string, opts entities.ManifestAnnotateOptions) (string, error)

ManifestAnnotate updates an entry of the manifest list

func (*ImageEngine) ManifestCreate 

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

ManifestCreate implements logic for creating manifest lists via ImageEngine

func (*ImageEngine) ManifestExists added in v3.1.0 

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) ManifestRemove 

func (ir *ImageEngine) ManifestRemove(ctx context.Context, names []string) (string, error)

ManifestRemove removes specified digest from the specified manifest list

func (*ImageEngine) Mount 

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

func (*ImageEngine) Prune 

func (ir *ImageEngine) Prune(ctx context.Context, opts entities.ImagePruneOptions) ([]*reports.PruneReport, error)

func (*ImageEngine) Pull 

func (ir *ImageEngine) Pull(ctx context.Context, rawImage string, options entities.ImagePullOptions) (*entities.ImagePullReport, 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 

func (ir *ImageEngine) Search(ctx context.Context, term string, opts entities.ImageSearchOptions) ([]entities.ImageSearchReport, error)

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) Tree 

func (ir *ImageEngine) Tree(ctx context.Context, nameOrID string, opts entities.ImageTreeOptions) (*entities.ImageTreeReport, error)

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 (se SystemEngine) Migrate(ctx context.Context, flags *pflag.FlagSet, config *entities.PodmanConfig, options entities.SystemMigrateOptions) error

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)

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.