Documentation ¶
Index ¶
- Constants
- func DecodeOverrideConfig(reader io.Reader) (*manifest.Schema2Config, error)
- func Transfer(ctx context.Context, source entities.ImageScpOptions, ...) error
- type ContainerEngine
- func (ic *ContainerEngine) AutoUpdate(ctx context.Context, options entities.AutoUpdateOptions) ([]*entities.AutoUpdateReport, []error)
- func (ic *ContainerEngine) Config(_ context.Context) (*config.Config, error)
- func (ic *ContainerEngine) ContainerAttach(ctx context.Context, nameOrID string, options entities.AttachOptions) error
- func (ic *ContainerEngine) ContainerCheckpoint(ctx context.Context, namesOrIds []string, options entities.CheckpointOptions) ([]*entities.CheckpointReport, error)
- func (ic *ContainerEngine) ContainerCleanup(ctx context.Context, namesOrIds []string, ...) ([]*entities.ContainerCleanupReport, error)
- func (ic *ContainerEngine) ContainerClone(ctx context.Context, ctrCloneOpts entities.ContainerCloneOptions) (*entities.ContainerCreateReport, error)
- func (ic *ContainerEngine) ContainerCommit(ctx context.Context, nameOrID string, options entities.CommitOptions) (*entities.CommitReport, error)
- func (ic *ContainerEngine) ContainerCopyFromArchive(ctx context.Context, nameOrID, containerPath string, reader io.Reader, ...) (entities.ContainerCopyFunc, error)
- func (ic *ContainerEngine) ContainerCopyToArchive(ctx context.Context, nameOrID, containerPath string, writer io.Writer) (entities.ContainerCopyFunc, error)
- func (ic *ContainerEngine) ContainerCreate(ctx context.Context, s *specgen.SpecGenerator) (*entities.ContainerCreateReport, error)
- func (ic *ContainerEngine) ContainerExec(ctx context.Context, nameOrID string, options entities.ExecOptions, ...) (int, error)
- func (ic *ContainerEngine) ContainerExecDetached(ctx context.Context, nameOrID string, options entities.ExecOptions) (string, error)
- func (ic *ContainerEngine) ContainerExists(ctx context.Context, nameOrID string, options entities.ContainerExistsOptions) (*entities.BoolReport, error)
- func (ic *ContainerEngine) ContainerExport(ctx context.Context, nameOrID string, options entities.ContainerExportOptions) error
- func (ic *ContainerEngine) ContainerInit(ctx context.Context, namesOrIds []string, ...) ([]*entities.ContainerInitReport, error)
- func (ic *ContainerEngine) ContainerInspect(ctx context.Context, namesOrIds []string, options entities.InspectOptions) ([]*entities.ContainerInspectReport, []error, error)
- func (ic *ContainerEngine) ContainerKill(ctx context.Context, namesOrIds []string, options entities.KillOptions) ([]*entities.KillReport, error)
- func (ic *ContainerEngine) ContainerList(ctx context.Context, options entities.ContainerListOptions) ([]entities.ListContainer, error)
- func (ic *ContainerEngine) ContainerListExternal(ctx context.Context) ([]entities.ListContainer, error)
- func (ic *ContainerEngine) ContainerLogs(ctx context.Context, namesOrIds []string, ...) error
- func (ic *ContainerEngine) ContainerMount(ctx context.Context, nameOrIDs []string, ...) ([]*entities.ContainerMountReport, error)
- func (ic *ContainerEngine) ContainerPause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)
- func (ic *ContainerEngine) ContainerPort(ctx context.Context, nameOrID string, options entities.ContainerPortOptions) ([]*entities.ContainerPortReport, error)
- func (ic *ContainerEngine) ContainerPrune(ctx context.Context, options entities.ContainerPruneOptions) ([]*reports.PruneReport, error)
- func (ic *ContainerEngine) ContainerRename(ctx context.Context, nameOrID string, opts entities.ContainerRenameOptions) error
- func (ic *ContainerEngine) ContainerRestart(ctx context.Context, namesOrIds []string, options entities.RestartOptions) ([]*entities.RestartReport, error)
- func (ic *ContainerEngine) ContainerRestore(ctx context.Context, namesOrIds []string, options entities.RestoreOptions) ([]*entities.RestoreReport, error)
- func (ic *ContainerEngine) ContainerRm(ctx context.Context, namesOrIds []string, options entities.RmOptions) ([]*reports.RmReport, error)
- func (ic *ContainerEngine) ContainerRun(ctx context.Context, opts entities.ContainerRunOptions) (*entities.ContainerRunReport, error)
- func (ic *ContainerEngine) ContainerRunlabel(ctx context.Context, label string, imageRef string, args []string, ...) error
- func (ic *ContainerEngine) ContainerStart(ctx context.Context, namesOrIds []string, ...) ([]*entities.ContainerStartReport, error)
- func (ic *ContainerEngine) ContainerStat(ctx context.Context, nameOrID string, containerPath string) (*entities.ContainerStatReport, error)
- func (ic *ContainerEngine) ContainerStats(ctx context.Context, namesOrIds []string, ...) (statsChan chan entities.ContainerStatsReport, err error)
- func (ic *ContainerEngine) ContainerStop(ctx context.Context, namesOrIds []string, options entities.StopOptions) ([]*entities.StopReport, error)
- func (ic *ContainerEngine) ContainerTop(ctx context.Context, options entities.TopOptions) (*entities.StringSliceReport, error)
- func (ic *ContainerEngine) ContainerUnmount(ctx context.Context, nameOrIDs []string, ...) ([]*entities.ContainerUnmountReport, error)
- func (ic *ContainerEngine) ContainerUnpause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)
- func (ic *ContainerEngine) ContainerUpdate(ctx context.Context, updateOptions *entities.ContainerUpdateOptions) (string, error)
- func (ic *ContainerEngine) ContainerWait(ctx context.Context, namesOrIds []string, options entities.WaitOptions) ([]entities.WaitReport, error)
- func (ic *ContainerEngine) ContainerWaitForExitCode(ctx context.Context, ctr *libpod.Container) (int, error)
- func (ic *ContainerEngine) Diff(ctx context.Context, namesOrIDs []string, opts entities.DiffOptions) (*entities.DiffReport, error)
- func (ic *ContainerEngine) Events(ctx context.Context, opts entities.EventsOptions) error
- func (ic *ContainerEngine) GenerateKube(ctx context.Context, nameOrIDs []string, options entities.GenerateKubeOptions) (*entities.GenerateKubeReport, error)
- func (ic *ContainerEngine) GenerateSpec(ctx context.Context, opts *entities.GenerateSpecOptions) (*entities.GenerateSpecReport, error)
- func (ic *ContainerEngine) GenerateSystemd(ctx context.Context, nameOrID string, options entities.GenerateSystemdOptions) (*entities.GenerateSystemdReport, error)
- func (ic *ContainerEngine) GetContainerNetStatuses() ([]ContainerNetStatus, error)
- func (ic *ContainerEngine) HealthCheckRun(ctx context.Context, nameOrID string, options entities.HealthCheckOptions) (*define.HealthCheckResults, error)
- func (ic *ContainerEngine) Info(ctx context.Context) (*define.Info, error)
- func (ic *ContainerEngine) KubeApply(ctx context.Context, body io.Reader, options entities.ApplyOptions) error
- func (ic ContainerEngine) Locks(ctx context.Context) (*entities.LocksReport, error)
- func (ic *ContainerEngine) Migrate(ctx context.Context, options entities.SystemMigrateOptions) error
- func (ic *ContainerEngine) NetworkConnect(ctx context.Context, networkname string, ...) error
- func (ic *ContainerEngine) NetworkCreate(ctx context.Context, network types.Network, ...) (*types.Network, error)
- func (ic *ContainerEngine) NetworkDisconnect(ctx context.Context, networkname string, ...) error
- func (ic *ContainerEngine) NetworkExists(ctx context.Context, networkname string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) NetworkInspect(ctx context.Context, namesOrIds []string, options entities.InspectOptions) ([]entities.NetworkInspectReport, []error, error)
- func (ic *ContainerEngine) NetworkList(ctx context.Context, options entities.NetworkListOptions) ([]types.Network, error)
- func (ic *ContainerEngine) NetworkPrune(ctx context.Context, options entities.NetworkPruneOptions) ([]*entities.NetworkPruneReport, error)
- func (ic *ContainerEngine) NetworkReload(ctx context.Context, names []string, options entities.NetworkReloadOptions) ([]*entities.NetworkReloadReport, error)
- func (ic *ContainerEngine) NetworkRm(ctx context.Context, namesOrIds []string, options entities.NetworkRmOptions) ([]*entities.NetworkRmReport, error)
- func (ic *ContainerEngine) NetworkUpdate(ctx context.Context, netName string, options entities.NetworkUpdateOptions) error
- func (ic *ContainerEngine) PlayKube(ctx context.Context, body io.Reader, options entities.PlayKubeOptions) (_ *entities.PlayKubeReport, finalErr error)
- func (ic *ContainerEngine) PlayKubeDown(ctx context.Context, body io.Reader, options entities.PlayKubeDownOptions) (*entities.PlayKubeReport, error)
- func (ic *ContainerEngine) PodClone(ctx context.Context, podClone entities.PodCloneOptions) (*entities.PodCloneReport, error)
- func (ic *ContainerEngine) PodCreate(ctx context.Context, specg entities.PodSpec) (*entities.PodCreateReport, error)
- func (ic *ContainerEngine) PodExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) PodInspect(ctx context.Context, nameOrIDs []string, options entities.InspectOptions) ([]*entities.PodInspectReport, []error, error)
- func (ic *ContainerEngine) PodKill(ctx context.Context, namesOrIds []string, options entities.PodKillOptions) ([]*entities.PodKillReport, error)
- func (ic *ContainerEngine) PodLogs(ctx context.Context, nameOrID string, options entities.PodLogsOptions) error
- func (ic *ContainerEngine) PodPause(ctx context.Context, namesOrIds []string, options entities.PodPauseOptions) ([]*entities.PodPauseReport, error)
- func (ic *ContainerEngine) PodPrune(ctx context.Context, options entities.PodPruneOptions) ([]*entities.PodPruneReport, error)
- func (ic *ContainerEngine) PodPs(ctx context.Context, options entities.PodPSOptions) ([]*entities.ListPodsReport, error)
- func (ic *ContainerEngine) PodRestart(ctx context.Context, namesOrIds []string, options entities.PodRestartOptions) ([]*entities.PodRestartReport, error)
- func (ic *ContainerEngine) PodRm(ctx context.Context, namesOrIds []string, options entities.PodRmOptions) ([]*entities.PodRmReport, error)
- func (ic *ContainerEngine) PodStart(ctx context.Context, namesOrIds []string, options entities.PodStartOptions) ([]*entities.PodStartReport, error)
- func (ic *ContainerEngine) PodStats(ctx context.Context, namesOrIds []string, options entities.PodStatsOptions) ([]*entities.PodStatsReport, error)
- func (ic *ContainerEngine) PodStop(ctx context.Context, namesOrIds []string, options entities.PodStopOptions) ([]*entities.PodStopReport, error)
- func (ic *ContainerEngine) PodTop(ctx context.Context, options entities.PodTopOptions) (*entities.StringSliceReport, error)
- func (ic *ContainerEngine) PodUnpause(ctx context.Context, namesOrIds []string, options entities.PodunpauseOptions) ([]*entities.PodUnpauseReport, error)
- func (ic *ContainerEngine) Renumber(ctx context.Context) error
- func (ic *ContainerEngine) Reset(ctx context.Context) error
- func (ic *ContainerEngine) SecretCreate(ctx context.Context, name string, reader io.Reader, ...) (*entities.SecretCreateReport, error)
- func (ic *ContainerEngine) SecretExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) SecretInspect(ctx context.Context, nameOrIDs []string, options entities.SecretInspectOptions) ([]*entities.SecretInfoReport, []error, error)
- func (ic *ContainerEngine) SecretList(ctx context.Context, opts entities.SecretListRequest) ([]*entities.SecretInfoReport, error)
- func (ic *ContainerEngine) SecretRm(ctx context.Context, nameOrIDs []string, options entities.SecretRmOptions) ([]*entities.SecretRmReport, error)
- func (ic *ContainerEngine) SetupRootless(_ context.Context, noMoveProcess bool, cgroupMode string) error
- func (ic *ContainerEngine) ShouldRestart(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) Shutdown(_ context.Context)
- func (ic ContainerEngine) SystemCheck(ctx context.Context, options entities.SystemCheckOptions) (*entities.SystemCheckReport, error)
- func (ic *ContainerEngine) SystemDf(ctx context.Context, options entities.SystemDfOptions) (*entities.SystemDfReport, error)
- func (ic *ContainerEngine) SystemPrune(ctx context.Context, options entities.SystemPruneOptions) (*entities.SystemPruneReport, error)
- func (ic *ContainerEngine) Unshare(ctx context.Context, args []string, options entities.SystemUnshareOptions) error
- func (ic ContainerEngine) Version(ctx context.Context) (*entities.SystemVersionReport, error)
- func (ic *ContainerEngine) VolumeCreate(ctx context.Context, opts entities.VolumeCreateOptions) (*entities.IDOrNameResponse, error)
- func (ic *ContainerEngine) VolumeExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) VolumeInspect(ctx context.Context, namesOrIds []string, opts entities.InspectOptions) ([]*entities.VolumeInspectReport, []error, error)
- func (ic *ContainerEngine) VolumeList(ctx context.Context, opts entities.VolumeListOptions) ([]*entities.VolumeListReport, error)
- func (ic *ContainerEngine) VolumeMount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeMountReport, error)
- func (ic *ContainerEngine) VolumeMounted(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ic *ContainerEngine) VolumePrune(ctx context.Context, options entities.VolumePruneOptions) ([]*reports.PruneReport, error)
- func (ic *ContainerEngine) VolumeReload(ctx context.Context) (*entities.VolumeReloadReport, error)
- func (ic *ContainerEngine) VolumeRm(ctx context.Context, namesOrIds []string, opts entities.VolumeRmOptions) ([]*entities.VolumeRmReport, error)
- func (ic *ContainerEngine) VolumeUnmount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeUnmountReport, error)
- type ContainerNetStatus
- type FarmNode
- type ImageEngine
- func (ir *ImageEngine) Build(ctx context.Context, containerFiles []string, opts entities.BuildOptions) (*entities.BuildReport, error)
- func (ir *ImageEngine) Config(_ context.Context) (*config.Config, error)
- func (ir *ImageEngine) Exists(_ context.Context, nameOrID string) (*entities.BoolReport, error)
- func (ir *ImageEngine) FarmNodeDriver(ctx context.Context) string
- func (ir *ImageEngine) FarmNodeInspect(ctx context.Context) (*entities.FarmInspectReport, error)
- func (ir *ImageEngine) FarmNodeName(ctx context.Context) string
- func (ir *ImageEngine) History(ctx context.Context, nameOrID string, opts entities.ImageHistoryOptions) (*entities.ImageHistoryReport, error)
- func (ir *ImageEngine) Import(ctx context.Context, options entities.ImageImportOptions) (*entities.ImageImportReport, error)
- func (ir *ImageEngine) Inspect(ctx context.Context, namesOrIDs []string, opts entities.InspectOptions) ([]*entities.ImageInspectReport, []error, error)
- func (ir *ImageEngine) List(ctx context.Context, opts entities.ImageListOptions) ([]*entities.ImageSummary, error)
- func (ir *ImageEngine) Load(ctx context.Context, options entities.ImageLoadOptions) (*entities.ImageLoadReport, error)
- func (ir *ImageEngine) ManifestAdd(ctx context.Context, name string, images []string, ...) (string, error)
- func (ir *ImageEngine) ManifestAddArtifact(ctx context.Context, name string, files []string, ...) (string, error)
- func (ir *ImageEngine) ManifestAnnotate(ctx context.Context, name, image string, opts entities.ManifestAnnotateOptions) (string, error)
- func (ir *ImageEngine) ManifestCreate(ctx context.Context, name string, images []string, ...) (string, error)
- func (ir *ImageEngine) ManifestExists(ctx context.Context, name string) (*entities.BoolReport, error)
- func (ir *ImageEngine) ManifestInspect(ctx context.Context, name string, opts entities.ManifestInspectOptions) ([]byte, error)
- func (ir *ImageEngine) ManifestListClear(ctx context.Context, name string) (string, error)
- func (ir *ImageEngine) ManifestPush(ctx context.Context, name, destination string, opts entities.ImagePushOptions) (string, error)
- func (ir *ImageEngine) ManifestRemoveDigest(ctx context.Context, name, image string) (string, error)
- func (ir *ImageEngine) ManifestRm(ctx context.Context, names []string) (report *entities.ImageRemoveReport, rmErrors []error)
- func (ir *ImageEngine) Mount(ctx context.Context, nameOrIDs []string, opts entities.ImageMountOptions) ([]*entities.ImageMountReport, error)
- func (ir *ImageEngine) Prune(ctx context.Context, opts entities.ImagePruneOptions) ([]*reports.PruneReport, error)
- func (ir *ImageEngine) Pull(ctx context.Context, rawImage string, options entities.ImagePullOptions) (*entities.ImagePullReport, error)
- func (ir *ImageEngine) Push(ctx context.Context, source string, destination string, ...) (*entities.ImagePushReport, error)
- func (ir *ImageEngine) Remove(ctx context.Context, images []string, opts entities.ImageRemoveOptions) (report *entities.ImageRemoveReport, rmErrors []error)
- func (ir *ImageEngine) Save(ctx context.Context, nameOrID string, tags []string, ...) error
- func (ir *ImageEngine) Scp(ctx context.Context, src, dst string, parentFlags []string, quiet bool, ...) error
- func (ir *ImageEngine) Search(ctx context.Context, term string, opts entities.ImageSearchOptions) ([]entities.ImageSearchReport, error)
- func (ir *ImageEngine) SetTrust(ctx context.Context, args []string, options entities.SetTrustOptions) error
- func (ir *ImageEngine) ShowTrust(ctx context.Context, args []string, options entities.ShowTrustOptions) (*entities.ShowTrustReport, error)
- func (ir *ImageEngine) Shutdown(_ context.Context)
- func (ir *ImageEngine) Sign(ctx context.Context, names []string, options entities.SignOptions) (*entities.SignReport, error)
- func (ir *ImageEngine) Tag(ctx context.Context, nameOrID string, tags []string, ...) error
- func (ir *ImageEngine) Tree(ctx context.Context, nameOrID string, opts entities.ImageTreeOptions) (*entities.ImageTreeReport, error)
- func (ir *ImageEngine) Unmount(ctx context.Context, nameOrIDs []string, options entities.ImageUnmountOptions) ([]*entities.ImageUnmountReport, error)
- func (ir *ImageEngine) Untag(ctx context.Context, nameOrID string, tags []string, ...) error
- type SystemEngine
Constants ¶
const UnknownDigestSuffix = docker.UnknownDigestSuffix
Variables ¶
This section is empty.
Functions ¶
func DecodeOverrideConfig ¶
func DecodeOverrideConfig(reader io.Reader) (*manifest.Schema2Config, error)
DecodeOverrideConfig reads a Schema2Config from a Reader, suppressing EOF errors.
func Transfer ¶
func Transfer(ctx context.Context, source entities.ImageScpOptions, dest entities.ImageScpOptions, parentFlags []string) error
Types ¶
type ContainerEngine ¶
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) 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 (ic *ContainerEngine) ContainerClone(ctx context.Context, ctrCloneOpts entities.ContainerCloneOptions) (*entities.ContainerCreateReport, 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, 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 (ic *ContainerEngine) ContainerCreate(ctx context.Context, s *specgen.SpecGenerator) (*entities.ContainerCreateReport, error)
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) ContainerListExternal ¶
func (ic *ContainerEngine) ContainerListExternal(ctx context.Context) ([]entities.ListContainer, error)
func (*ContainerEngine) ContainerLogs ¶
func (ic *ContainerEngine) ContainerLogs(ctx context.Context, namesOrIds []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 (*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) ContainerUpdate ¶
func (ic *ContainerEngine) ContainerUpdate(ctx context.Context, updateOptions *entities.ContainerUpdateOptions) (string, error)
ContainerUpdate finds and updates the given container's cgroup config with the specified options
func (*ContainerEngine) ContainerWait ¶
func (ic *ContainerEngine) ContainerWait(ctx context.Context, namesOrIds []string, options entities.WaitOptions) ([]entities.WaitReport, error)
func (*ContainerEngine) ContainerWaitForExitCode ¶ added in v5.2.0
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 (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) GenerateSpec ¶
func (ic *ContainerEngine) GenerateSpec(ctx context.Context, opts *entities.GenerateSpecOptions) (*entities.GenerateSpecReport, error)
func (*ContainerEngine) GenerateSystemd ¶
func (ic *ContainerEngine) GenerateSystemd(ctx context.Context, nameOrID string, options entities.GenerateSystemdOptions) (*entities.GenerateSystemdReport, error)
func (*ContainerEngine) GetContainerNetStatuses ¶
func (ic *ContainerEngine) GetContainerNetStatuses() ([]ContainerNetStatus, error)
func (*ContainerEngine) HealthCheckRun ¶
func (ic *ContainerEngine) HealthCheckRun(ctx context.Context, nameOrID string, options entities.HealthCheckOptions) (*define.HealthCheckResults, error)
func (*ContainerEngine) KubeApply ¶
func (ic *ContainerEngine) KubeApply(ctx context.Context, body io.Reader, options entities.ApplyOptions) error
func (ContainerEngine) Locks ¶
func (ic ContainerEngine) Locks(ctx context.Context) (*entities.LocksReport, error)
func (*ContainerEngine) Migrate ¶
func (ic *ContainerEngine) Migrate(ctx context.Context, options entities.SystemMigrateOptions) 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, createOptions *types.NetworkCreateOptions) (*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) ([]entities.NetworkInspectReport, []error, error)
func (*ContainerEngine) NetworkList ¶
func (ic *ContainerEngine) NetworkList(ctx context.Context, options entities.NetworkListOptions) ([]types.Network, error)
func (*ContainerEngine) NetworkPrune ¶
func (ic *ContainerEngine) NetworkPrune(ctx context.Context, options entities.NetworkPruneOptions) ([]*entities.NetworkPruneReport, error)
Network prune removes unused 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) NetworkUpdate ¶
func (ic *ContainerEngine) NetworkUpdate(ctx context.Context, netName string, options entities.NetworkUpdateOptions) 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 (ic *ContainerEngine) PlayKubeDown(ctx context.Context, body io.Reader, options entities.PlayKubeDownOptions) (*entities.PlayKubeReport, error)
func (*ContainerEngine) PodClone ¶
func (ic *ContainerEngine) PodClone(ctx context.Context, podClone entities.PodCloneOptions) (*entities.PodCloneReport, error)
func (*ContainerEngine) PodCreate ¶
func (ic *ContainerEngine) PodCreate(ctx context.Context, specg entities.PodSpec) (*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, nameOrIDs []string, options entities.InspectOptions) ([]*entities.PodInspectReport, []error, error)
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 (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 ¶
func (ic *ContainerEngine) SecretCreate(ctx context.Context, name string, reader io.Reader, options entities.SecretCreateOptions) (*entities.SecretCreateReport, error)
func (*ContainerEngine) SecretExists ¶
func (ic *ContainerEngine) SecretExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)
func (*ContainerEngine) SecretInspect ¶
func (ic *ContainerEngine) SecretInspect(ctx context.Context, nameOrIDs []string, options entities.SecretInspectOptions) ([]*entities.SecretInfoReport, []error, error)
func (*ContainerEngine) SecretList ¶
func (ic *ContainerEngine) SecretList(ctx context.Context, opts entities.SecretListRequest) ([]*entities.SecretInfoReport, error)
func (*ContainerEngine) SecretRm ¶
func (ic *ContainerEngine) SecretRm(ctx context.Context, nameOrIDs []string, options entities.SecretRmOptions) ([]*entities.SecretRmReport, error)
func (*ContainerEngine) SetupRootless ¶
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) SystemCheck ¶ added in v5.2.0
func (ic ContainerEngine) SystemCheck(ctx context.Context, options entities.SystemCheckOptions) (*entities.SystemCheckReport, error)
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, networks, 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 ¶
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) 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) VolumeReload ¶
func (ic *ContainerEngine) VolumeReload(ctx context.Context) (*entities.VolumeReloadReport, 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 ContainerNetStatus ¶
type ContainerNetStatus struct { // Name of the container Name string // ID of the container ID string // Status contains the net status, the key is the network name Status map[string]types.StatusBlock }
type ImageEngine ¶
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) Exists ¶
func (ir *ImageEngine) Exists(_ context.Context, nameOrID string) (*entities.BoolReport, error)
func (*ImageEngine) FarmNodeDriver ¶
func (ir *ImageEngine) FarmNodeDriver(ctx context.Context) string
FarmNodeDriver returns a description of the local image builder driver
func (*ImageEngine) FarmNodeInspect ¶
func (ir *ImageEngine) FarmNodeInspect(ctx context.Context) (*entities.FarmInspectReport, error)
FarmNodeInspect returns information about the remote engines in the farm
func (*ImageEngine) FarmNodeName ¶
func (ir *ImageEngine) FarmNodeName(ctx context.Context) string
FarmNodeName returns the local engine's name.
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, name string, images []string, opts entities.ManifestAddOptions) (string, error)
ManifestAdd adds images to the manifest list
func (*ImageEngine) ManifestAddArtifact ¶
func (ir *ImageEngine) ManifestAddArtifact(ctx context.Context, name string, files []string, opts entities.ManifestAddArtifactOptions) (string, error)
ManifestAddArtifact creates artifact manifest for files and adds them 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, opts entities.ManifestInspectOptions) ([]byte, error)
ManifestInspect returns the content of a manifest list or image
func (*ImageEngine) ManifestListClear ¶
ManifestListClear clears out all instances from the manifest list
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 (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) (*entities.ImagePushReport, 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) Scp ¶
func (ir *ImageEngine) Scp(ctx context.Context, src, dst string, parentFlags []string, quiet bool, sshMode ssh.EngineMode) error
func (*ImageEngine) Search ¶
func (ir *ImageEngine) Search(ctx context.Context, term string, opts entities.ImageSearchOptions) ([]entities.ImageSearchReport, error)
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) 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 ¶
Container-related runtime linked against libpod library
func (SystemEngine) Shutdown ¶
func (se SystemEngine) Shutdown(ctx context.Context)
Source Files ¶
- apply.go
- archive.go
- auto-update.go
- config.go
- containers.go
- containers_linux.go
- containers_runlabel.go
- containers_stat.go
- events.go
- farm.go
- generate.go
- healthcheck.go
- images.go
- images_list.go
- manifest.go
- network.go
- play.go
- play_utils.go
- pods.go
- pods_stats.go
- runtime.go
- secrets.go
- system.go
- system_linux.go
- trust.go
- volumes.go