Documentation ¶
Overview ¶
instructions: https://podman.io/blogs/2019/01/16/podman-varlink.html
Podman Service Interface and API description. The master version of this document can be found in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in the upstream libpod repository.
Index ¶
- func Dispatch_Error(err error) error
- type AttachControl_methods
- type Attach_methods
- type BuildImageHierarchyMap_methods
- func (m BuildImageHierarchyMap_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (imageInfo_out_ string, err_ error)
- func (m BuildImageHierarchyMap_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type BuildImage_methods
- func (m BuildImage_methods) Call(ctx context.Context, c *varlink.Connection, build_in_ BuildInfo) (image_out_ MoreResponse, err_ error)
- func (m BuildImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, build_in_ BuildInfo) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type BuildInfo
- type BuildOptions
- type Commit_methods
- func (m Commit_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (reply_out_ MoreResponse, err_ error)
- func (m Commit_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type Container
- type ContainerArtifacts_methods
- func (m ContainerArtifacts_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (config_out_ string, err_ error)
- func (m ContainerArtifacts_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerChanges
- type ContainerCheckpoint_methods
- func (m ContainerCheckpoint_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, keep_in_ bool, ...) (id_out_ string, err_ error)
- func (m ContainerCheckpoint_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerConfig_methods
- func (m ContainerConfig_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
- func (m ContainerConfig_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerExists_methods
- func (m ContainerExists_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (exists_out_ int64, err_ error)
- func (m ContainerExists_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (int64, uint64, error), error)
- type ContainerInspectData_methods
- func (m ContainerInspectData_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, size_in_ bool) (config_out_ string, err_ error)
- func (m ContainerInspectData_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerMount
- type ContainerNameSpace
- type ContainerNotFound
- type ContainerPortMappings
- type ContainerRestore_methods
- func (m ContainerRestore_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, keep_in_ bool, ...) (id_out_ string, err_ error)
- func (m ContainerRestore_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerRunlabel_methods
- type ContainerStateData_methods
- func (m ContainerStateData_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
- func (m ContainerStateData_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type ContainerStats
- type Create
- type CreateContainer_methods
- func (m CreateContainer_methods) Call(ctx context.Context, c *varlink.Connection, create_in_ Create) (container_out_ string, err_ error)
- func (m CreateContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, create_in_ Create) (func(ctx context.Context) (string, uint64, error), error)
- type CreateFromCC_methods
- type CreatePod_methods
- type DeleteStoppedContainers_methods
- type DeleteUnusedImages_methods
- type DiffInfo
- type Diff_methods
- type ErrCtrStopped
- type ErrRequiresCgroupsV2ForRootless
- type ErrorOccurred
- type Event
- type EvictContainer_methods
- func (m EvictContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (container_out_ string, err_ error)
- func (m EvictContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ExecContainer_methods
- type ExecOpts
- type ExportContainer_methods
- func (m ExportContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, path_in_ string) (tarfile_out_ string, err_ error)
- func (m ExportContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type ExportImage_methods
- func (m ExportImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (image_out_ string, err_ error)
- func (m ExportImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type GenerateKube_methods
- func (m GenerateKube_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, service_in_ bool) (pod_out_ KubePodService, err_ error)
- func (m GenerateKube_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (KubePodService, uint64, error), error)
- type GetAttachSockets_methods
- func (m GetAttachSockets_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (sockets_out_ Sockets, err_ error)
- func (m GetAttachSockets_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (Sockets, uint64, error), error)
- type GetContainerLogs_methods
- func (m GetContainerLogs_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ []string, err_ error)
- func (m GetContainerLogs_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) ([]string, uint64, error), error)
- type GetContainerStatsWithHistory_methods
- func (m GetContainerStatsWithHistory_methods) Call(ctx context.Context, c *varlink.Connection, previousStats_in_ ContainerStats) (container_out_ ContainerStats, err_ error)
- func (m GetContainerStatsWithHistory_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, ...) (func(ctx context.Context) (ContainerStats, uint64, error), error)
- type GetContainerStats_methods
- func (m GetContainerStats_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ ContainerStats, err_ error)
- func (m GetContainerStats_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (ContainerStats, uint64, error), error)
- type GetContainer_methods
- func (m GetContainer_methods) Call(ctx context.Context, c *varlink.Connection, id_in_ string) (container_out_ Container, err_ error)
- func (m GetContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, id_in_ string) (func(ctx context.Context) (Container, uint64, error), error)
- type GetContainersByContext_methods
- func (m GetContainersByContext_methods) Call(ctx context.Context, c *varlink.Connection, all_in_ bool, latest_in_ bool, ...) (containers_out_ []string, err_ error)
- func (m GetContainersByContext_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, all_in_ bool, ...) (func(ctx context.Context) ([]string, uint64, error), error)
- type GetContainersByStatus_methods
- func (m GetContainersByStatus_methods) Call(ctx context.Context, c *varlink.Connection, status_in_ []string) (containerS_out_ []Container, err_ error)
- func (m GetContainersByStatus_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, status_in_ []string) (func(ctx context.Context) ([]Container, uint64, error), error)
- type GetContainersLogs_methods
- func (m GetContainersLogs_methods) Call(ctx context.Context, c *varlink.Connection, names_in_ []string, ...) (log_out_ LogLine, err_ error)
- func (m GetContainersLogs_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, names_in_ []string, ...) (func(ctx context.Context) (LogLine, uint64, error), error)
- type GetEvents_methods
- func (m GetEvents_methods) Call(ctx context.Context, c *varlink.Connection, filter_in_ []string, ...) (events_out_ Event, err_ error)
- func (m GetEvents_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, filter_in_ []string, ...) (func(ctx context.Context) (Event, uint64, error), error)
- type GetImage_methods
- type GetInfo_methods
- type GetLayersMapWithImageInfo_methods
- type GetPodStats_methods
- func (m GetPodStats_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, containers_out_ []ContainerStats, err_ error)
- func (m GetPodStats_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, []ContainerStats, uint64, error), error)
- type GetPod_methods
- type GetPodsByContext_methods
- func (m GetPodsByContext_methods) Call(ctx context.Context, c *varlink.Connection, all_in_ bool, latest_in_ bool, ...) (pods_out_ []string, err_ error)
- func (m GetPodsByContext_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, all_in_ bool, ...) (func(ctx context.Context) ([]string, uint64, error), error)
- type GetPodsByStatus_methods
- type GetVersion_methods
- type GetVolumes_methods
- func (m GetVolumes_methods) Call(ctx context.Context, c *varlink.Connection, args_in_ []string, all_in_ bool) (volumes_out_ []Volume, err_ error)
- func (m GetVolumes_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, args_in_ []string, ...) (func(ctx context.Context) ([]Volume, uint64, error), error)
- type HealthCheckRun_methods
- func (m HealthCheckRun_methods) Call(ctx context.Context, c *varlink.Connection, nameOrID_in_ string) (healthCheckStatus_out_ string, err_ error)
- func (m HealthCheckRun_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, nameOrID_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type HistoryImage_methods
- func (m HistoryImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (history_out_ []ImageHistory, err_ error)
- func (m HistoryImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) ([]ImageHistory, uint64, error), error)
- type Image
- type ImageExists_methods
- type ImageHistory
- type ImageNotFound
- type ImageSaveOptions
- type ImageSave_methods
- func (m ImageSave_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ ImageSaveOptions) (reply_out_ MoreResponse, err_ error)
- func (m ImageSave_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, ...) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type ImageSearchFilter
- type ImageSearchResult
- type ImagesPrune_methods
- type ImportImage_methods
- func (m ImportImage_methods) Call(ctx context.Context, c *varlink.Connection, source_in_ string, ...) (image_out_ string, err_ error)
- func (m ImportImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, source_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type InfoDistribution
- type InfoGraphStatus
- type InfoHost
- type InfoPodmanBinary
- type InfoStore
- type InitContainer_methods
- func (m InitContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
- func (m InitContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type InspectContainer_methods
- func (m InspectContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
- func (m InspectContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type InspectImage_methods
- type InspectPod_methods
- type InvalidState
- type KillContainer_methods
- func (m KillContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, signal_in_ int64) (container_out_ string, err_ error)
- func (m KillContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type KillPod_methods
- func (m KillPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, signal_in_ int64) (pod_out_ string, err_ error)
- func (m KillPod_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type KubePodService
- type ListContainerChanges_methods
- func (m ListContainerChanges_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ ContainerChanges, err_ error)
- func (m ListContainerChanges_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (ContainerChanges, uint64, error), error)
- type ListContainerMounts_methods
- type ListContainerProcesses_methods
- func (m ListContainerProcesses_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, opts_in_ []string) (container_out_ []string, err_ error)
- func (m ListContainerProcesses_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) ([]string, uint64, error), error)
- type ListContainers_methods
- type ListImages_methods
- type ListPodContainerInfo
- type ListPodData
- type ListPods_methods
- type LoadImage_methods
- func (m LoadImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (reply_out_ MoreResponse, err_ error)
- func (m LoadImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type LogLine
- type MoreResponse
- type MountContainer_methods
- type NoContainerRunning
- type NoContainersInPod
- type NotImplemented
- type PauseContainer_methods
- func (m PauseContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
- func (m PauseContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type PausePod_methods
- type PodContainerError
- type PodContainerErrorData
- type PodCreate
- type PodNotFound
- type PodStateData_methods
- type PodmanInfo
- type PsContainer
- type PsOpts
- type Ps_methods
- type PullImage_methods
- func (m PullImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (reply_out_ MoreResponse, err_ error)
- func (m PullImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type PushImage_methods
- func (m PushImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, tag_in_ string, ...) (reply_out_ MoreResponse, err_ error)
- func (m PushImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (MoreResponse, uint64, error), error)
- type ReceiveFile_methods
- func (m ReceiveFile_methods) Call(ctx context.Context, c *varlink.Connection, path_in_ string, delete_in_ bool) (len_out_ int64, err_ error)
- func (m ReceiveFile_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, path_in_ string, ...) (func(ctx context.Context) (int64, uint64, error), error)
- type RemoveContainer_methods
- func (m RemoveContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, force_in_ bool, ...) (container_out_ string, err_ error)
- func (m RemoveContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type RemoveImage_methods
- func (m RemoveImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, force_in_ bool) (image_out_ string, err_ error)
- func (m RemoveImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type RemovePod_methods
- func (m RemovePod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, force_in_ bool) (pod_out_ string, err_ error)
- func (m RemovePod_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type RestartContainer_methods
- func (m RestartContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, timeout_in_ int64) (container_out_ string, err_ error)
- func (m RestartContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type RestartPod_methods
- type Runlabel
- type RuntimeError
- type SearchImages_methods
- func (m SearchImages_methods) Call(ctx context.Context, c *varlink.Connection, query_in_ string, limit_in_ *int64, ...) (results_out_ []ImageSearchResult, err_ error)
- func (m SearchImages_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, query_in_ string, ...) (func(ctx context.Context) ([]ImageSearchResult, uint64, error), error)
- type SendFile_methods
- func (m SendFile_methods) Call(ctx context.Context, c *varlink.Connection, type_in_ string, length_in_ int64) (file_handle_out_ string, err_ error)
- func (m SendFile_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, type_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type Sockets
- type Spec_methods
- type StartContainer_methods
- func (m StartContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
- func (m StartContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type StartPod_methods
- type StopContainer_methods
- func (m StopContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, timeout_in_ int64) (container_out_ string, err_ error)
- func (m StopContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type StopPod_methods
- func (m StopPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, timeout_in_ int64) (pod_out_ string, err_ error)
- func (m StopPod_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type StringResponse
- type TagImage_methods
- func (m TagImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, tagged_in_ string) (image_out_ string, err_ error)
- func (m TagImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (string, uint64, error), error)
- type TopPod_methods
- func (m TopPod_methods) Call(ctx context.Context, c *varlink.Connection, pod_in_ string, latest_in_ bool, ...) (stats_out_ []string, err_ error)
- func (m TopPod_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, pod_in_ string, ...) (func(ctx context.Context) ([]string, uint64, error), error)
- type Top_methods
- type UnmountContainer_methods
- type UnpauseContainer_methods
- func (m UnpauseContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
- func (m UnpauseContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (string, uint64, error), error)
- type UnpausePod_methods
- type VarlinkCall
- func (c *VarlinkCall) ReplyAttach(ctx context.Context) error
- func (c *VarlinkCall) ReplyAttachControl(ctx context.Context) error
- func (c *VarlinkCall) ReplyBuildImage(ctx context.Context, image_ MoreResponse) error
- func (c *VarlinkCall) ReplyBuildImageHierarchyMap(ctx context.Context, imageInfo_ string) error
- func (c *VarlinkCall) ReplyCommit(ctx context.Context, reply_ MoreResponse) error
- func (c *VarlinkCall) ReplyContainerArtifacts(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyContainerCheckpoint(ctx context.Context, id_ string) error
- func (c *VarlinkCall) ReplyContainerConfig(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyContainerExists(ctx context.Context, exists_ int64) error
- func (c *VarlinkCall) ReplyContainerInspectData(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyContainerNotFound(ctx context.Context, id_ string, reason_ string) error
- func (c *VarlinkCall) ReplyContainerRestore(ctx context.Context, id_ string) error
- func (c *VarlinkCall) ReplyContainerRunlabel(ctx context.Context) error
- func (c *VarlinkCall) ReplyContainerStateData(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyCreateContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyCreateFromCC(ctx context.Context, id_ string) error
- func (c *VarlinkCall) ReplyCreatePod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyDeleteStoppedContainers(ctx context.Context, containers_ []string) error
- func (c *VarlinkCall) ReplyDeleteUnusedImages(ctx context.Context, images_ []string) error
- func (c *VarlinkCall) ReplyDiff(ctx context.Context, diffs_ []DiffInfo) error
- func (c *VarlinkCall) ReplyErrCtrStopped(ctx context.Context, id_ string) error
- func (c *VarlinkCall) ReplyErrRequiresCgroupsV2ForRootless(ctx context.Context, reason_ string) error
- func (c *VarlinkCall) ReplyErrorOccurred(ctx context.Context, reason_ string) error
- func (c *VarlinkCall) ReplyEvictContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyExecContainer(ctx context.Context) error
- func (c *VarlinkCall) ReplyExportContainer(ctx context.Context, tarfile_ string) error
- func (c *VarlinkCall) ReplyExportImage(ctx context.Context, image_ string) error
- func (c *VarlinkCall) ReplyGenerateKube(ctx context.Context, pod_ KubePodService) error
- func (c *VarlinkCall) ReplyGetAttachSockets(ctx context.Context, sockets_ Sockets) error
- func (c *VarlinkCall) ReplyGetContainer(ctx context.Context, container_ Container) error
- func (c *VarlinkCall) ReplyGetContainerLogs(ctx context.Context, container_ []string) error
- func (c *VarlinkCall) ReplyGetContainerStats(ctx context.Context, container_ ContainerStats) error
- func (c *VarlinkCall) ReplyGetContainerStatsWithHistory(ctx context.Context, container_ ContainerStats) error
- func (c *VarlinkCall) ReplyGetContainersByContext(ctx context.Context, containers_ []string) error
- func (c *VarlinkCall) ReplyGetContainersByStatus(ctx context.Context, containerS_ []Container) error
- func (c *VarlinkCall) ReplyGetContainersLogs(ctx context.Context, log_ LogLine) error
- func (c *VarlinkCall) ReplyGetEvents(ctx context.Context, events_ Event) error
- func (c *VarlinkCall) ReplyGetImage(ctx context.Context, image_ Image) error
- func (c *VarlinkCall) ReplyGetInfo(ctx context.Context, info_ PodmanInfo) error
- func (c *VarlinkCall) ReplyGetLayersMapWithImageInfo(ctx context.Context, layerMap_ string) error
- func (c *VarlinkCall) ReplyGetPod(ctx context.Context, pod_ ListPodData) error
- func (c *VarlinkCall) ReplyGetPodStats(ctx context.Context, pod_ string, containers_ []ContainerStats) error
- func (c *VarlinkCall) ReplyGetPodsByContext(ctx context.Context, pods_ []string) error
- func (c *VarlinkCall) ReplyGetPodsByStatus(ctx context.Context, pods_ []string) error
- func (c *VarlinkCall) ReplyGetVersion(ctx context.Context, version_ string, go_version_ string, git_commit_ string, ...) error
- func (c *VarlinkCall) ReplyGetVolumes(ctx context.Context, volumes_ []Volume) error
- func (c *VarlinkCall) ReplyHealthCheckRun(ctx context.Context, healthCheckStatus_ string) error
- func (c *VarlinkCall) ReplyHistoryImage(ctx context.Context, history_ []ImageHistory) error
- func (c *VarlinkCall) ReplyImageExists(ctx context.Context, exists_ int64) error
- func (c *VarlinkCall) ReplyImageNotFound(ctx context.Context, id_ string, reason_ string) error
- func (c *VarlinkCall) ReplyImageSave(ctx context.Context, reply_ MoreResponse) error
- func (c *VarlinkCall) ReplyImagesPrune(ctx context.Context, pruned_ []string) error
- func (c *VarlinkCall) ReplyImportImage(ctx context.Context, image_ string) error
- func (c *VarlinkCall) ReplyInitContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyInspectContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyInspectImage(ctx context.Context, image_ string) error
- func (c *VarlinkCall) ReplyInspectPod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyInvalidState(ctx context.Context, id_ string, reason_ string) error
- func (c *VarlinkCall) ReplyKillContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyKillPod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyListContainerChanges(ctx context.Context, container_ ContainerChanges) error
- func (c *VarlinkCall) ReplyListContainerMounts(ctx context.Context, mounts_ map[string]string) error
- func (c *VarlinkCall) ReplyListContainerProcesses(ctx context.Context, container_ []string) error
- func (c *VarlinkCall) ReplyListContainers(ctx context.Context, containers_ []Container) error
- func (c *VarlinkCall) ReplyListImages(ctx context.Context, images_ []Image) error
- func (c *VarlinkCall) ReplyListPods(ctx context.Context, pods_ []ListPodData) error
- func (c *VarlinkCall) ReplyLoadImage(ctx context.Context, reply_ MoreResponse) error
- func (c *VarlinkCall) ReplyMountContainer(ctx context.Context, path_ string) error
- func (c *VarlinkCall) ReplyNoContainerRunning(ctx context.Context) error
- func (c *VarlinkCall) ReplyNoContainersInPod(ctx context.Context, name_ string) error
- func (c *VarlinkCall) ReplyPauseContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyPausePod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyPodContainerError(ctx context.Context, podname_ string, errors_ []PodContainerErrorData) error
- func (c *VarlinkCall) ReplyPodNotFound(ctx context.Context, name_ string, reason_ string) error
- func (c *VarlinkCall) ReplyPodStateData(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyPs(ctx context.Context, containers_ []PsContainer) error
- func (c *VarlinkCall) ReplyPullImage(ctx context.Context, reply_ MoreResponse) error
- func (c *VarlinkCall) ReplyPushImage(ctx context.Context, reply_ MoreResponse) error
- func (c *VarlinkCall) ReplyReceiveFile(ctx context.Context, len_ int64) error
- func (c *VarlinkCall) ReplyRemoveContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyRemoveImage(ctx context.Context, image_ string) error
- func (c *VarlinkCall) ReplyRemovePod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyRestartContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyRestartPod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyRuntimeError(ctx context.Context, reason_ string) error
- func (c *VarlinkCall) ReplySearchImages(ctx context.Context, results_ []ImageSearchResult) error
- func (c *VarlinkCall) ReplySendFile(ctx context.Context, file_handle_ string) error
- func (c *VarlinkCall) ReplySpec(ctx context.Context, config_ string) error
- func (c *VarlinkCall) ReplyStartContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyStartPod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyStopContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyStopPod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyTagImage(ctx context.Context, image_ string) error
- func (c *VarlinkCall) ReplyTop(ctx context.Context, top_ []string) error
- func (c *VarlinkCall) ReplyTopPod(ctx context.Context, stats_ []string) error
- func (c *VarlinkCall) ReplyUnmountContainer(ctx context.Context) error
- func (c *VarlinkCall) ReplyUnpauseContainer(ctx context.Context, container_ string) error
- func (c *VarlinkCall) ReplyUnpausePod(ctx context.Context, pod_ string) error
- func (c *VarlinkCall) ReplyVolumeCreate(ctx context.Context, volumeName_ string) error
- func (c *VarlinkCall) ReplyVolumeNotFound(ctx context.Context, id_ string, reason_ string) error
- func (c *VarlinkCall) ReplyVolumeRemove(ctx context.Context, successes_ []string, failures_ map[string]string) error
- func (c *VarlinkCall) ReplyVolumesPrune(ctx context.Context, prunedNames_ []string, prunedErrors_ []string) error
- func (c *VarlinkCall) ReplyWaitContainer(ctx context.Context, exitcode_ int64) error
- func (c *VarlinkCall) ReplyWantsMoreRequired(ctx context.Context, reason_ string) error
- type VarlinkInterface
- func (s *VarlinkInterface) Attach(ctx context.Context, c VarlinkCall, name_ string, detachKeys_ string, ...) error
- func (s *VarlinkInterface) AttachControl(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) BuildImage(ctx context.Context, c VarlinkCall, build_ BuildInfo) error
- func (s *VarlinkInterface) BuildImageHierarchyMap(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) Commit(ctx context.Context, c VarlinkCall, name_ string, image_name_ string, ...) error
- func (s *VarlinkInterface) ContainerArtifacts(ctx context.Context, c VarlinkCall, name_ string, artifactName_ string) error
- func (s *VarlinkInterface) ContainerCheckpoint(ctx context.Context, c VarlinkCall, name_ string, keep_ bool, ...) error
- func (s *VarlinkInterface) ContainerConfig(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) ContainerExists(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) ContainerInspectData(ctx context.Context, c VarlinkCall, name_ string, size_ bool) error
- func (s *VarlinkInterface) ContainerRestore(ctx context.Context, c VarlinkCall, name_ string, keep_ bool, ...) error
- func (s *VarlinkInterface) ContainerRunlabel(ctx context.Context, c VarlinkCall, runlabel_ Runlabel) error
- func (s *VarlinkInterface) ContainerStateData(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) CreateContainer(ctx context.Context, c VarlinkCall, create_ Create) error
- func (s *VarlinkInterface) CreateFromCC(ctx context.Context, c VarlinkCall, in_ []string) error
- func (s *VarlinkInterface) CreatePod(ctx context.Context, c VarlinkCall, create_ PodCreate) error
- func (s *VarlinkInterface) DeleteStoppedContainers(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) DeleteUnusedImages(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) Diff(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) EvictContainer(ctx context.Context, c VarlinkCall, name_ string, removeVolumes_ bool) error
- func (s *VarlinkInterface) ExecContainer(ctx context.Context, c VarlinkCall, opts_ ExecOpts) error
- func (s *VarlinkInterface) ExportContainer(ctx context.Context, c VarlinkCall, name_ string, path_ string) error
- func (s *VarlinkInterface) ExportImage(ctx context.Context, c VarlinkCall, name_ string, destination_ string, ...) error
- func (s *VarlinkInterface) GenerateKube(ctx context.Context, c VarlinkCall, name_ string, service_ bool) error
- func (s *VarlinkInterface) GetAttachSockets(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) GetContainer(ctx context.Context, c VarlinkCall, id_ string) error
- func (s *VarlinkInterface) GetContainerLogs(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) GetContainerStats(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) GetContainerStatsWithHistory(ctx context.Context, c VarlinkCall, previousStats_ ContainerStats) error
- func (s *VarlinkInterface) GetContainersByContext(ctx context.Context, c VarlinkCall, all_ bool, latest_ bool, args_ []string) error
- func (s *VarlinkInterface) GetContainersByStatus(ctx context.Context, c VarlinkCall, status_ []string) error
- func (s *VarlinkInterface) GetContainersLogs(ctx context.Context, c VarlinkCall, names_ []string, follow_ bool, ...) error
- func (s *VarlinkInterface) GetEvents(ctx context.Context, c VarlinkCall, filter_ []string, since_ string, ...) error
- func (s *VarlinkInterface) GetImage(ctx context.Context, c VarlinkCall, id_ string) error
- func (s *VarlinkInterface) GetInfo(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) GetLayersMapWithImageInfo(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) GetPod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) GetPodStats(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) GetPodsByContext(ctx context.Context, c VarlinkCall, all_ bool, latest_ bool, args_ []string) error
- func (s *VarlinkInterface) GetPodsByStatus(ctx context.Context, c VarlinkCall, statuses_ []string) error
- func (s *VarlinkInterface) GetVersion(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) GetVolumes(ctx context.Context, c VarlinkCall, args_ []string, all_ bool) error
- func (s *VarlinkInterface) HealthCheckRun(ctx context.Context, c VarlinkCall, nameOrID_ string) error
- func (s *VarlinkInterface) HistoryImage(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) ImageExists(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) ImageSave(ctx context.Context, c VarlinkCall, options_ ImageSaveOptions) error
- func (s *VarlinkInterface) ImagesPrune(ctx context.Context, c VarlinkCall, all_ bool) error
- func (s *VarlinkInterface) ImportImage(ctx context.Context, c VarlinkCall, source_ string, reference_ string, ...) error
- func (s *VarlinkInterface) InitContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) InspectContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) InspectImage(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) InspectPod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) KillContainer(ctx context.Context, c VarlinkCall, name_ string, signal_ int64) error
- func (s *VarlinkInterface) KillPod(ctx context.Context, c VarlinkCall, name_ string, signal_ int64) error
- func (s *VarlinkInterface) ListContainerChanges(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) ListContainerMounts(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) ListContainerProcesses(ctx context.Context, c VarlinkCall, name_ string, opts_ []string) error
- func (s *VarlinkInterface) ListContainers(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) ListImages(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) ListPods(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) LoadImage(ctx context.Context, c VarlinkCall, name_ string, inputFile_ string, ...) error
- func (s *VarlinkInterface) MountContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) PauseContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) PausePod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) PodStateData(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) Ps(ctx context.Context, c VarlinkCall, opts_ PsOpts) error
- func (s *VarlinkInterface) PullImage(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) PushImage(ctx context.Context, c VarlinkCall, name_ string, tag_ string, compress_ bool, ...) error
- func (s *VarlinkInterface) ReceiveFile(ctx context.Context, c VarlinkCall, path_ string, delete_ bool) error
- func (s *VarlinkInterface) RemoveContainer(ctx context.Context, c VarlinkCall, name_ string, force_ bool, ...) error
- func (s *VarlinkInterface) RemoveImage(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
- func (s *VarlinkInterface) RemovePod(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
- func (s *VarlinkInterface) RestartContainer(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
- func (s *VarlinkInterface) RestartPod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) SearchImages(ctx context.Context, c VarlinkCall, query_ string, limit_ *int64, ...) error
- func (s *VarlinkInterface) SendFile(ctx context.Context, c VarlinkCall, type_ string, length_ int64) error
- func (s *VarlinkInterface) Spec(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) StartContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) StartPod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) StopContainer(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
- func (s *VarlinkInterface) StopPod(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
- func (s *VarlinkInterface) TagImage(ctx context.Context, c VarlinkCall, name_ string, tagged_ string) error
- func (s *VarlinkInterface) Top(ctx context.Context, c VarlinkCall, nameOrID_ string, descriptors_ []string) error
- func (s *VarlinkInterface) TopPod(ctx context.Context, c VarlinkCall, pod_ string, latest_ bool, ...) error
- func (s *VarlinkInterface) UnmountContainer(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
- func (s *VarlinkInterface) UnpauseContainer(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) UnpausePod(ctx context.Context, c VarlinkCall, name_ string) error
- func (s *VarlinkInterface) VarlinkDispatch(ctx context.Context, call varlink.Call, methodname string) error
- func (s *VarlinkInterface) VarlinkGetDescription() string
- func (s *VarlinkInterface) VarlinkGetName() string
- func (s *VarlinkInterface) VolumeCreate(ctx context.Context, c VarlinkCall, options_ VolumeCreateOpts) error
- func (s *VarlinkInterface) VolumeRemove(ctx context.Context, c VarlinkCall, options_ VolumeRemoveOpts) error
- func (s *VarlinkInterface) VolumesPrune(ctx context.Context, c VarlinkCall) error
- func (s *VarlinkInterface) WaitContainer(ctx context.Context, c VarlinkCall, name_ string, interval_ int64) error
- type Volume
- type VolumeCreateOpts
- type VolumeCreate_methods
- func (m VolumeCreate_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ VolumeCreateOpts) (volumeName_out_ string, err_ error)
- func (m VolumeCreate_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, ...) (func(ctx context.Context) (string, uint64, error), error)
- type VolumeNotFound
- type VolumeRemoveOpts
- type VolumeRemove_methods
- func (m VolumeRemove_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ VolumeRemoveOpts) (successes_out_ []string, failures_out_ map[string]string, err_ error)
- func (m VolumeRemove_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, ...) (func(ctx context.Context) ([]string, map[string]string, uint64, error), error)
- type VolumesPrune_methods
- func (m VolumesPrune_methods) Call(ctx context.Context, c *varlink.Connection) (prunedNames_out_ []string, prunedErrors_out_ []string, err_ error)
- func (m VolumesPrune_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64) (func(ctx context.Context) ([]string, []string, uint64, error), error)
- type WaitContainer_methods
- func (m WaitContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, ...) (exitcode_out_ int64, err_ error)
- func (m WaitContainer_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string, ...) (func(ctx context.Context) (int64, uint64, error), error)
- type WantsMoreRequired
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Dispatch_Error ¶
Types ¶
type AttachControl_methods ¶
type AttachControl_methods struct{}
func AttachControl ¶
func AttachControl() AttachControl_methods
func (AttachControl_methods) Call ¶
func (m AttachControl_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (err_ error)
type Attach_methods ¶
type Attach_methods struct{}
Attach takes the name or ID of a container and sets up the ability to remotely attach to its console. The start bool is whether you wish to start the container in question first.
func Attach ¶
func Attach() Attach_methods
type BuildImageHierarchyMap_methods ¶
type BuildImageHierarchyMap_methods struct{}
BuildImageHierarchyMap is for the development of Podman and should not be used.
func BuildImageHierarchyMap ¶
func BuildImageHierarchyMap() BuildImageHierarchyMap_methods
func (BuildImageHierarchyMap_methods) Call ¶
func (m BuildImageHierarchyMap_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (imageInfo_out_ string, err_ error)
type BuildImage_methods ¶
type BuildImage_methods struct{}
BuildImage takes a BuildInfo(#BuildInfo) structure and builds an image. At a minimum, you must provide the contextDir tarball path, the 'dockerfiles' path, and 'output' option in the BuildInfo structure. The 'output' options is the name of the of the resulting build. It will return a MoreResponse(#MoreResponse) structure that contains the build logs and resulting image ID. #### Example ~~~ $ sudo varlink call -m unix:///run/podman/io.podman/io.podman.BuildImage '{"build":{"contextDir":"/tmp/t/context.tar","dockerfiles":["Dockerfile"], "output":"foobar"}}'
{ "image": { "id": "", "logs": [ "STEP 1: FROM alpine\n" ] } }
{ "image": { "id": "", "logs": [ "STEP 2: COMMIT foobar\n" ] } }
{ "image": { "id": "", "logs": [ "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9\n" ] } }
{ "image": { "id": "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9", "logs": [] } }
~~~
func BuildImage ¶
func BuildImage() BuildImage_methods
func (BuildImage_methods) Call ¶
func (m BuildImage_methods) Call(ctx context.Context, c *varlink.Connection, build_in_ BuildInfo) (image_out_ MoreResponse, err_ error)
func (BuildImage_methods) Send ¶
func (m BuildImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, build_in_ BuildInfo) (func(ctx context.Context) (MoreResponse, uint64, error), error)
type BuildInfo ¶
type BuildInfo struct { AdditionalTags []string `json:"additionalTags"` Annotations []string `json:"annotations"` BuildArgs map[string]string `json:"buildArgs"` BuildOptions BuildOptions `json:"buildOptions"` CniConfigDir string `json:"cniConfigDir"` CniPluginDir string `json:"cniPluginDir"` Compression string `json:"compression"` ContextDir string `json:"contextDir"` DefaultsMountFilePath string `json:"defaultsMountFilePath"` Dockerfiles []string `json:"dockerfiles"` Err string `json:"err"` ForceRmIntermediateCtrs bool `json:"forceRmIntermediateCtrs"` Iidfile string `json:"iidfile"` Label []string `json:"label"` Layers bool `json:"layers"` Nocache bool `json:"nocache"` Out string `json:"out"` Output string `json:"output"` OutputFormat string `json:"outputFormat"` PullPolicy string `json:"pullPolicy"` Quiet bool `json:"quiet"` RemoteIntermediateCtrs bool `json:"remoteIntermediateCtrs"` ReportWriter string `json:"reportWriter"` RuntimeArgs []string `json:"runtimeArgs"` Squash bool `json:"squash"` }
BuildInfo is used to describe user input for building images
type BuildOptions ¶
type BuildOptions struct { AddHosts []string `json:"addHosts"` CgroupParent string `json:"cgroupParent"` CpuPeriod int64 `json:"cpuPeriod"` CpuQuota int64 `json:"cpuQuota"` CpusetCpus string `json:"cpusetCpus"` CpusetMems string `json:"cpusetMems"` Memory int64 `json:"memory"` MemorySwap int64 `json:"memorySwap"` ShmSize string `json:"shmSize"` Ulimit []string `json:"ulimit"` Volume []string `json:"volume"` }
BuildOptions are are used to describe describe physical attributes of the build
type Commit_methods ¶
type Commit_methods struct{}
Commit, creates an image from an existing container. It requires the name or ID of the container as well as the resulting image name. Optionally, you can define an author and message to be added to the resulting image. You can also define changes to the resulting image for the following attributes: _CMD, ENTRYPOINT, ENV, EXPOSE, LABEL, ONBUILD, STOPSIGNAL, USER, VOLUME, and WORKDIR_. To pause the container while it is being committed, pass a _true_ bool for the pause argument. If the container cannot be found by the ID or name provided, a (ContainerNotFound)[#ContainerNotFound] error will be returned; otherwise, the resulting image's ID will be returned as a string inside a MoreResponse.
func Commit ¶
func Commit() Commit_methods
func (Commit_methods) Call ¶
func (m Commit_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, image_name_in_ string, changes_in_ []string, author_in_ string, message_in_ string, pause_in_ bool, manifestType_in_ string) (reply_out_ MoreResponse, err_ error)
type Container ¶
type Container struct { Id string `json:"id"` Image string `json:"image"` Imageid string `json:"imageid"` Command []string `json:"command"` Createdat string `json:"createdat"` Runningfor string `json:"runningfor"` Status string `json:"status"` Ports []ContainerPortMappings `json:"ports"` Rootfssize int64 `json:"rootfssize"` Rwsize int64 `json:"rwsize"` Names string `json:"names"` Labels map[string]string `json:"labels"` Mounts []ContainerMount `json:"mounts"` Containerrunning bool `json:"containerrunning"` Namespaces ContainerNameSpace `json:"namespaces"` }
type ContainerArtifacts_methods ¶
type ContainerArtifacts_methods struct{}
ContainerArtifacts returns a container's artifacts in string form. This call is for development of Podman only and generally should not be used.
func ContainerArtifacts ¶
func ContainerArtifacts() ContainerArtifacts_methods
type ContainerChanges ¶
type ContainerChanges struct { Changed []string `json:"changed"` Added []string `json:"added"` Deleted []string `json:"deleted"` }
ContainerChanges describes the return struct for ListContainerChanges
type ContainerCheckpoint_methods ¶
type ContainerCheckpoint_methods struct{}
ContainerCheckPoint performs a checkpopint on a container by its name or full/partial container ID. On successful checkpoint, the id of the checkpointed container is returned.
func ContainerCheckpoint ¶
func ContainerCheckpoint() ContainerCheckpoint_methods
type ContainerConfig_methods ¶
type ContainerConfig_methods struct{}
ContainerConfig returns a container's config in string form. This call is for development of Podman only and generally should not be used.
func ContainerConfig ¶
func ContainerConfig() ContainerConfig_methods
func (ContainerConfig_methods) Call ¶
func (m ContainerConfig_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
type ContainerExists_methods ¶
type ContainerExists_methods struct{}
ContainerExists takes a full or partial container ID or name and returns an int as to whether the container exists in local storage. A result of 0 means the container does exists; whereas a result of 1 means it could not be found. #### Example ~~~
$ varlink call -m unix:/run/podman/io.podman/io.podman.ContainerExists '{"name": "flamboyant_payne"}'{ "exists": 0 }
~~~
func ContainerExists ¶
func ContainerExists() ContainerExists_methods
func (ContainerExists_methods) Call ¶
func (m ContainerExists_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (exists_out_ int64, err_ error)
type ContainerInspectData_methods ¶
type ContainerInspectData_methods struct{}
ContainerInspectData returns a container's inspect data in string form. This call is for development of Podman only and generally should not be used.
func ContainerInspectData ¶
func ContainerInspectData() ContainerInspectData_methods
type ContainerMount ¶
type ContainerMount struct { Destination string `json:"destination"` Type string `json:"type"` Source string `json:"source"` Options []string `json:"options"` }
ContainerMount describes the struct for mounts in a container
type ContainerNameSpace ¶
type ContainerNameSpace struct { User string `json:"user"` Uts string `json:"uts"` Pidns string `json:"pidns"` Pid string `json:"pid"` Cgroup string `json:"cgroup"` Net string `json:"net"` Mnt string `json:"mnt"` Ipc string `json:"ipc"` }
ContainerNamespace describes the namespace structure for an existing container
type ContainerNotFound ¶
ContainerNotFound means the container could not be found by the provided name or ID in local storage.
func (ContainerNotFound) Error ¶
func (e ContainerNotFound) Error() string
type ContainerPortMappings ¶
type ContainerPortMappings struct { Host_port string `json:"host_port"` Host_ip string `json:"host_ip"` Protocol string `json:"protocol"` Container_port string `json:"container_port"` }
ContainerPortMappings describes the struct for portmappings in an existing container
type ContainerRestore_methods ¶
type ContainerRestore_methods struct{}
ContainerRestore restores a container that has been checkpointed. The container to be restored can be identified by its name or full/partial container ID. A successful restore will result in the return of the container's ID.
func ContainerRestore ¶
func ContainerRestore() ContainerRestore_methods
type ContainerRunlabel_methods ¶
type ContainerRunlabel_methods struct{}
ContainerRunlabel runs executes a command as described by a given container image label.
func ContainerRunlabel ¶
func ContainerRunlabel() ContainerRunlabel_methods
func (ContainerRunlabel_methods) Call ¶
func (m ContainerRunlabel_methods) Call(ctx context.Context, c *varlink.Connection, runlabel_in_ Runlabel) (err_ error)
type ContainerStateData_methods ¶
type ContainerStateData_methods struct{}
ContainerStateData returns a container's state config in string form. This call is for development of Podman only and generally should not be used.
func ContainerStateData ¶
func ContainerStateData() ContainerStateData_methods
func (ContainerStateData_methods) Call ¶
func (m ContainerStateData_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
type ContainerStats ¶
type ContainerStats struct { Id string `json:"id"` Name string `json:"name"` Cpu float64 `json:"cpu"` Cpu_nano int64 `json:"cpu_nano"` System_nano int64 `json:"system_nano"` Mem_usage int64 `json:"mem_usage"` Mem_limit int64 `json:"mem_limit"` Mem_perc float64 `json:"mem_perc"` Net_input int64 `json:"net_input"` Net_output int64 `json:"net_output"` Block_output int64 `json:"block_output"` Block_input int64 `json:"block_input"` Pids int64 `json:"pids"` }
ContainerStats is the return struct for the stats of a container
type Create ¶
type Create struct { Args []string `json:"args"` AddHost *[]string `json:"addHost,omitempty"` Annotation *[]string `json:"annotation,omitempty"` Attach *[]string `json:"attach,omitempty"` BlkioWeight *string `json:"blkioWeight,omitempty"` BlkioWeightDevice *[]string `json:"blkioWeightDevice,omitempty"` CapAdd *[]string `json:"capAdd,omitempty"` CapDrop *[]string `json:"capDrop,omitempty"` CgroupParent *string `json:"cgroupParent,omitempty"` CidFile *string `json:"cidFile,omitempty"` ConmonPidfile *string `json:"conmonPidfile,omitempty"` Command *[]string `json:"command,omitempty"` CpuPeriod *int64 `json:"cpuPeriod,omitempty"` CpuQuota *int64 `json:"cpuQuota,omitempty"` CpuRtPeriod *int64 `json:"cpuRtPeriod,omitempty"` CpuRtRuntime *int64 `json:"cpuRtRuntime,omitempty"` Cpus *float64 `json:"cpus,omitempty"` CpuSetCpus *string `json:"cpuSetCpus,omitempty"` CpuSetMems *string `json:"cpuSetMems,omitempty"` Detach *bool `json:"detach,omitempty"` DetachKeys *string `json:"detachKeys,omitempty"` Device *[]string `json:"device,omitempty"` DeviceReadBps *[]string `json:"deviceReadBps,omitempty"` DeviceReadIops *[]string `json:"deviceReadIops,omitempty"` DeviceWriteBps *[]string `json:"deviceWriteBps,omitempty"` DeviceWriteIops *[]string `json:"deviceWriteIops,omitempty"` Dns *[]string `json:"dns,omitempty"` DnsOpt *[]string `json:"dnsOpt,omitempty"` DnsSearch *[]string `json:"dnsSearch,omitempty"` DnsServers *[]string `json:"dnsServers,omitempty"` Entrypoint *string `json:"entrypoint,omitempty"` Env *[]string `json:"env,omitempty"` EnvFile *[]string `json:"envFile,omitempty"` Expose *[]string `json:"expose,omitempty"` Gidmap *[]string `json:"gidmap,omitempty"` Groupadd *[]string `json:"groupadd,omitempty"` HealthcheckCommand *string `json:"healthcheckCommand,omitempty"` HealthcheckInterval *string `json:"healthcheckInterval,omitempty"` HealthcheckRetries *int64 `json:"healthcheckRetries,omitempty"` HealthcheckStartPeriod *string `json:"healthcheckStartPeriod,omitempty"` HealthcheckTimeout *string `json:"healthcheckTimeout,omitempty"` Hostname *string `json:"hostname,omitempty"` ImageVolume *string `json:"imageVolume,omitempty"` Init *bool `json:"init,omitempty"` InitPath *string `json:"initPath,omitempty"` Interactive *bool `json:"interactive,omitempty"` Ip *string `json:"ip,omitempty"` Ipc *string `json:"ipc,omitempty"` KernelMemory *string `json:"kernelMemory,omitempty"` Label *[]string `json:"label,omitempty"` LabelFile *[]string `json:"labelFile,omitempty"` LogDriver *string `json:"logDriver,omitempty"` LogOpt *[]string `json:"logOpt,omitempty"` MacAddress *string `json:"macAddress,omitempty"` Memory *string `json:"memory,omitempty"` MemoryReservation *string `json:"memoryReservation,omitempty"` MemorySwap *string `json:"memorySwap,omitempty"` MemorySwappiness *int64 `json:"memorySwappiness,omitempty"` Name *string `json:"name,omitempty"` Net *string `json:"net,omitempty"` Network *string `json:"network,omitempty"` NoHosts *bool `json:"noHosts,omitempty"` OomKillDisable *bool `json:"oomKillDisable,omitempty"` OomScoreAdj *int64 `json:"oomScoreAdj,omitempty"` Pid *string `json:"pid,omitempty"` PidsLimit *int64 `json:"pidsLimit,omitempty"` Pod *string `json:"pod,omitempty"` Privileged *bool `json:"privileged,omitempty"` Publish *[]string `json:"publish,omitempty"` PublishAll *bool `json:"publishAll,omitempty"` Pull *string `json:"pull,omitempty"` Quiet *bool `json:"quiet,omitempty"` Readonly *bool `json:"readonly,omitempty"` Readonlytmpfs *bool `json:"readonlytmpfs,omitempty"` Restart *string `json:"restart,omitempty"` Rm *bool `json:"rm,omitempty"` Rootfs *bool `json:"rootfs,omitempty"` SecurityOpt *[]string `json:"securityOpt,omitempty"` ShmSize *string `json:"shmSize,omitempty"` StopSignal *string `json:"stopSignal,omitempty"` StopTimeout *int64 `json:"stopTimeout,omitempty"` StorageOpt *[]string `json:"storageOpt,omitempty"` Subuidname *string `json:"subuidname,omitempty"` Subgidname *string `json:"subgidname,omitempty"` Sysctl *[]string `json:"sysctl,omitempty"` Systemd *string `json:"systemd,omitempty"` Tmpfs *[]string `json:"tmpfs,omitempty"` Tty *bool `json:"tty,omitempty"` Uidmap *[]string `json:"uidmap,omitempty"` Ulimit *[]string `json:"ulimit,omitempty"` User *string `json:"user,omitempty"` Userns *string `json:"userns,omitempty"` Uts *string `json:"uts,omitempty"` Mount *[]string `json:"mount,omitempty"` Volume *[]string `json:"volume,omitempty"` VolumesFrom *[]string `json:"volumesFrom,omitempty"` WorkDir *string `json:"workDir,omitempty"` }
Create is an input structure for creating containers. args[0] is the image name or id args[1-] are the new commands if changed
type CreateContainer_methods ¶
type CreateContainer_methods struct{}
CreateContainer creates a new container from an image. It uses a Create(#Create) type for input.
func CreateContainer ¶
func CreateContainer() CreateContainer_methods
func (CreateContainer_methods) Call ¶
func (m CreateContainer_methods) Call(ctx context.Context, c *varlink.Connection, create_in_ Create) (container_out_ string, err_ error)
type CreateFromCC_methods ¶
type CreateFromCC_methods struct{}
This call is for the development of Podman only and should not be used.
func CreateFromCC ¶
func CreateFromCC() CreateFromCC_methods
func (CreateFromCC_methods) Call ¶
func (m CreateFromCC_methods) Call(ctx context.Context, c *varlink.Connection, in_in_ []string) (id_out_ string, err_ error)
type CreatePod_methods ¶
type CreatePod_methods struct{}
CreatePod creates a new empty pod. It uses a PodCreate(#PodCreate) type for input. On success, the ID of the newly created pod will be returned. #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"name": "test"}}'
{ "pod": "b05dee7bd4ccfee688099fe1588a7a898d6ddd6897de9251d4671c9b0feacb2a" }
$ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"infra": true, "share": ["ipc", "net", "uts"]}}' ¶
{ "pod": "d7697449a8035f613c1a8891286502aca68fff7d5d49a85279b3bda229af3b28" }
~~~
func CreatePod ¶
func CreatePod() CreatePod_methods
func (CreatePod_methods) Call ¶
func (m CreatePod_methods) Call(ctx context.Context, c *varlink.Connection, create_in_ PodCreate) (pod_out_ string, err_ error)
type DeleteStoppedContainers_methods ¶
type DeleteStoppedContainers_methods struct{}
DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted container IDs. See also RemoveContainer(RemoveContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteStoppedContainers
{ "containers": [ "451410b931d00def8aa9b4f8084e4d4a39e5e04ea61f358cf53a5cf95afcdcee", "8b60f754a3e01389494a9581ade97d35c2765b6e2f19acd2d3040c82a32d1bc0", "cf2e99d4d3cad6073df199ed32bbe64b124f3e1aba6d78821aa8460e70d30084", "db901a329587312366e5ecff583d08f0875b4b79294322df67d90fc6eed08fc1" ] }
~~~
func DeleteStoppedContainers ¶
func DeleteStoppedContainers() DeleteStoppedContainers_methods
func (DeleteStoppedContainers_methods) Call ¶
func (m DeleteStoppedContainers_methods) Call(ctx context.Context, c *varlink.Connection) (containers_out_ []string, err_ error)
type DeleteUnusedImages_methods ¶
type DeleteUnusedImages_methods struct{}
DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned in a string array. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteUnusedImages
{ "images": [ "166ea6588079559c724c15223f52927f514f73dd5c5cf2ae2d143e3b2e6e9b52", "da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e", "3ef70f7291f47dfe2b82931a993e16f5a44a0e7a68034c3e0e086d77f5829adc", "59788edf1f3e78cd0ebe6ce1446e9d10788225db3dedcfd1a59f764bad2b2690" ] }
~~~
func DeleteUnusedImages ¶
func DeleteUnusedImages() DeleteUnusedImages_methods
func (DeleteUnusedImages_methods) Call ¶
func (m DeleteUnusedImages_methods) Call(ctx context.Context, c *varlink.Connection) (images_out_ []string, err_ error)
type Diff_methods ¶
type Diff_methods struct{}
Diff returns a diff between libpod objects
func Diff ¶
func Diff() Diff_methods
func (Diff_methods) Call ¶
func (m Diff_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (diffs_out_ []DiffInfo, err_ error)
type ErrCtrStopped ¶
type ErrCtrStopped struct {
Id string `json:"id"`
}
Container is already stopped
func (ErrCtrStopped) Error ¶
func (e ErrCtrStopped) Error() string
type ErrRequiresCgroupsV2ForRootless ¶
type ErrRequiresCgroupsV2ForRootless struct {
Reason string `json:"reason"`
}
This function requires CGroupsV2 to run in rootless mode.
func (ErrRequiresCgroupsV2ForRootless) Error ¶
func (e ErrRequiresCgroupsV2ForRootless) Error() string
type ErrorOccurred ¶
type ErrorOccurred struct {
Reason string `json:"reason"`
}
ErrorOccurred is a generic error for an error that occurs during the execution. The actual error message is includes as part of the error's text.
func (ErrorOccurred) Error ¶
func (e ErrorOccurred) Error() string
type Event ¶
type Event struct { Id string `json:"id"` Image string `json:"image"` Name string `json:"name"` Status string `json:"status"` Time string `json:"time"` Type string `json:"type"` }
Event describes a libpod struct
type EvictContainer_methods ¶
type EvictContainer_methods struct{}
EvictContainer requires the name or ID of a container as well as a boolean that indicates to remove builtin volumes. Upon successful eviction of the container, its ID is returned. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned. See also RemoveContainer(RemoveContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.EvictContainer '{"name": "62f4fd98cb57"}'
{ "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func EvictContainer ¶
func EvictContainer() EvictContainer_methods
type ExecContainer_methods ¶
type ExecContainer_methods struct{}
ExecContainer executes a command in the given container.
func ExecContainer ¶
func ExecContainer() ExecContainer_methods
func (ExecContainer_methods) Call ¶
func (m ExecContainer_methods) Call(ctx context.Context, c *varlink.Connection, opts_in_ ExecOpts) (err_ error)
type ExecOpts ¶
type ExecOpts struct { Name string `json:"name"` Tty bool `json:"tty"` Privileged bool `json:"privileged"` Cmd []string `json:"cmd"` User *string `json:"user,omitempty"` Workdir *string `json:"workdir,omitempty"` Env *[]string `json:"env,omitempty"` DetachKeys *string `json:"detachKeys,omitempty"` }
type ExportContainer_methods ¶
type ExportContainer_methods struct{}
ExportContainer creates an image from a container. It takes the name or ID of a container and a path representing the target tarfile. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. The return value is the written tarfile. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ExportContainer '{"name": "flamboyant_payne", "path": "/tmp/payne.tar" }'
{ "tarfile": "/tmp/payne.tar" }
~~~
func ExportContainer ¶
func ExportContainer() ExportContainer_methods
type ExportImage_methods ¶
type ExportImage_methods struct{}
ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also a boolean option to force compression. It also takes in a string array of tags to be able to save multiple tags of the same image to a tarball (each tag should be of the form <image>:<tag>). Upon completion, the ID of the image is returned. If the image cannot be found in local storage, an ImageNotFound(#ImageNotFound) error will be returned. See also ImportImage(ImportImage).
func ExportImage ¶
func ExportImage() ExportImage_methods
type GenerateKube_methods ¶
type GenerateKube_methods struct{}
GenerateKube generates a Kubernetes v1 Pod description of a Podman container or pod and its containers. The description is in YAML. See also [ReplayKube](ReplayKube).
func GenerateKube ¶
func GenerateKube() GenerateKube_methods
func (GenerateKube_methods) Call ¶
func (m GenerateKube_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, service_in_ bool) (pod_out_ KubePodService, err_ error)
type GetAttachSockets_methods ¶
type GetAttachSockets_methods struct{}
GetAttachSockets takes the name or ID of an existing container. It returns file paths for two sockets needed to properly communicate with a container. The first is the actual I/O socket that the container uses. The second is a "control" socket where things like resizing the TTY events are sent. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. #### Example ~~~ $ varlink call -m unix:/run/io.podman/io.podman.GetAttachSockets '{"name": "b7624e775431219161"}'
{ "sockets": { "container_id": "b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca", "control_socket": "/var/lib/containers/storage/overlay-containers/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/userdata/ctl", "io_socket": "/var/run/libpod/socket/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/attach" } }
~~~
func GetAttachSockets ¶
func GetAttachSockets() GetAttachSockets_methods
func (GetAttachSockets_methods) Call ¶
func (m GetAttachSockets_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (sockets_out_ Sockets, err_ error)
type GetContainerLogs_methods ¶
type GetContainerLogs_methods struct{}
GetContainerLogs takes a name or ID of a container and returns the logs of that container. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. The container logs are returned as an array of strings. GetContainerLogs will honor the streaming capability of varlink if the client invokes it.
func GetContainerLogs ¶
func GetContainerLogs() GetContainerLogs_methods
func (GetContainerLogs_methods) Call ¶
func (m GetContainerLogs_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ []string, err_ error)
type GetContainerStatsWithHistory_methods ¶
type GetContainerStatsWithHistory_methods struct{}
GetContainerStatsWithHistory takes a previous set of container statistics and uses libpod functions to calculate the containers statistics based on current and previous measurements.
func GetContainerStatsWithHistory ¶
func GetContainerStatsWithHistory() GetContainerStatsWithHistory_methods
func (GetContainerStatsWithHistory_methods) Call ¶
func (m GetContainerStatsWithHistory_methods) Call(ctx context.Context, c *varlink.Connection, previousStats_in_ ContainerStats) (container_out_ ContainerStats, err_ error)
func (GetContainerStatsWithHistory_methods) Send ¶
func (m GetContainerStatsWithHistory_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, previousStats_in_ ContainerStats) (func(ctx context.Context) (ContainerStats, uint64, error), error)
type GetContainerStats_methods ¶
type GetContainerStats_methods struct{}
GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which contains attributes like memory and cpu usage. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. If the container is not running, a NoContainerRunning(#NoContainerRunning) error will be returned #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.GetContainerStats '{"name": "c33e4164f384"}'
{ "container": { "block_input": 0, "block_output": 0, "cpu": 2.571123918839990154678e-08, "cpu_nano": 49037378, "id": "c33e4164f384aa9d979072a63319d66b74fd7a128be71fa68ede24f33ec6cfee", "mem_limit": 33080606720, "mem_perc": 2.166828456524753747370e-03, "mem_usage": 716800, "name": "competent_wozniak", "net_input": 768, "net_output": 5910, "pids": 1, "system_nano": 10000000 } }
~~~
func GetContainerStats ¶
func GetContainerStats() GetContainerStats_methods
func (GetContainerStats_methods) Call ¶
func (m GetContainerStats_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ ContainerStats, err_ error)
func (GetContainerStats_methods) Send ¶
func (m GetContainerStats_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (ContainerStats, uint64, error), error)
type GetContainer_methods ¶
type GetContainer_methods struct{}
GetContainer returns information about a single container. If a container with the given id doesn't exist, a ContainerNotFound(#ContainerNotFound) error will be returned. See also ListContainers(ListContainers) and InspectContainer(#InspectContainer).
func GetContainer ¶
func GetContainer() GetContainer_methods
func (GetContainer_methods) Call ¶
func (m GetContainer_methods) Call(ctx context.Context, c *varlink.Connection, id_in_ string) (container_out_ Container, err_ error)
type GetContainersByContext_methods ¶
type GetContainersByContext_methods struct{}
GetContainersByContext allows you to get a list of container ids depending on all, latest, or a list of container names. The definition of latest container means the latest by creation date. In a multi- user environment, results might differ from what you expect.
func GetContainersByContext ¶
func GetContainersByContext() GetContainersByContext_methods
type GetContainersByStatus_methods ¶
type GetContainersByStatus_methods struct{}
func GetContainersByStatus ¶
func GetContainersByStatus() GetContainersByStatus_methods
func (GetContainersByStatus_methods) Call ¶
func (m GetContainersByStatus_methods) Call(ctx context.Context, c *varlink.Connection, status_in_ []string) (containerS_out_ []Container, err_ error)
type GetContainersLogs_methods ¶
type GetContainersLogs_methods struct{}
func GetContainersLogs ¶
func GetContainersLogs() GetContainersLogs_methods
type GetEvents_methods ¶
type GetEvents_methods struct{}
GetEvents returns known libpod events filtered by the options provided.
func GetEvents ¶
func GetEvents() GetEvents_methods
type GetImage_methods ¶
type GetImage_methods struct{}
GetImage returns information about a single image in storage. If the image caGetImage returns be found, ImageNotFound(#ImageNotFound) will be returned.
func GetImage ¶
func GetImage() GetImage_methods
func (GetImage_methods) Call ¶
func (m GetImage_methods) Call(ctx context.Context, c *varlink.Connection, id_in_ string) (image_out_ Image, err_ error)
type GetInfo_methods ¶
type GetInfo_methods struct{}
GetInfo returns a PodmanInfo(#PodmanInfo) struct that describes podman and its host such as storage stats, build information of Podman, and system-wide registries.
func GetInfo ¶
func GetInfo() GetInfo_methods
func (GetInfo_methods) Call ¶
func (m GetInfo_methods) Call(ctx context.Context, c *varlink.Connection) (info_out_ PodmanInfo, err_ error)
func (GetInfo_methods) Send ¶
func (m GetInfo_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64) (func(ctx context.Context) (PodmanInfo, uint64, error), error)
type GetLayersMapWithImageInfo_methods ¶
type GetLayersMapWithImageInfo_methods struct{}
GetLayersMapWithImageInfo is for the development of Podman and should not be used.
func GetLayersMapWithImageInfo ¶
func GetLayersMapWithImageInfo() GetLayersMapWithImageInfo_methods
func (GetLayersMapWithImageInfo_methods) Call ¶
func (m GetLayersMapWithImageInfo_methods) Call(ctx context.Context, c *varlink.Connection) (layerMap_out_ string, err_ error)
type GetPodStats_methods ¶
type GetPodStats_methods struct{}
GetPodStats takes the name or ID of a pod and returns a pod name and slice of ContainerStats structure which contains attributes like memory and cpu usage. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. If the pod has no running containers associated with it, a NoContainerRunning(#NoContainerRunning) error will be returned. #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.GetPodStats '{"name": "7f62b508b6f12b11d8fe02e"}'
{ "containers": [ { "block_input": 0, "block_output": 0, "cpu": 2.833470544016107524276e-08, "cpu_nano": 54363072, "id": "a64b51f805121fe2c5a3dc5112eb61d6ed139e3d1c99110360d08b58d48e4a93", "mem_limit": 12276146176, "mem_perc": 7.974359265237864966003e-03, "mem_usage": 978944, "name": "quirky_heisenberg", "net_input": 866, "net_output": 7388, "pids": 1, "system_nano": 20000000 } ], "pod": "7f62b508b6f12b11d8fe02e0db4de6b9e43a7d7699b33a4fc0d574f6e82b4ebd" }
~~~
func GetPodStats ¶
func GetPodStats() GetPodStats_methods
func (GetPodStats_methods) Call ¶
func (m GetPodStats_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, containers_out_ []ContainerStats, err_ error)
type GetPod_methods ¶
type GetPod_methods struct{}
GetPod takes a name or ID of a pod and returns single ListPodData(#ListPodData) structure. A PodNotFound(#PodNotFound) error will be returned if the pod cannot be found. See also ListPods(ListPods). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.GetPod '{"name": "foobar"}'
{ "pod": { "cgroup": "machine.slice", "containersinfo": [ { "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", "name": "1840835294cf-infra", "status": "running" }, { "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", "name": "upbeat_murdock", "status": "running" } ], "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", "name": "foobar", "numberofcontainers": "2", "status": "Running" } }
~~~
func GetPod ¶
func GetPod() GetPod_methods
func (GetPod_methods) Call ¶
func (m GetPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ ListPodData, err_ error)
func (GetPod_methods) Send ¶
func (m GetPod_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (ListPodData, uint64, error), error)
type GetPodsByContext_methods ¶
type GetPodsByContext_methods struct{}
GetPodsByContext allows you to get a list pod ids depending on all, latest, or a list of pod names. The definition of latest pod means the latest by creation date. In a multi- user environment, results might differ from what you expect.
func GetPodsByContext ¶
func GetPodsByContext() GetPodsByContext_methods
type GetPodsByStatus_methods ¶
type GetPodsByStatus_methods struct{}
GetPodsByStatus searches for pods whose status is included in statuses
func GetPodsByStatus ¶
func GetPodsByStatus() GetPodsByStatus_methods
func (GetPodsByStatus_methods) Call ¶
func (m GetPodsByStatus_methods) Call(ctx context.Context, c *varlink.Connection, statuses_in_ []string) (pods_out_ []string, err_ error)
type GetVersion_methods ¶
type GetVersion_methods struct{}
GetVersion returns version and build information of the podman service
func GetVersion ¶
func GetVersion() GetVersion_methods
type GetVolumes_methods ¶
type GetVolumes_methods struct{}
GetVolumes gets slice of the volumes on a remote host
func GetVolumes ¶
func GetVolumes() GetVolumes_methods
type HealthCheckRun_methods ¶
type HealthCheckRun_methods struct{}
HealthCheckRun executes defined container's healthcheck command and returns the container's health status.
func HealthCheckRun ¶
func HealthCheckRun() HealthCheckRun_methods
func (HealthCheckRun_methods) Call ¶
func (m HealthCheckRun_methods) Call(ctx context.Context, c *varlink.Connection, nameOrID_in_ string) (healthCheckStatus_out_ string, err_ error)
type HistoryImage_methods ¶
type HistoryImage_methods struct{}
HistoryImage takes the name or ID of an image and returns information about its history and layers. The returned history is in the form of an array of ImageHistory structures. If the image cannot be found, an ImageNotFound(#ImageNotFound) error is returned.
func HistoryImage ¶
func HistoryImage() HistoryImage_methods
func (HistoryImage_methods) Call ¶
func (m HistoryImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (history_out_ []ImageHistory, err_ error)
func (HistoryImage_methods) Send ¶
func (m HistoryImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) ([]ImageHistory, uint64, error), error)
type Image ¶
type Image struct { Id string `json:"id"` Digest string `json:"digest"` ParentId string `json:"parentId"` RepoTags []string `json:"repoTags"` RepoDigests []string `json:"repoDigests"` Created string `json:"created"` Size int64 `json:"size"` VirtualSize int64 `json:"virtualSize"` Containers int64 `json:"containers"` Labels map[string]string `json:"labels"` IsParent bool `json:"isParent"` TopLayer string `json:"topLayer"` ReadOnly bool `json:"readOnly"` }
type ImageExists_methods ¶
type ImageExists_methods struct{}
ImageExists talks a full or partial image ID or name and returns an int as to whether the image exists in local storage. An int result of 0 means the image does exist in local storage; whereas 1 indicates the image does not exists in local storage. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ImageExists '{"name": "imageddoesntexist"}'
{ "exists": 1 }
~~~
func ImageExists ¶
func ImageExists() ImageExists_methods
func (ImageExists_methods) Call ¶
func (m ImageExists_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (exists_out_ int64, err_ error)
type ImageHistory ¶
type ImageHistory struct { Id string `json:"id"` Created string `json:"created"` CreatedBy string `json:"createdBy"` Tags []string `json:"tags"` Size int64 `json:"size"` Comment string `json:"comment"` }
ImageHistory describes the returned structure from ImageHistory.
type ImageNotFound ¶
ImageNotFound means the image could not be found by the provided name or ID in local storage.
func (ImageNotFound) Error ¶
func (e ImageNotFound) Error() string
type ImageSaveOptions ¶
type ImageSave_methods ¶
type ImageSave_methods struct{}
ImageSave allows you to save an image from the local image storage to a tarball
func ImageSave ¶
func ImageSave() ImageSave_methods
func (ImageSave_methods) Call ¶
func (m ImageSave_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ ImageSaveOptions) (reply_out_ MoreResponse, err_ error)
func (ImageSave_methods) Send ¶
func (m ImageSave_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, options_in_ ImageSaveOptions) (func(ctx context.Context) (MoreResponse, uint64, error), error)
type ImageSearchFilter ¶
type ImageSearchResult ¶
type ImageSearchResult struct { Description string `json:"description"` Is_official bool `json:"is_official"` Is_automated bool `json:"is_automated"` Registry string `json:"registry"` Name string `json:"name"` Star_count int64 `json:"star_count"` }
Represents a single search result from SearchImages
type ImagesPrune_methods ¶
type ImagesPrune_methods struct{}
ImagesPrune removes all unused images from the local store. Upon successful pruning, the IDs of the removed images are returned.
func ImagesPrune ¶
func ImagesPrune() ImagesPrune_methods
func (ImagesPrune_methods) Call ¶
func (m ImagesPrune_methods) Call(ctx context.Context, c *varlink.Connection, all_in_ bool) (pruned_out_ []string, err_ error)
type ImportImage_methods ¶
type ImportImage_methods struct{}
ImportImage imports an image from a source (like tarball) into local storage. The image can have additional descriptions added to it using the message and changes options. See also ExportImage(ExportImage).
func ImportImage ¶
func ImportImage() ImportImage_methods
type InfoDistribution ¶
type InfoDistribution struct { Distribution string `json:"distribution"` Version string `json:"version"` }
InfoDistribution describes the host's distribution
type InfoGraphStatus ¶
type InfoGraphStatus struct { Backing_filesystem string `json:"backing_filesystem"` Native_overlay_diff string `json:"native_overlay_diff"` Supports_d_type string `json:"supports_d_type"` }
InfoGraphStatus describes the detailed status of the storage driver
type InfoHost ¶
type InfoHost struct { Buildah_version string `json:"buildah_version"` Distribution InfoDistribution `json:"distribution"` Mem_free int64 `json:"mem_free"` Mem_total int64 `json:"mem_total"` Swap_free int64 `json:"swap_free"` Swap_total int64 `json:"swap_total"` Arch string `json:"arch"` Cpus int64 `json:"cpus"` Hostname string `json:"hostname"` Kernel string `json:"kernel"` Os string `json:"os"` Uptime string `json:"uptime"` Eventlogger string `json:"eventlogger"` }
InfoHost describes the host stats portion of PodmanInfo
type InfoPodmanBinary ¶
type InfoPodmanBinary struct { Compiler string `json:"compiler"` Go_version string `json:"go_version"` Podman_version string `json:"podman_version"` Git_commit string `json:"git_commit"` }
InfoPodman provides details on the Podman binary
type InfoStore ¶
type InfoStore struct { Containers int64 `json:"containers"` Images int64 `json:"images"` Graph_driver_name string `json:"graph_driver_name"` Graph_driver_options string `json:"graph_driver_options"` Graph_root string `json:"graph_root"` Graph_status InfoGraphStatus `json:"graph_status"` Run_root string `json:"run_root"` }
InfoStore describes the host's storage informatoin
type InitContainer_methods ¶
type InitContainer_methods struct{}
InitContainer initializes the given container. It accepts a container name or ID, and will initialize the container matching that ID if possible, and error if not. Containers can only be initialized when they are in the Created or Exited states. Initialization prepares a container to be started, but does not start the container. It is intended to be used to debug a container's state prior to starting it.
func InitContainer ¶
func InitContainer() InitContainer_methods
func (InitContainer_methods) Call ¶
func (m InitContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
type InspectContainer_methods ¶
type InspectContainer_methods struct{}
InspectContainer data takes a name or ID of a container returns the inspection data in string format. You can then serialize the string into JSON. A ContainerNotFound(#ContainerNotFound) error will be returned if the container cannot be found. See also InspectImage(#InspectImage).
func InspectContainer ¶
func InspectContainer() InspectContainer_methods
func (InspectContainer_methods) Call ¶
func (m InspectContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
type InspectImage_methods ¶
type InspectImage_methods struct{}
InspectImage takes the name or ID of an image and returns a string representation of data associated with the mage. You must serialize the string into JSON to use it further. An ImageNotFound(#ImageNotFound) error will be returned if the image cannot be found.
func InspectImage ¶
func InspectImage() InspectImage_methods
func (InspectImage_methods) Call ¶
func (m InspectImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (image_out_ string, err_ error)
type InspectPod_methods ¶
type InspectPod_methods struct{}
InspectPod takes the name or ID of an image and returns a string representation of data associated with the pod. You must serialize the string into JSON to use it further. A PodNotFound(#PodNotFound) error will be returned if the pod cannot be found.
func InspectPod ¶
func InspectPod() InspectPod_methods
func (InspectPod_methods) Call ¶
func (m InspectPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, err_ error)
type InvalidState ¶
InvalidState indicates that a container or pod was in an improper state for the requested operation
func (InvalidState) Error ¶
func (e InvalidState) Error() string
type KillContainer_methods ¶
type KillContainer_methods struct{}
KillContainer takes the name or ID of a container as well as a signal to be applied to the container. Once the container has been killed, the container's ID is returned. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error is returned. See also StopContainer(StopContainer).
func KillContainer ¶
func KillContainer() KillContainer_methods
type KillPod_methods ¶
type KillPod_methods struct{}
KillPod takes the name or ID of a pod as well as a signal to be applied to the pod. If the pod cannot be found, a PodNotFound(#PodNotFound) error is returned. Containers in a pod are killed independently. If there is an error killing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was killed with no errors, the pod ID is returned. See also StopPod(StopPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.KillPod '{"name": "foobar", "signal": 15}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func KillPod ¶
func KillPod() KillPod_methods
type KubePodService ¶
type ListContainerChanges_methods ¶
type ListContainerChanges_methods struct{}
ListContainerChanges takes a name or ID of a container and returns changes between the container and its base image. It returns a struct of changed, deleted, and added path names.
func ListContainerChanges ¶
func ListContainerChanges() ListContainerChanges_methods
func (ListContainerChanges_methods) Call ¶
func (m ListContainerChanges_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ ContainerChanges, err_ error)
func (ListContainerChanges_methods) Send ¶
func (m ListContainerChanges_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (ContainerChanges, uint64, error), error)
type ListContainerMounts_methods ¶
type ListContainerMounts_methods struct{}
ListContainerMounts gathers all the mounted container mount points and returns them as an array of strings #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.ListContainerMounts
{ "mounts": { "04e4c255269ed2545e7f8bd1395a75f7949c50c223415c00c1d54bfa20f3b3d9": "/var/lib/containers/storage/overlay/a078925828f57e20467ca31cfca8a849210d21ec7e5757332b72b6924f441c17/merged", "1d58c319f9e881a644a5122ff84419dccf6d138f744469281446ab243ef38924": "/var/lib/containers/storage/overlay/948fcf93f8cb932f0f03fd52e3180a58627d547192ffe3b88e0013b98ddcd0d2/merged" } }
~~~
func ListContainerMounts ¶
func ListContainerMounts() ListContainerMounts_methods
func (ListContainerMounts_methods) Call ¶
func (m ListContainerMounts_methods) Call(ctx context.Context, c *varlink.Connection) (mounts_out_ map[string]string, err_ error)
type ListContainerProcesses_methods ¶
type ListContainerProcesses_methods struct{}
ListContainerProcesses takes a name or ID of a container and returns the processes running inside the container as array of strings. It will accept an array of string arguments that represent ps options. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ListContainerProcesses '{"name": "135d71b9495f", "opts": []}'
{ "container": [ " UID PID PPID C STIME TTY TIME CMD", " 0 21220 21210 0 09:05 pts/0 00:00:00 /bin/sh", " 0 21232 21220 0 09:05 pts/0 00:00:00 top", " 0 21284 21220 0 09:05 pts/0 00:00:00 vi /etc/hosts" ] }
~~~
func ListContainerProcesses ¶
func ListContainerProcesses() ListContainerProcesses_methods
type ListContainers_methods ¶
type ListContainers_methods struct{}
ListContainers returns information about all containers. See also GetContainer(#GetContainer).
func ListContainers ¶
func ListContainers() ListContainers_methods
func (ListContainers_methods) Call ¶
func (m ListContainers_methods) Call(ctx context.Context, c *varlink.Connection) (containers_out_ []Container, err_ error)
type ListImages_methods ¶
type ListImages_methods struct{}
ListImages returns information about the images that are currently in storage. See also InspectImage(#InspectImage).
func ListImages ¶
func ListImages() ListImages_methods
func (ListImages_methods) Call ¶
func (m ListImages_methods) Call(ctx context.Context, c *varlink.Connection) (images_out_ []Image, err_ error)
type ListPodContainerInfo ¶
type ListPodContainerInfo struct { Name string `json:"name"` Id string `json:"id"` Status string `json:"status"` }
ListPodContainerInfo is a returned struct for describing containers in a pod.
type ListPodData ¶
type ListPodData struct { Id string `json:"id"` Name string `json:"name"` Createdat string `json:"createdat"` Cgroup string `json:"cgroup"` Status string `json:"status"` Labels map[string]string `json:"labels"` Numberofcontainers string `json:"numberofcontainers"` Containersinfo []ListPodContainerInfo `json:"containersinfo"` }
ListPodData is the returned struct for an individual pod
type ListPods_methods ¶
type ListPods_methods struct{}
ListPods returns a list of pods in no particular order. They are returned as an array of ListPodData structs. See also GetPod(#GetPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ListPods
{ "pods": [ { "cgroup": "machine.slice", "containersinfo": [ { "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", "name": "1840835294cf-infra", "status": "running" }, { "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", "name": "upbeat_murdock", "status": "running" } ], "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", "name": "foobar", "numberofcontainers": "2", "status": "Running" }, { "cgroup": "machine.slice", "containersinfo": [ { "id": "1ca4b7bbba14a75ba00072d4b705c77f3df87db0109afaa44d50cb37c04a477e", "name": "784306f655c6-infra", "status": "running" } ], "createdat": "2018-12-07 13:09:57.105112457 -0600 CST", "id": "784306f655c6200aea321dd430ba685e9b2cc1f7d7528a72f3ff74ffb29485a2", "name": "nostalgic_pike", "numberofcontainers": "1", "status": "Running" } ] }
~~~
func ListPods ¶
func ListPods() ListPods_methods
func (ListPods_methods) Call ¶
func (m ListPods_methods) Call(ctx context.Context, c *varlink.Connection) (pods_out_ []ListPodData, err_ error)
func (ListPods_methods) Send ¶
func (m ListPods_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64) (func(ctx context.Context) ([]ListPodData, uint64, error), error)
type LoadImage_methods ¶
type LoadImage_methods struct{}
LoadImage allows you to load an image into local storage from a tarball.
func LoadImage ¶
func LoadImage() LoadImage_methods
func (LoadImage_methods) Call ¶
func (m LoadImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, inputFile_in_ string, quiet_in_ bool, deleteFile_in_ bool) (reply_out_ MoreResponse, err_ error)
type MoreResponse ¶
MoreResponse is a struct for when responses from varlink requires longer output
type MountContainer_methods ¶
type MountContainer_methods struct{}
MountContainer mounts a container by name or full/partial ID. Upon a successful mount, the destination mount is returned as a string. #### Example ~~~
$ varlink call -m unix:/run/podman/io.podman/io.podman.MountContainer '{"name": "jolly_shannon"}'{ "path": "/var/lib/containers/storage/overlay/419eeb04e783ea159149ced67d9fcfc15211084d65e894792a96bedfae0470ca/merged" }
~~~
func MountContainer ¶
func MountContainer() MountContainer_methods
func (MountContainer_methods) Call ¶
func (m MountContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (path_out_ string, err_ error)
type NoContainerRunning ¶
type NoContainerRunning struct{}
NoContainerRunning means none of the containers requested are running in a command that requires a running container.
func (NoContainerRunning) Error ¶
func (e NoContainerRunning) Error() string
type NoContainersInPod ¶
type NoContainersInPod struct {
Name string `json:"name"`
}
NoContainersInPod means a pod has no containers on which to perform the operation. It contains the pod ID.
func (NoContainersInPod) Error ¶
func (e NoContainersInPod) Error() string
type NotImplemented ¶
type NotImplemented struct {
Comment string `json:"comment"`
}
type PauseContainer_methods ¶
type PauseContainer_methods struct{}
PauseContainer takes the name or ID of container and pauses it. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. See also UnpauseContainer(#UnpauseContainer).
func PauseContainer ¶
func PauseContainer() PauseContainer_methods
func (PauseContainer_methods) Call ¶
func (m PauseContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
type PausePod_methods ¶
type PausePod_methods struct{}
PausePod takes the name or ID of a pod and pauses the running containers associated with it. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are paused independently. If there is an error pausing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was paused with no errors, the pod ID is returned. See also UnpausePod(#UnpausePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.PausePod '{"name": "foobar"}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func PausePod ¶
func PausePod() PausePod_methods
func (PausePod_methods) Call ¶
func (m PausePod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, err_ error)
type PodContainerError ¶
type PodContainerError struct { Podname string `json:"podname"` Errors []PodContainerErrorData `json:"errors"` }
PodContainerError means a container associated with a pod failed to perform an operation. It contains a container ID of the container that failed.
func (PodContainerError) Error ¶
func (e PodContainerError) Error() string
type PodContainerErrorData ¶
type PodCreate ¶
type PodCreate struct { Name string `json:"name"` CgroupParent string `json:"cgroupParent"` Labels map[string]string `json:"labels"` Infra bool `json:"infra"` InfraCommand string `json:"infraCommand"` InfraImage string `json:"infraImage"` Publish []string `json:"publish"` }
PodCreate is an input structure for creating pods. It emulates options to podman pod create. The infraCommand and infraImage options are currently NotSupported.
type PodNotFound ¶
PodNotFound means the pod could not be found by the provided name or ID in local storage.
func (PodNotFound) Error ¶
func (e PodNotFound) Error() string
type PodStateData_methods ¶
type PodStateData_methods struct{}
PodStateData returns inspectr level information of a given pod in string form. This call is for development of Podman only and generally should not be used.
func PodStateData ¶
func PodStateData() PodStateData_methods
func (PodStateData_methods) Call ¶
func (m PodStateData_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
type PodmanInfo ¶
type PodmanInfo struct { Host InfoHost `json:"host"` Registries []string `json:"registries"` Insecure_registries []string `json:"insecure_registries"` Store InfoStore `json:"store"` Podman InfoPodmanBinary `json:"podman"` }
PodmanInfo describes the Podman host and build
type PsContainer ¶
type PsContainer struct { Id string `json:"id"` Image string `json:"image"` Command string `json:"command"` Created string `json:"created"` Ports string `json:"ports"` Names string `json:"names"` IsInfra bool `json:"isInfra"` Status string `json:"status"` State string `json:"state"` PidNum int64 `json:"pidNum"` RootFsSize int64 `json:"rootFsSize"` RwSize int64 `json:"rwSize"` Pod string `json:"pod"` CreatedAt string `json:"createdAt"` ExitedAt string `json:"exitedAt"` StartedAt string `json:"startedAt"` Labels map[string]string `json:"labels"` NsPid string `json:"nsPid"` Cgroup string `json:"cgroup"` Ipc string `json:"ipc"` Mnt string `json:"mnt"` Net string `json:"net"` PidNs string `json:"pidNs"` User string `json:"user"` Uts string `json:"uts"` Mounts string `json:"mounts"` }
type PsOpts ¶
type PsOpts struct { All bool `json:"all"` Filters *[]string `json:"filters,omitempty"` Last *int64 `json:"last,omitempty"` Latest *bool `json:"latest,omitempty"` NoTrunc *bool `json:"noTrunc,omitempty"` Pod *bool `json:"pod,omitempty"` Quiet *bool `json:"quiet,omitempty"` Size *bool `json:"size,omitempty"` Sort *string `json:"sort,omitempty"` Sync *bool `json:"sync,omitempty"` }
type Ps_methods ¶
type Ps_methods struct{}
func Ps ¶
func Ps() Ps_methods
func (Ps_methods) Call ¶
func (m Ps_methods) Call(ctx context.Context, c *varlink.Connection, opts_in_ PsOpts) (containers_out_ []PsContainer, err_ error)
func (Ps_methods) Send ¶
func (m Ps_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, opts_in_ PsOpts) (func(ctx context.Context) ([]PsContainer, uint64, error), error)
type PullImage_methods ¶
type PullImage_methods struct{}
PullImage pulls an image from a repository to local storage. After a successful pull, the image id and logs are returned as a MoreResponse(#MoreResponse). This connection also will handle a WantsMores request to send status as it occurs.
func PullImage ¶
func PullImage() PullImage_methods
func (PullImage_methods) Call ¶
func (m PullImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (reply_out_ MoreResponse, err_ error)
func (PullImage_methods) Send ¶
func (m PullImage_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, name_in_ string) (func(ctx context.Context) (MoreResponse, uint64, error), error)
type PushImage_methods ¶
type PushImage_methods struct{}
PushImage takes two input arguments: the name or ID of an image, the fully-qualified destination name of the image, It will return an ImageNotFound(#ImageNotFound) error if the image cannot be found in local storage; otherwise it will return a MoreResponse(#MoreResponse)
func PushImage ¶
func PushImage() PushImage_methods
func (PushImage_methods) Call ¶
func (m PushImage_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, tag_in_ string, compress_in_ bool, format_in_ string, removeSignatures_in_ bool, signBy_in_ string) (reply_out_ MoreResponse, err_ error)
type ReceiveFile_methods ¶
type ReceiveFile_methods struct{}
ReceiveFile allows the host to send a remote client a file
func ReceiveFile ¶
func ReceiveFile() ReceiveFile_methods
type RemoveContainer_methods ¶
type RemoveContainer_methods struct{}
RemoveContainer requires the name or ID of a container as well as a boolean that indicates whether a container should be forcefully removed (e.g., by stopping it), and a boolean indicating whether to remove builtin volumes. Upon successful removal of the container, its ID is returned. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned. See also EvictContainer(EvictContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveContainer '{"name": "62f4fd98cb57"}'
{ "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func RemoveContainer ¶
func RemoveContainer() RemoveContainer_methods
type RemoveImage_methods ¶
type RemoveImage_methods struct{}
RemoveImage takes the name or ID of an image as well as a boolean that determines if containers using that image should be deleted. If the image cannot be found, an ImageNotFound(#ImageNotFound) error will be returned. The ID of the removed image is returned when complete. See also DeleteUnusedImages(DeleteUnusedImages). #### Example ~~~ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveImage '{"name": "registry.fedoraproject.org/fedora", "force": true}'
{ "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" }
~~~
func RemoveImage ¶
func RemoveImage() RemoveImage_methods
type RemovePod_methods ¶
type RemovePod_methods struct{}
RemovePod takes the name or ID of a pod as well a boolean representing whether a running container in the pod can be stopped and removed. If a pod has containers associated with it, and force is not true, an error will occur. If the pod cannot be found by name or ID, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are removed independently. If there is an error removing any container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was removed with no errors, the pod ID is returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RemovePod '{"name": "62f4fd98cb57", "force": "true"}'
{ "pod": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func RemovePod ¶
func RemovePod() RemovePod_methods
type RestartContainer_methods ¶
type RestartContainer_methods struct{}
RestartContainer will restart a running container given a container name or ID and timeout value. The timeout value is the time before a forcible stop is used to stop the container. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise, the ID of the container will be returned.
func RestartContainer ¶
func RestartContainer() RestartContainer_methods
type RestartPod_methods ¶
type RestartPod_methods struct{}
RestartPod will restart containers in a pod given a pod name or ID. Containers in the pod that are running will be stopped, then all stopped containers will be run. If the pod cannot be found by name or ID, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are restarted independently. If there is an error restarting one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was restarted with no errors, the pod ID is returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RestartPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func RestartPod ¶
func RestartPod() RestartPod_methods
func (RestartPod_methods) Call ¶
func (m RestartPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, err_ error)
type Runlabel ¶
type Runlabel struct { Image string `json:"image"` Authfile string `json:"authfile"` Display bool `json:"display"` Name string `json:"name"` Pull bool `json:"pull"` Label string `json:"label"` ExtraArgs []string `json:"extraArgs"` Opts map[string]string `json:"opts"` }
Runlabel describes the required input for container runlabel
type RuntimeError ¶
type RuntimeError struct {
Reason string `json:"reason"`
}
RuntimeErrors generally means a runtime could not be found or gotten.
func (RuntimeError) Error ¶
func (e RuntimeError) Error() string
type SearchImages_methods ¶
type SearchImages_methods struct{}
SearchImages searches available registries for images that contain the contents of "query" in their name. If "limit" is given, limits the amount of search results per registry.
func SearchImages ¶
func SearchImages() SearchImages_methods
func (SearchImages_methods) Call ¶
func (m SearchImages_methods) Call(ctx context.Context, c *varlink.Connection, query_in_ string, limit_in_ *int64, filter_in_ ImageSearchFilter) (results_out_ []ImageSearchResult, err_ error)
func (SearchImages_methods) Send ¶
func (m SearchImages_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, query_in_ string, limit_in_ *int64, filter_in_ ImageSearchFilter) (func(ctx context.Context) ([]ImageSearchResult, uint64, error), error)
type SendFile_methods ¶
type SendFile_methods struct{}
Sendfile allows a remote client to send a file to the host
func SendFile ¶
func SendFile() SendFile_methods
type Sockets ¶
type Sockets struct { Container_id string `json:"container_id"` Io_socket string `json:"io_socket"` Control_socket string `json:"control_socket"` }
Sockets describes sockets location for a container
type Spec_methods ¶
type Spec_methods struct{}
Spec returns the oci spec for a container. This call is for development of Podman only and generally should not be used.
func Spec ¶
func Spec() Spec_methods
func (Spec_methods) Call ¶
func (m Spec_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (config_out_ string, err_ error)
type StartContainer_methods ¶
type StartContainer_methods struct{}
StartContainer starts a created or stopped container. It takes the name or ID of container. It returns the container ID once started. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. See also CreateContainer(#CreateContainer).
func StartContainer ¶
func StartContainer() StartContainer_methods
func (StartContainer_methods) Call ¶
func (m StartContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
type StartPod_methods ¶
type StartPod_methods struct{}
StartPod starts containers in a pod. It takes the name or ID of pod. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are started independently. If there is an error starting one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was started with no errors, the pod ID is returned. See also CreatePod(#CreatePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StartPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6", }
~~~
func StartPod ¶
func StartPod() StartPod_methods
func (StartPod_methods) Call ¶
func (m StartPod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, err_ error)
type StopContainer_methods ¶
type StopContainer_methods struct{}
StopContainer stops a container given a timeout. It takes the name or ID of a container as well as a timeout value. The timeout value the time before a forcible stop to the container is applied. It returns the container ID once stopped. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned instead. See also KillContainer(KillContainer). #### Error ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StopContainer '{"name": "135d71b9495f", "timeout": 5}'
{ "container": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func StopContainer ¶
func StopContainer() StopContainer_methods
type StopPod_methods ¶
type StopPod_methods struct{}
StopPod stops containers in a pod. It takes the name or ID of a pod and a timeout. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned instead. Containers in a pod are stopped independently. If there is an error stopping one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was stopped with no errors, the pod ID is returned. See also KillPod(KillPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StopPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func StopPod ¶
func StopPod() StopPod_methods
type StringResponse ¶
type StringResponse struct {
Message string `json:"message"`
}
type TagImage_methods ¶
type TagImage_methods struct{}
TagImage takes the name or ID of an image in local storage as well as the desired tag name. If the image cannot be found, an ImageNotFound(#ImageNotFound) error will be returned; otherwise, the ID of the image is returned on success.
func TagImage ¶
func TagImage() TagImage_methods
type TopPod_methods ¶
type TopPod_methods struct{}
func TopPod ¶
func TopPod() TopPod_methods
type Top_methods ¶
type Top_methods struct{}
func Top ¶
func Top() Top_methods
type UnmountContainer_methods ¶
type UnmountContainer_methods struct{}
UnmountContainer umounts a container by its name or full/partial container ID. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnmountContainer '{"name": "jolly_shannon", "force": false}' {} ~~~
func UnmountContainer ¶
func UnmountContainer() UnmountContainer_methods
func (UnmountContainer_methods) Call ¶
func (m UnmountContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string, force_in_ bool) (err_ error)
type UnpauseContainer_methods ¶
type UnpauseContainer_methods struct{}
UnpauseContainer takes the name or ID of container and unpauses a paused container. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. See also PauseContainer(#PauseContainer).
func UnpauseContainer ¶
func UnpauseContainer() UnpauseContainer_methods
func (UnpauseContainer_methods) Call ¶
func (m UnpauseContainer_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (container_out_ string, err_ error)
type UnpausePod_methods ¶
type UnpausePod_methods struct{}
UnpausePod takes the name or ID of a pod and unpauses the paused containers associated with it. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are unpaused independently. If there is an error unpausing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was unpaused with no errors, the pod ID is returned. See also PausePod(#PausePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnpausePod '{"name": "foobar"}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func UnpausePod ¶
func UnpausePod() UnpausePod_methods
func (UnpausePod_methods) Call ¶
func (m UnpausePod_methods) Call(ctx context.Context, c *varlink.Connection, name_in_ string) (pod_out_ string, err_ error)
type VarlinkCall ¶
func (*VarlinkCall) ReplyAttach ¶
func (c *VarlinkCall) ReplyAttach(ctx context.Context) error
func (*VarlinkCall) ReplyAttachControl ¶
func (c *VarlinkCall) ReplyAttachControl(ctx context.Context) error
func (*VarlinkCall) ReplyBuildImage ¶
func (c *VarlinkCall) ReplyBuildImage(ctx context.Context, image_ MoreResponse) error
func (*VarlinkCall) ReplyBuildImageHierarchyMap ¶
func (c *VarlinkCall) ReplyBuildImageHierarchyMap(ctx context.Context, imageInfo_ string) error
func (*VarlinkCall) ReplyCommit ¶
func (c *VarlinkCall) ReplyCommit(ctx context.Context, reply_ MoreResponse) error
func (*VarlinkCall) ReplyContainerArtifacts ¶
func (c *VarlinkCall) ReplyContainerArtifacts(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyContainerCheckpoint ¶
func (c *VarlinkCall) ReplyContainerCheckpoint(ctx context.Context, id_ string) error
func (*VarlinkCall) ReplyContainerConfig ¶
func (c *VarlinkCall) ReplyContainerConfig(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyContainerExists ¶
func (c *VarlinkCall) ReplyContainerExists(ctx context.Context, exists_ int64) error
func (*VarlinkCall) ReplyContainerInspectData ¶
func (c *VarlinkCall) ReplyContainerInspectData(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyContainerNotFound ¶
ContainerNotFound means the container could not be found by the provided name or ID in local storage.
func (*VarlinkCall) ReplyContainerRestore ¶
func (c *VarlinkCall) ReplyContainerRestore(ctx context.Context, id_ string) error
func (*VarlinkCall) ReplyContainerRunlabel ¶
func (c *VarlinkCall) ReplyContainerRunlabel(ctx context.Context) error
func (*VarlinkCall) ReplyContainerStateData ¶
func (c *VarlinkCall) ReplyContainerStateData(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyCreateContainer ¶
func (c *VarlinkCall) ReplyCreateContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyCreateFromCC ¶
func (c *VarlinkCall) ReplyCreateFromCC(ctx context.Context, id_ string) error
func (*VarlinkCall) ReplyCreatePod ¶
func (c *VarlinkCall) ReplyCreatePod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyDeleteStoppedContainers ¶
func (c *VarlinkCall) ReplyDeleteStoppedContainers(ctx context.Context, containers_ []string) error
func (*VarlinkCall) ReplyDeleteUnusedImages ¶
func (c *VarlinkCall) ReplyDeleteUnusedImages(ctx context.Context, images_ []string) error
func (*VarlinkCall) ReplyDiff ¶
func (c *VarlinkCall) ReplyDiff(ctx context.Context, diffs_ []DiffInfo) error
func (*VarlinkCall) ReplyErrCtrStopped ¶
func (c *VarlinkCall) ReplyErrCtrStopped(ctx context.Context, id_ string) error
Container is already stopped
func (*VarlinkCall) ReplyErrRequiresCgroupsV2ForRootless ¶
func (c *VarlinkCall) ReplyErrRequiresCgroupsV2ForRootless(ctx context.Context, reason_ string) error
This function requires CGroupsV2 to run in rootless mode.
func (*VarlinkCall) ReplyErrorOccurred ¶
func (c *VarlinkCall) ReplyErrorOccurred(ctx context.Context, reason_ string) error
ErrorOccurred is a generic error for an error that occurs during the execution. The actual error message is includes as part of the error's text.
func (*VarlinkCall) ReplyEvictContainer ¶
func (c *VarlinkCall) ReplyEvictContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyExecContainer ¶
func (c *VarlinkCall) ReplyExecContainer(ctx context.Context) error
func (*VarlinkCall) ReplyExportContainer ¶
func (c *VarlinkCall) ReplyExportContainer(ctx context.Context, tarfile_ string) error
func (*VarlinkCall) ReplyExportImage ¶
func (c *VarlinkCall) ReplyExportImage(ctx context.Context, image_ string) error
func (*VarlinkCall) ReplyGenerateKube ¶
func (c *VarlinkCall) ReplyGenerateKube(ctx context.Context, pod_ KubePodService) error
func (*VarlinkCall) ReplyGetAttachSockets ¶
func (c *VarlinkCall) ReplyGetAttachSockets(ctx context.Context, sockets_ Sockets) error
func (*VarlinkCall) ReplyGetContainer ¶
func (c *VarlinkCall) ReplyGetContainer(ctx context.Context, container_ Container) error
func (*VarlinkCall) ReplyGetContainerLogs ¶
func (c *VarlinkCall) ReplyGetContainerLogs(ctx context.Context, container_ []string) error
func (*VarlinkCall) ReplyGetContainerStats ¶
func (c *VarlinkCall) ReplyGetContainerStats(ctx context.Context, container_ ContainerStats) error
func (*VarlinkCall) ReplyGetContainerStatsWithHistory ¶
func (c *VarlinkCall) ReplyGetContainerStatsWithHistory(ctx context.Context, container_ ContainerStats) error
func (*VarlinkCall) ReplyGetContainersByContext ¶
func (c *VarlinkCall) ReplyGetContainersByContext(ctx context.Context, containers_ []string) error
func (*VarlinkCall) ReplyGetContainersByStatus ¶
func (c *VarlinkCall) ReplyGetContainersByStatus(ctx context.Context, containerS_ []Container) error
func (*VarlinkCall) ReplyGetContainersLogs ¶
func (c *VarlinkCall) ReplyGetContainersLogs(ctx context.Context, log_ LogLine) error
func (*VarlinkCall) ReplyGetEvents ¶
func (c *VarlinkCall) ReplyGetEvents(ctx context.Context, events_ Event) error
func (*VarlinkCall) ReplyGetImage ¶
func (c *VarlinkCall) ReplyGetImage(ctx context.Context, image_ Image) error
func (*VarlinkCall) ReplyGetInfo ¶
func (c *VarlinkCall) ReplyGetInfo(ctx context.Context, info_ PodmanInfo) error
func (*VarlinkCall) ReplyGetLayersMapWithImageInfo ¶
func (c *VarlinkCall) ReplyGetLayersMapWithImageInfo(ctx context.Context, layerMap_ string) error
func (*VarlinkCall) ReplyGetPod ¶
func (c *VarlinkCall) ReplyGetPod(ctx context.Context, pod_ ListPodData) error
func (*VarlinkCall) ReplyGetPodStats ¶
func (c *VarlinkCall) ReplyGetPodStats(ctx context.Context, pod_ string, containers_ []ContainerStats) error
func (*VarlinkCall) ReplyGetPodsByContext ¶
func (c *VarlinkCall) ReplyGetPodsByContext(ctx context.Context, pods_ []string) error
func (*VarlinkCall) ReplyGetPodsByStatus ¶
func (c *VarlinkCall) ReplyGetPodsByStatus(ctx context.Context, pods_ []string) error
func (*VarlinkCall) ReplyGetVersion ¶
func (*VarlinkCall) ReplyGetVolumes ¶
func (c *VarlinkCall) ReplyGetVolumes(ctx context.Context, volumes_ []Volume) error
func (*VarlinkCall) ReplyHealthCheckRun ¶
func (c *VarlinkCall) ReplyHealthCheckRun(ctx context.Context, healthCheckStatus_ string) error
func (*VarlinkCall) ReplyHistoryImage ¶
func (c *VarlinkCall) ReplyHistoryImage(ctx context.Context, history_ []ImageHistory) error
func (*VarlinkCall) ReplyImageExists ¶
func (c *VarlinkCall) ReplyImageExists(ctx context.Context, exists_ int64) error
func (*VarlinkCall) ReplyImageNotFound ¶
ImageNotFound means the image could not be found by the provided name or ID in local storage.
func (*VarlinkCall) ReplyImageSave ¶
func (c *VarlinkCall) ReplyImageSave(ctx context.Context, reply_ MoreResponse) error
func (*VarlinkCall) ReplyImagesPrune ¶
func (c *VarlinkCall) ReplyImagesPrune(ctx context.Context, pruned_ []string) error
func (*VarlinkCall) ReplyImportImage ¶
func (c *VarlinkCall) ReplyImportImage(ctx context.Context, image_ string) error
func (*VarlinkCall) ReplyInitContainer ¶
func (c *VarlinkCall) ReplyInitContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyInspectContainer ¶
func (c *VarlinkCall) ReplyInspectContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyInspectImage ¶
func (c *VarlinkCall) ReplyInspectImage(ctx context.Context, image_ string) error
func (*VarlinkCall) ReplyInspectPod ¶
func (c *VarlinkCall) ReplyInspectPod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyInvalidState ¶
InvalidState indicates that a container or pod was in an improper state for the requested operation
func (*VarlinkCall) ReplyKillContainer ¶
func (c *VarlinkCall) ReplyKillContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyKillPod ¶
func (c *VarlinkCall) ReplyKillPod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyListContainerChanges ¶
func (c *VarlinkCall) ReplyListContainerChanges(ctx context.Context, container_ ContainerChanges) error
func (*VarlinkCall) ReplyListContainerMounts ¶
func (*VarlinkCall) ReplyListContainerProcesses ¶
func (c *VarlinkCall) ReplyListContainerProcesses(ctx context.Context, container_ []string) error
func (*VarlinkCall) ReplyListContainers ¶
func (c *VarlinkCall) ReplyListContainers(ctx context.Context, containers_ []Container) error
func (*VarlinkCall) ReplyListImages ¶
func (c *VarlinkCall) ReplyListImages(ctx context.Context, images_ []Image) error
func (*VarlinkCall) ReplyListPods ¶
func (c *VarlinkCall) ReplyListPods(ctx context.Context, pods_ []ListPodData) error
func (*VarlinkCall) ReplyLoadImage ¶
func (c *VarlinkCall) ReplyLoadImage(ctx context.Context, reply_ MoreResponse) error
func (*VarlinkCall) ReplyMountContainer ¶
func (c *VarlinkCall) ReplyMountContainer(ctx context.Context, path_ string) error
func (*VarlinkCall) ReplyNoContainerRunning ¶
func (c *VarlinkCall) ReplyNoContainerRunning(ctx context.Context) error
NoContainerRunning means none of the containers requested are running in a command that requires a running container.
func (*VarlinkCall) ReplyNoContainersInPod ¶
func (c *VarlinkCall) ReplyNoContainersInPod(ctx context.Context, name_ string) error
NoContainersInPod means a pod has no containers on which to perform the operation. It contains the pod ID.
func (*VarlinkCall) ReplyPauseContainer ¶
func (c *VarlinkCall) ReplyPauseContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyPausePod ¶
func (c *VarlinkCall) ReplyPausePod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyPodContainerError ¶
func (c *VarlinkCall) ReplyPodContainerError(ctx context.Context, podname_ string, errors_ []PodContainerErrorData) error
PodContainerError means a container associated with a pod failed to perform an operation. It contains a container ID of the container that failed.
func (*VarlinkCall) ReplyPodNotFound ¶
PodNotFound means the pod could not be found by the provided name or ID in local storage.
func (*VarlinkCall) ReplyPodStateData ¶
func (c *VarlinkCall) ReplyPodStateData(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyPs ¶
func (c *VarlinkCall) ReplyPs(ctx context.Context, containers_ []PsContainer) error
func (*VarlinkCall) ReplyPullImage ¶
func (c *VarlinkCall) ReplyPullImage(ctx context.Context, reply_ MoreResponse) error
func (*VarlinkCall) ReplyPushImage ¶
func (c *VarlinkCall) ReplyPushImage(ctx context.Context, reply_ MoreResponse) error
func (*VarlinkCall) ReplyReceiveFile ¶
func (c *VarlinkCall) ReplyReceiveFile(ctx context.Context, len_ int64) error
func (*VarlinkCall) ReplyRemoveContainer ¶
func (c *VarlinkCall) ReplyRemoveContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyRemoveImage ¶
func (c *VarlinkCall) ReplyRemoveImage(ctx context.Context, image_ string) error
func (*VarlinkCall) ReplyRemovePod ¶
func (c *VarlinkCall) ReplyRemovePod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyRestartContainer ¶
func (c *VarlinkCall) ReplyRestartContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyRestartPod ¶
func (c *VarlinkCall) ReplyRestartPod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyRuntimeError ¶
func (c *VarlinkCall) ReplyRuntimeError(ctx context.Context, reason_ string) error
RuntimeErrors generally means a runtime could not be found or gotten.
func (*VarlinkCall) ReplySearchImages ¶
func (c *VarlinkCall) ReplySearchImages(ctx context.Context, results_ []ImageSearchResult) error
func (*VarlinkCall) ReplySendFile ¶
func (c *VarlinkCall) ReplySendFile(ctx context.Context, file_handle_ string) error
func (*VarlinkCall) ReplySpec ¶
func (c *VarlinkCall) ReplySpec(ctx context.Context, config_ string) error
func (*VarlinkCall) ReplyStartContainer ¶
func (c *VarlinkCall) ReplyStartContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyStartPod ¶
func (c *VarlinkCall) ReplyStartPod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyStopContainer ¶
func (c *VarlinkCall) ReplyStopContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyStopPod ¶
func (c *VarlinkCall) ReplyStopPod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyTagImage ¶
func (c *VarlinkCall) ReplyTagImage(ctx context.Context, image_ string) error
func (*VarlinkCall) ReplyTop ¶
func (c *VarlinkCall) ReplyTop(ctx context.Context, top_ []string) error
func (*VarlinkCall) ReplyTopPod ¶
func (c *VarlinkCall) ReplyTopPod(ctx context.Context, stats_ []string) error
func (*VarlinkCall) ReplyUnmountContainer ¶
func (c *VarlinkCall) ReplyUnmountContainer(ctx context.Context) error
func (*VarlinkCall) ReplyUnpauseContainer ¶
func (c *VarlinkCall) ReplyUnpauseContainer(ctx context.Context, container_ string) error
func (*VarlinkCall) ReplyUnpausePod ¶
func (c *VarlinkCall) ReplyUnpausePod(ctx context.Context, pod_ string) error
func (*VarlinkCall) ReplyVolumeCreate ¶
func (c *VarlinkCall) ReplyVolumeCreate(ctx context.Context, volumeName_ string) error
func (*VarlinkCall) ReplyVolumeNotFound ¶
VolumeNotFound means the volume could not be found by the name or ID in local storage.
func (*VarlinkCall) ReplyVolumeRemove ¶
func (*VarlinkCall) ReplyVolumesPrune ¶
func (*VarlinkCall) ReplyWaitContainer ¶
func (c *VarlinkCall) ReplyWaitContainer(ctx context.Context, exitcode_ int64) error
func (*VarlinkCall) ReplyWantsMoreRequired ¶
func (c *VarlinkCall) ReplyWantsMoreRequired(ctx context.Context, reason_ string) error
The Podman endpoint requires that you use a streaming connection.
type VarlinkInterface ¶
type VarlinkInterface struct {
// contains filtered or unexported fields
}
func VarlinkNew ¶
func VarlinkNew(m iopodmanInterface) *VarlinkInterface
func (*VarlinkInterface) Attach ¶
func (s *VarlinkInterface) Attach(ctx context.Context, c VarlinkCall, name_ string, detachKeys_ string, start_ bool) error
Attach takes the name or ID of a container and sets up the ability to remotely attach to its console. The start bool is whether you wish to start the container in question first.
func (*VarlinkInterface) AttachControl ¶
func (s *VarlinkInterface) AttachControl(ctx context.Context, c VarlinkCall, name_ string) error
func (*VarlinkInterface) BuildImage ¶
func (s *VarlinkInterface) BuildImage(ctx context.Context, c VarlinkCall, build_ BuildInfo) error
BuildImage takes a BuildInfo(#BuildInfo) structure and builds an image. At a minimum, you must provide the contextDir tarball path, the 'dockerfiles' path, and 'output' option in the BuildInfo structure. The 'output' options is the name of the of the resulting build. It will return a MoreResponse(#MoreResponse) structure that contains the build logs and resulting image ID. #### Example ~~~ $ sudo varlink call -m unix:///run/podman/io.podman/io.podman.BuildImage '{"build":{"contextDir":"/tmp/t/context.tar","dockerfiles":["Dockerfile"], "output":"foobar"}}'
{ "image": { "id": "", "logs": [ "STEP 1: FROM alpine\n" ] } }
{ "image": { "id": "", "logs": [ "STEP 2: COMMIT foobar\n" ] } }
{ "image": { "id": "", "logs": [ "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9\n" ] } }
{ "image": { "id": "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9", "logs": [] } }
~~~
func (*VarlinkInterface) BuildImageHierarchyMap ¶
func (s *VarlinkInterface) BuildImageHierarchyMap(ctx context.Context, c VarlinkCall, name_ string) error
BuildImageHierarchyMap is for the development of Podman and should not be used.
func (*VarlinkInterface) Commit ¶
func (s *VarlinkInterface) Commit(ctx context.Context, c VarlinkCall, name_ string, image_name_ string, changes_ []string, author_ string, message_ string, pause_ bool, manifestType_ string) error
Commit, creates an image from an existing container. It requires the name or ID of the container as well as the resulting image name. Optionally, you can define an author and message to be added to the resulting image. You can also define changes to the resulting image for the following attributes: _CMD, ENTRYPOINT, ENV, EXPOSE, LABEL, ONBUILD, STOPSIGNAL, USER, VOLUME, and WORKDIR_. To pause the container while it is being committed, pass a _true_ bool for the pause argument. If the container cannot be found by the ID or name provided, a (ContainerNotFound)[#ContainerNotFound] error will be returned; otherwise, the resulting image's ID will be returned as a string inside a MoreResponse.
func (*VarlinkInterface) ContainerArtifacts ¶
func (s *VarlinkInterface) ContainerArtifacts(ctx context.Context, c VarlinkCall, name_ string, artifactName_ string) error
ContainerArtifacts returns a container's artifacts in string form. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) ContainerCheckpoint ¶
func (s *VarlinkInterface) ContainerCheckpoint(ctx context.Context, c VarlinkCall, name_ string, keep_ bool, leaveRunning_ bool, tcpEstablished_ bool) error
ContainerCheckPoint performs a checkpopint on a container by its name or full/partial container ID. On successful checkpoint, the id of the checkpointed container is returned.
func (*VarlinkInterface) ContainerConfig ¶
func (s *VarlinkInterface) ContainerConfig(ctx context.Context, c VarlinkCall, name_ string) error
ContainerConfig returns a container's config in string form. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) ContainerExists ¶
func (s *VarlinkInterface) ContainerExists(ctx context.Context, c VarlinkCall, name_ string) error
ContainerExists takes a full or partial container ID or name and returns an int as to whether the container exists in local storage. A result of 0 means the container does exists; whereas a result of 1 means it could not be found. #### Example ~~~
$ varlink call -m unix:/run/podman/io.podman/io.podman.ContainerExists '{"name": "flamboyant_payne"}'{ "exists": 0 }
~~~
func (*VarlinkInterface) ContainerInspectData ¶
func (s *VarlinkInterface) ContainerInspectData(ctx context.Context, c VarlinkCall, name_ string, size_ bool) error
ContainerInspectData returns a container's inspect data in string form. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) ContainerRestore ¶
func (s *VarlinkInterface) ContainerRestore(ctx context.Context, c VarlinkCall, name_ string, keep_ bool, tcpEstablished_ bool) error
ContainerRestore restores a container that has been checkpointed. The container to be restored can be identified by its name or full/partial container ID. A successful restore will result in the return of the container's ID.
func (*VarlinkInterface) ContainerRunlabel ¶
func (s *VarlinkInterface) ContainerRunlabel(ctx context.Context, c VarlinkCall, runlabel_ Runlabel) error
ContainerRunlabel runs executes a command as described by a given container image label.
func (*VarlinkInterface) ContainerStateData ¶
func (s *VarlinkInterface) ContainerStateData(ctx context.Context, c VarlinkCall, name_ string) error
ContainerStateData returns a container's state config in string form. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) CreateContainer ¶
func (s *VarlinkInterface) CreateContainer(ctx context.Context, c VarlinkCall, create_ Create) error
CreateContainer creates a new container from an image. It uses a Create(#Create) type for input.
func (*VarlinkInterface) CreateFromCC ¶
func (s *VarlinkInterface) CreateFromCC(ctx context.Context, c VarlinkCall, in_ []string) error
This call is for the development of Podman only and should not be used.
func (*VarlinkInterface) CreatePod ¶
func (s *VarlinkInterface) CreatePod(ctx context.Context, c VarlinkCall, create_ PodCreate) error
CreatePod creates a new empty pod. It uses a PodCreate(#PodCreate) type for input. On success, the ID of the newly created pod will be returned. #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"name": "test"}}'
{ "pod": "b05dee7bd4ccfee688099fe1588a7a898d6ddd6897de9251d4671c9b0feacb2a" }
$ varlink call unix:/run/podman/io.podman/io.podman.CreatePod '{"create": {"infra": true, "share": ["ipc", "net", "uts"]}}' ¶
{ "pod": "d7697449a8035f613c1a8891286502aca68fff7d5d49a85279b3bda229af3b28" }
~~~
func (*VarlinkInterface) DeleteStoppedContainers ¶
func (s *VarlinkInterface) DeleteStoppedContainers(ctx context.Context, c VarlinkCall) error
DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted container IDs. See also RemoveContainer(RemoveContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteStoppedContainers
{ "containers": [ "451410b931d00def8aa9b4f8084e4d4a39e5e04ea61f358cf53a5cf95afcdcee", "8b60f754a3e01389494a9581ade97d35c2765b6e2f19acd2d3040c82a32d1bc0", "cf2e99d4d3cad6073df199ed32bbe64b124f3e1aba6d78821aa8460e70d30084", "db901a329587312366e5ecff583d08f0875b4b79294322df67d90fc6eed08fc1" ] }
~~~
func (*VarlinkInterface) DeleteUnusedImages ¶
func (s *VarlinkInterface) DeleteUnusedImages(ctx context.Context, c VarlinkCall) error
DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned in a string array. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.DeleteUnusedImages
{ "images": [ "166ea6588079559c724c15223f52927f514f73dd5c5cf2ae2d143e3b2e6e9b52", "da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e", "3ef70f7291f47dfe2b82931a993e16f5a44a0e7a68034c3e0e086d77f5829adc", "59788edf1f3e78cd0ebe6ce1446e9d10788225db3dedcfd1a59f764bad2b2690" ] }
~~~
func (*VarlinkInterface) Diff ¶
func (s *VarlinkInterface) Diff(ctx context.Context, c VarlinkCall, name_ string) error
Diff returns a diff between libpod objects
func (*VarlinkInterface) EvictContainer ¶
func (s *VarlinkInterface) EvictContainer(ctx context.Context, c VarlinkCall, name_ string, removeVolumes_ bool) error
EvictContainer requires the name or ID of a container as well as a boolean that indicates to remove builtin volumes. Upon successful eviction of the container, its ID is returned. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned. See also RemoveContainer(RemoveContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.EvictContainer '{"name": "62f4fd98cb57"}'
{ "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func (*VarlinkInterface) ExecContainer ¶
func (s *VarlinkInterface) ExecContainer(ctx context.Context, c VarlinkCall, opts_ ExecOpts) error
ExecContainer executes a command in the given container.
func (*VarlinkInterface) ExportContainer ¶
func (s *VarlinkInterface) ExportContainer(ctx context.Context, c VarlinkCall, name_ string, path_ string) error
ExportContainer creates an image from a container. It takes the name or ID of a container and a path representing the target tarfile. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. The return value is the written tarfile. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ExportContainer '{"name": "flamboyant_payne", "path": "/tmp/payne.tar" }'
{ "tarfile": "/tmp/payne.tar" }
~~~
func (*VarlinkInterface) ExportImage ¶
func (s *VarlinkInterface) ExportImage(ctx context.Context, c VarlinkCall, name_ string, destination_ string, compress_ bool, tags_ []string) error
ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also a boolean option to force compression. It also takes in a string array of tags to be able to save multiple tags of the same image to a tarball (each tag should be of the form <image>:<tag>). Upon completion, the ID of the image is returned. If the image cannot be found in local storage, an ImageNotFound(#ImageNotFound) error will be returned. See also ImportImage(ImportImage).
func (*VarlinkInterface) GenerateKube ¶
func (s *VarlinkInterface) GenerateKube(ctx context.Context, c VarlinkCall, name_ string, service_ bool) error
GenerateKube generates a Kubernetes v1 Pod description of a Podman container or pod and its containers. The description is in YAML. See also [ReplayKube](ReplayKube).
func (*VarlinkInterface) GetAttachSockets ¶
func (s *VarlinkInterface) GetAttachSockets(ctx context.Context, c VarlinkCall, name_ string) error
GetAttachSockets takes the name or ID of an existing container. It returns file paths for two sockets needed to properly communicate with a container. The first is the actual I/O socket that the container uses. The second is a "control" socket where things like resizing the TTY events are sent. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. #### Example ~~~ $ varlink call -m unix:/run/io.podman/io.podman.GetAttachSockets '{"name": "b7624e775431219161"}'
{ "sockets": { "container_id": "b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca", "control_socket": "/var/lib/containers/storage/overlay-containers/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/userdata/ctl", "io_socket": "/var/run/libpod/socket/b7624e7754312191613245ce1a46844abee60025818fe3c3f3203435623a1eca/attach" } }
~~~
func (*VarlinkInterface) GetContainer ¶
func (s *VarlinkInterface) GetContainer(ctx context.Context, c VarlinkCall, id_ string) error
GetContainer returns information about a single container. If a container with the given id doesn't exist, a ContainerNotFound(#ContainerNotFound) error will be returned. See also ListContainers(ListContainers) and InspectContainer(#InspectContainer).
func (*VarlinkInterface) GetContainerLogs ¶
func (s *VarlinkInterface) GetContainerLogs(ctx context.Context, c VarlinkCall, name_ string) error
GetContainerLogs takes a name or ID of a container and returns the logs of that container. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. The container logs are returned as an array of strings. GetContainerLogs will honor the streaming capability of varlink if the client invokes it.
func (*VarlinkInterface) GetContainerStats ¶
func (s *VarlinkInterface) GetContainerStats(ctx context.Context, c VarlinkCall, name_ string) error
GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which contains attributes like memory and cpu usage. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. If the container is not running, a NoContainerRunning(#NoContainerRunning) error will be returned #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.GetContainerStats '{"name": "c33e4164f384"}'
{ "container": { "block_input": 0, "block_output": 0, "cpu": 2.571123918839990154678e-08, "cpu_nano": 49037378, "id": "c33e4164f384aa9d979072a63319d66b74fd7a128be71fa68ede24f33ec6cfee", "mem_limit": 33080606720, "mem_perc": 2.166828456524753747370e-03, "mem_usage": 716800, "name": "competent_wozniak", "net_input": 768, "net_output": 5910, "pids": 1, "system_nano": 10000000 } }
~~~
func (*VarlinkInterface) GetContainerStatsWithHistory ¶
func (s *VarlinkInterface) GetContainerStatsWithHistory(ctx context.Context, c VarlinkCall, previousStats_ ContainerStats) error
GetContainerStatsWithHistory takes a previous set of container statistics and uses libpod functions to calculate the containers statistics based on current and previous measurements.
func (*VarlinkInterface) GetContainersByContext ¶
func (s *VarlinkInterface) GetContainersByContext(ctx context.Context, c VarlinkCall, all_ bool, latest_ bool, args_ []string) error
GetContainersByContext allows you to get a list of container ids depending on all, latest, or a list of container names. The definition of latest container means the latest by creation date. In a multi- user environment, results might differ from what you expect.
func (*VarlinkInterface) GetContainersByStatus ¶
func (s *VarlinkInterface) GetContainersByStatus(ctx context.Context, c VarlinkCall, status_ []string) error
func (*VarlinkInterface) GetContainersLogs ¶
func (*VarlinkInterface) GetEvents ¶
func (s *VarlinkInterface) GetEvents(ctx context.Context, c VarlinkCall, filter_ []string, since_ string, until_ string) error
GetEvents returns known libpod events filtered by the options provided.
func (*VarlinkInterface) GetImage ¶
func (s *VarlinkInterface) GetImage(ctx context.Context, c VarlinkCall, id_ string) error
GetImage returns information about a single image in storage. If the image caGetImage returns be found, ImageNotFound(#ImageNotFound) will be returned.
func (*VarlinkInterface) GetInfo ¶
func (s *VarlinkInterface) GetInfo(ctx context.Context, c VarlinkCall) error
GetInfo returns a PodmanInfo(#PodmanInfo) struct that describes podman and its host such as storage stats, build information of Podman, and system-wide registries.
func (*VarlinkInterface) GetLayersMapWithImageInfo ¶
func (s *VarlinkInterface) GetLayersMapWithImageInfo(ctx context.Context, c VarlinkCall) error
GetLayersMapWithImageInfo is for the development of Podman and should not be used.
func (*VarlinkInterface) GetPod ¶
func (s *VarlinkInterface) GetPod(ctx context.Context, c VarlinkCall, name_ string) error
GetPod takes a name or ID of a pod and returns single ListPodData(#ListPodData) structure. A PodNotFound(#PodNotFound) error will be returned if the pod cannot be found. See also ListPods(ListPods). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.GetPod '{"name": "foobar"}'
{ "pod": { "cgroup": "machine.slice", "containersinfo": [ { "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", "name": "1840835294cf-infra", "status": "running" }, { "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", "name": "upbeat_murdock", "status": "running" } ], "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", "name": "foobar", "numberofcontainers": "2", "status": "Running" } }
~~~
func (*VarlinkInterface) GetPodStats ¶
func (s *VarlinkInterface) GetPodStats(ctx context.Context, c VarlinkCall, name_ string) error
GetPodStats takes the name or ID of a pod and returns a pod name and slice of ContainerStats structure which contains attributes like memory and cpu usage. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. If the pod has no running containers associated with it, a NoContainerRunning(#NoContainerRunning) error will be returned. #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.GetPodStats '{"name": "7f62b508b6f12b11d8fe02e"}'
{ "containers": [ { "block_input": 0, "block_output": 0, "cpu": 2.833470544016107524276e-08, "cpu_nano": 54363072, "id": "a64b51f805121fe2c5a3dc5112eb61d6ed139e3d1c99110360d08b58d48e4a93", "mem_limit": 12276146176, "mem_perc": 7.974359265237864966003e-03, "mem_usage": 978944, "name": "quirky_heisenberg", "net_input": 866, "net_output": 7388, "pids": 1, "system_nano": 20000000 } ], "pod": "7f62b508b6f12b11d8fe02e0db4de6b9e43a7d7699b33a4fc0d574f6e82b4ebd" }
~~~
func (*VarlinkInterface) GetPodsByContext ¶
func (s *VarlinkInterface) GetPodsByContext(ctx context.Context, c VarlinkCall, all_ bool, latest_ bool, args_ []string) error
GetPodsByContext allows you to get a list pod ids depending on all, latest, or a list of pod names. The definition of latest pod means the latest by creation date. In a multi- user environment, results might differ from what you expect.
func (*VarlinkInterface) GetPodsByStatus ¶
func (s *VarlinkInterface) GetPodsByStatus(ctx context.Context, c VarlinkCall, statuses_ []string) error
GetPodsByStatus searches for pods whose status is included in statuses
func (*VarlinkInterface) GetVersion ¶
func (s *VarlinkInterface) GetVersion(ctx context.Context, c VarlinkCall) error
GetVersion returns version and build information of the podman service
func (*VarlinkInterface) GetVolumes ¶
func (s *VarlinkInterface) GetVolumes(ctx context.Context, c VarlinkCall, args_ []string, all_ bool) error
GetVolumes gets slice of the volumes on a remote host
func (*VarlinkInterface) HealthCheckRun ¶
func (s *VarlinkInterface) HealthCheckRun(ctx context.Context, c VarlinkCall, nameOrID_ string) error
HealthCheckRun executes defined container's healthcheck command and returns the container's health status.
func (*VarlinkInterface) HistoryImage ¶
func (s *VarlinkInterface) HistoryImage(ctx context.Context, c VarlinkCall, name_ string) error
HistoryImage takes the name or ID of an image and returns information about its history and layers. The returned history is in the form of an array of ImageHistory structures. If the image cannot be found, an ImageNotFound(#ImageNotFound) error is returned.
func (*VarlinkInterface) ImageExists ¶
func (s *VarlinkInterface) ImageExists(ctx context.Context, c VarlinkCall, name_ string) error
ImageExists talks a full or partial image ID or name and returns an int as to whether the image exists in local storage. An int result of 0 means the image does exist in local storage; whereas 1 indicates the image does not exists in local storage. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ImageExists '{"name": "imageddoesntexist"}'
{ "exists": 1 }
~~~
func (*VarlinkInterface) ImageSave ¶
func (s *VarlinkInterface) ImageSave(ctx context.Context, c VarlinkCall, options_ ImageSaveOptions) error
ImageSave allows you to save an image from the local image storage to a tarball
func (*VarlinkInterface) ImagesPrune ¶
func (s *VarlinkInterface) ImagesPrune(ctx context.Context, c VarlinkCall, all_ bool) error
ImagesPrune removes all unused images from the local store. Upon successful pruning, the IDs of the removed images are returned.
func (*VarlinkInterface) ImportImage ¶
func (s *VarlinkInterface) ImportImage(ctx context.Context, c VarlinkCall, source_ string, reference_ string, message_ string, changes_ []string, delete_ bool) error
ImportImage imports an image from a source (like tarball) into local storage. The image can have additional descriptions added to it using the message and changes options. See also ExportImage(ExportImage).
func (*VarlinkInterface) InitContainer ¶
func (s *VarlinkInterface) InitContainer(ctx context.Context, c VarlinkCall, name_ string) error
InitContainer initializes the given container. It accepts a container name or ID, and will initialize the container matching that ID if possible, and error if not. Containers can only be initialized when they are in the Created or Exited states. Initialization prepares a container to be started, but does not start the container. It is intended to be used to debug a container's state prior to starting it.
func (*VarlinkInterface) InspectContainer ¶
func (s *VarlinkInterface) InspectContainer(ctx context.Context, c VarlinkCall, name_ string) error
InspectContainer data takes a name or ID of a container returns the inspection data in string format. You can then serialize the string into JSON. A ContainerNotFound(#ContainerNotFound) error will be returned if the container cannot be found. See also InspectImage(#InspectImage).
func (*VarlinkInterface) InspectImage ¶
func (s *VarlinkInterface) InspectImage(ctx context.Context, c VarlinkCall, name_ string) error
InspectImage takes the name or ID of an image and returns a string representation of data associated with the mage. You must serialize the string into JSON to use it further. An ImageNotFound(#ImageNotFound) error will be returned if the image cannot be found.
func (*VarlinkInterface) InspectPod ¶
func (s *VarlinkInterface) InspectPod(ctx context.Context, c VarlinkCall, name_ string) error
InspectPod takes the name or ID of an image and returns a string representation of data associated with the pod. You must serialize the string into JSON to use it further. A PodNotFound(#PodNotFound) error will be returned if the pod cannot be found.
func (*VarlinkInterface) KillContainer ¶
func (s *VarlinkInterface) KillContainer(ctx context.Context, c VarlinkCall, name_ string, signal_ int64) error
KillContainer takes the name or ID of a container as well as a signal to be applied to the container. Once the container has been killed, the container's ID is returned. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error is returned. See also StopContainer(StopContainer).
func (*VarlinkInterface) KillPod ¶
func (s *VarlinkInterface) KillPod(ctx context.Context, c VarlinkCall, name_ string, signal_ int64) error
KillPod takes the name or ID of a pod as well as a signal to be applied to the pod. If the pod cannot be found, a PodNotFound(#PodNotFound) error is returned. Containers in a pod are killed independently. If there is an error killing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was killed with no errors, the pod ID is returned. See also StopPod(StopPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.KillPod '{"name": "foobar", "signal": 15}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func (*VarlinkInterface) ListContainerChanges ¶
func (s *VarlinkInterface) ListContainerChanges(ctx context.Context, c VarlinkCall, name_ string) error
ListContainerChanges takes a name or ID of a container and returns changes between the container and its base image. It returns a struct of changed, deleted, and added path names.
func (*VarlinkInterface) ListContainerMounts ¶
func (s *VarlinkInterface) ListContainerMounts(ctx context.Context, c VarlinkCall) error
ListContainerMounts gathers all the mounted container mount points and returns them as an array of strings #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.ListContainerMounts
{ "mounts": { "04e4c255269ed2545e7f8bd1395a75f7949c50c223415c00c1d54bfa20f3b3d9": "/var/lib/containers/storage/overlay/a078925828f57e20467ca31cfca8a849210d21ec7e5757332b72b6924f441c17/merged", "1d58c319f9e881a644a5122ff84419dccf6d138f744469281446ab243ef38924": "/var/lib/containers/storage/overlay/948fcf93f8cb932f0f03fd52e3180a58627d547192ffe3b88e0013b98ddcd0d2/merged" } }
~~~
func (*VarlinkInterface) ListContainerProcesses ¶
func (s *VarlinkInterface) ListContainerProcesses(ctx context.Context, c VarlinkCall, name_ string, opts_ []string) error
ListContainerProcesses takes a name or ID of a container and returns the processes running inside the container as array of strings. It will accept an array of string arguments that represent ps options. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ListContainerProcesses '{"name": "135d71b9495f", "opts": []}'
{ "container": [ " UID PID PPID C STIME TTY TIME CMD", " 0 21220 21210 0 09:05 pts/0 00:00:00 /bin/sh", " 0 21232 21220 0 09:05 pts/0 00:00:00 top", " 0 21284 21220 0 09:05 pts/0 00:00:00 vi /etc/hosts" ] }
~~~
func (*VarlinkInterface) ListContainers ¶
func (s *VarlinkInterface) ListContainers(ctx context.Context, c VarlinkCall) error
ListContainers returns information about all containers. See also GetContainer(#GetContainer).
func (*VarlinkInterface) ListImages ¶
func (s *VarlinkInterface) ListImages(ctx context.Context, c VarlinkCall) error
ListImages returns information about the images that are currently in storage. See also InspectImage(#InspectImage).
func (*VarlinkInterface) ListPods ¶
func (s *VarlinkInterface) ListPods(ctx context.Context, c VarlinkCall) error
ListPods returns a list of pods in no particular order. They are returned as an array of ListPodData structs. See also GetPod(#GetPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.ListPods
{ "pods": [ { "cgroup": "machine.slice", "containersinfo": [ { "id": "00c130a45de0411f109f1a0cfea2e298df71db20fa939de5cab8b2160a36be45", "name": "1840835294cf-infra", "status": "running" }, { "id": "49a5cce72093a5ca47c6de86f10ad7bb36391e2d89cef765f807e460865a0ec6", "name": "upbeat_murdock", "status": "running" } ], "createdat": "2018-12-07 13:10:15.014139258 -0600 CST", "id": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f", "name": "foobar", "numberofcontainers": "2", "status": "Running" }, { "cgroup": "machine.slice", "containersinfo": [ { "id": "1ca4b7bbba14a75ba00072d4b705c77f3df87db0109afaa44d50cb37c04a477e", "name": "784306f655c6-infra", "status": "running" } ], "createdat": "2018-12-07 13:09:57.105112457 -0600 CST", "id": "784306f655c6200aea321dd430ba685e9b2cc1f7d7528a72f3ff74ffb29485a2", "name": "nostalgic_pike", "numberofcontainers": "1", "status": "Running" } ] }
~~~
func (*VarlinkInterface) LoadImage ¶
func (s *VarlinkInterface) LoadImage(ctx context.Context, c VarlinkCall, name_ string, inputFile_ string, quiet_ bool, deleteFile_ bool) error
LoadImage allows you to load an image into local storage from a tarball.
func (*VarlinkInterface) MountContainer ¶
func (s *VarlinkInterface) MountContainer(ctx context.Context, c VarlinkCall, name_ string) error
MountContainer mounts a container by name or full/partial ID. Upon a successful mount, the destination mount is returned as a string. #### Example ~~~
$ varlink call -m unix:/run/podman/io.podman/io.podman.MountContainer '{"name": "jolly_shannon"}'{ "path": "/var/lib/containers/storage/overlay/419eeb04e783ea159149ced67d9fcfc15211084d65e894792a96bedfae0470ca/merged" }
~~~
func (*VarlinkInterface) PauseContainer ¶
func (s *VarlinkInterface) PauseContainer(ctx context.Context, c VarlinkCall, name_ string) error
PauseContainer takes the name or ID of container and pauses it. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. See also UnpauseContainer(#UnpauseContainer).
func (*VarlinkInterface) PausePod ¶
func (s *VarlinkInterface) PausePod(ctx context.Context, c VarlinkCall, name_ string) error
PausePod takes the name or ID of a pod and pauses the running containers associated with it. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are paused independently. If there is an error pausing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was paused with no errors, the pod ID is returned. See also UnpausePod(#UnpausePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.PausePod '{"name": "foobar"}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func (*VarlinkInterface) PodStateData ¶
func (s *VarlinkInterface) PodStateData(ctx context.Context, c VarlinkCall, name_ string) error
PodStateData returns inspectr level information of a given pod in string form. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) Ps ¶
func (s *VarlinkInterface) Ps(ctx context.Context, c VarlinkCall, opts_ PsOpts) error
func (*VarlinkInterface) PullImage ¶
func (s *VarlinkInterface) PullImage(ctx context.Context, c VarlinkCall, name_ string) error
PullImage pulls an image from a repository to local storage. After a successful pull, the image id and logs are returned as a MoreResponse(#MoreResponse). This connection also will handle a WantsMores request to send status as it occurs.
func (*VarlinkInterface) PushImage ¶
func (s *VarlinkInterface) PushImage(ctx context.Context, c VarlinkCall, name_ string, tag_ string, compress_ bool, format_ string, removeSignatures_ bool, signBy_ string) error
PushImage takes two input arguments: the name or ID of an image, the fully-qualified destination name of the image, It will return an ImageNotFound(#ImageNotFound) error if the image cannot be found in local storage; otherwise it will return a MoreResponse(#MoreResponse)
func (*VarlinkInterface) ReceiveFile ¶
func (s *VarlinkInterface) ReceiveFile(ctx context.Context, c VarlinkCall, path_ string, delete_ bool) error
ReceiveFile allows the host to send a remote client a file
func (*VarlinkInterface) RemoveContainer ¶
func (s *VarlinkInterface) RemoveContainer(ctx context.Context, c VarlinkCall, name_ string, force_ bool, removeVolumes_ bool) error
RemoveContainer requires the name or ID of a container as well as a boolean that indicates whether a container should be forcefully removed (e.g., by stopping it), and a boolean indicating whether to remove builtin volumes. Upon successful removal of the container, its ID is returned. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned. See also EvictContainer(EvictContainer). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveContainer '{"name": "62f4fd98cb57"}'
{ "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func (*VarlinkInterface) RemoveImage ¶
func (s *VarlinkInterface) RemoveImage(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
RemoveImage takes the name or ID of an image as well as a boolean that determines if containers using that image should be deleted. If the image cannot be found, an ImageNotFound(#ImageNotFound) error will be returned. The ID of the removed image is returned when complete. See also DeleteUnusedImages(DeleteUnusedImages). #### Example ~~~ varlink call -m unix:/run/podman/io.podman/io.podman.RemoveImage '{"name": "registry.fedoraproject.org/fedora", "force": true}'
{ "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" }
~~~
func (*VarlinkInterface) RemovePod ¶
func (s *VarlinkInterface) RemovePod(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
RemovePod takes the name or ID of a pod as well a boolean representing whether a running container in the pod can be stopped and removed. If a pod has containers associated with it, and force is not true, an error will occur. If the pod cannot be found by name or ID, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are removed independently. If there is an error removing any container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was removed with no errors, the pod ID is returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RemovePod '{"name": "62f4fd98cb57", "force": "true"}'
{ "pod": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" }
~~~
func (*VarlinkInterface) RestartContainer ¶
func (s *VarlinkInterface) RestartContainer(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
RestartContainer will restart a running container given a container name or ID and timeout value. The timeout value is the time before a forcible stop is used to stop the container. If the container cannot be found by name or ID, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise, the ID of the container will be returned.
func (*VarlinkInterface) RestartPod ¶
func (s *VarlinkInterface) RestartPod(ctx context.Context, c VarlinkCall, name_ string) error
RestartPod will restart containers in a pod given a pod name or ID. Containers in the pod that are running will be stopped, then all stopped containers will be run. If the pod cannot be found by name or ID, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are restarted independently. If there is an error restarting one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was restarted with no errors, the pod ID is returned. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.RestartPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func (*VarlinkInterface) SearchImages ¶
func (s *VarlinkInterface) SearchImages(ctx context.Context, c VarlinkCall, query_ string, limit_ *int64, filter_ ImageSearchFilter) error
SearchImages searches available registries for images that contain the contents of "query" in their name. If "limit" is given, limits the amount of search results per registry.
func (*VarlinkInterface) SendFile ¶
func (s *VarlinkInterface) SendFile(ctx context.Context, c VarlinkCall, type_ string, length_ int64) error
Sendfile allows a remote client to send a file to the host
func (*VarlinkInterface) Spec ¶
func (s *VarlinkInterface) Spec(ctx context.Context, c VarlinkCall, name_ string) error
Spec returns the oci spec for a container. This call is for development of Podman only and generally should not be used.
func (*VarlinkInterface) StartContainer ¶
func (s *VarlinkInterface) StartContainer(ctx context.Context, c VarlinkCall, name_ string) error
StartContainer starts a created or stopped container. It takes the name or ID of container. It returns the container ID once started. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned. See also CreateContainer(#CreateContainer).
func (*VarlinkInterface) StartPod ¶
func (s *VarlinkInterface) StartPod(ctx context.Context, c VarlinkCall, name_ string) error
StartPod starts containers in a pod. It takes the name or ID of pod. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are started independently. If there is an error starting one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was started with no errors, the pod ID is returned. See also CreatePod(#CreatePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StartPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6", }
~~~
func (*VarlinkInterface) StopContainer ¶
func (s *VarlinkInterface) StopContainer(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
StopContainer stops a container given a timeout. It takes the name or ID of a container as well as a timeout value. The timeout value the time before a forcible stop to the container is applied. It returns the container ID once stopped. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned instead. See also KillContainer(KillContainer). #### Error ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StopContainer '{"name": "135d71b9495f", "timeout": 5}'
{ "container": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func (*VarlinkInterface) StopPod ¶
func (s *VarlinkInterface) StopPod(ctx context.Context, c VarlinkCall, name_ string, timeout_ int64) error
StopPod stops containers in a pod. It takes the name or ID of a pod and a timeout. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned instead. Containers in a pod are stopped independently. If there is an error stopping one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was stopped with no errors, the pod ID is returned. See also KillPod(KillPod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.StopPod '{"name": "135d71b9495f"}'
{ "pod": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" }
~~~
func (*VarlinkInterface) TagImage ¶
func (s *VarlinkInterface) TagImage(ctx context.Context, c VarlinkCall, name_ string, tagged_ string) error
TagImage takes the name or ID of an image in local storage as well as the desired tag name. If the image cannot be found, an ImageNotFound(#ImageNotFound) error will be returned; otherwise, the ID of the image is returned on success.
func (*VarlinkInterface) Top ¶
func (s *VarlinkInterface) Top(ctx context.Context, c VarlinkCall, nameOrID_ string, descriptors_ []string) error
func (*VarlinkInterface) TopPod ¶
func (s *VarlinkInterface) TopPod(ctx context.Context, c VarlinkCall, pod_ string, latest_ bool, descriptors_ []string) error
func (*VarlinkInterface) UnmountContainer ¶
func (s *VarlinkInterface) UnmountContainer(ctx context.Context, c VarlinkCall, name_ string, force_ bool) error
UnmountContainer umounts a container by its name or full/partial container ID. #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnmountContainer '{"name": "jolly_shannon", "force": false}' {} ~~~
func (*VarlinkInterface) UnpauseContainer ¶
func (s *VarlinkInterface) UnpauseContainer(ctx context.Context, c VarlinkCall, name_ string) error
UnpauseContainer takes the name or ID of container and unpauses a paused container. If the container cannot be found, a ContainerNotFound(#ContainerNotFound) error will be returned; otherwise the ID of the container is returned. See also PauseContainer(#PauseContainer).
func (*VarlinkInterface) UnpausePod ¶
func (s *VarlinkInterface) UnpausePod(ctx context.Context, c VarlinkCall, name_ string) error
UnpausePod takes the name or ID of a pod and unpauses the paused containers associated with it. If the pod cannot be found, a PodNotFound(#PodNotFound) error will be returned. Containers in a pod are unpaused independently. If there is an error unpausing one container, the ID of those containers will be returned in a list, along with the ID of the pod in a PodContainerError(#PodContainerError). If the pod was unpaused with no errors, the pod ID is returned. See also PausePod(#PausePod). #### Example ~~~ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnpausePod '{"name": "foobar"}'
{ "pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f" }
~~~
func (*VarlinkInterface) VarlinkDispatch ¶
func (*VarlinkInterface) VarlinkGetDescription ¶
func (s *VarlinkInterface) VarlinkGetDescription() string
func (*VarlinkInterface) VarlinkGetName ¶
func (s *VarlinkInterface) VarlinkGetName() string
func (*VarlinkInterface) VolumeCreate ¶
func (s *VarlinkInterface) VolumeCreate(ctx context.Context, c VarlinkCall, options_ VolumeCreateOpts) error
VolumeCreate creates a volume on a remote host
func (*VarlinkInterface) VolumeRemove ¶
func (s *VarlinkInterface) VolumeRemove(ctx context.Context, c VarlinkCall, options_ VolumeRemoveOpts) error
VolumeRemove removes a volume on a remote host
func (*VarlinkInterface) VolumesPrune ¶
func (s *VarlinkInterface) VolumesPrune(ctx context.Context, c VarlinkCall) error
VolumesPrune removes unused volumes on the host
func (*VarlinkInterface) WaitContainer ¶
func (s *VarlinkInterface) WaitContainer(ctx context.Context, c VarlinkCall, name_ string, interval_ int64) error
WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID or name, a ContainerNotFound(#ContainerNotFound) error is returned.
type VolumeCreateOpts ¶
type VolumeCreate_methods ¶
type VolumeCreate_methods struct{}
VolumeCreate creates a volume on a remote host
func VolumeCreate ¶
func VolumeCreate() VolumeCreate_methods
func (VolumeCreate_methods) Call ¶
func (m VolumeCreate_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ VolumeCreateOpts) (volumeName_out_ string, err_ error)
func (VolumeCreate_methods) Send ¶
func (m VolumeCreate_methods) Send(ctx context.Context, c *varlink.Connection, flags uint64, options_in_ VolumeCreateOpts) (func(ctx context.Context) (string, uint64, error), error)
type VolumeNotFound ¶
VolumeNotFound means the volume could not be found by the name or ID in local storage.
func (VolumeNotFound) Error ¶
func (e VolumeNotFound) Error() string
type VolumeRemoveOpts ¶
type VolumeRemove_methods ¶
type VolumeRemove_methods struct{}
VolumeRemove removes a volume on a remote host
func VolumeRemove ¶
func VolumeRemove() VolumeRemove_methods
func (VolumeRemove_methods) Call ¶
func (m VolumeRemove_methods) Call(ctx context.Context, c *varlink.Connection, options_in_ VolumeRemoveOpts) (successes_out_ []string, failures_out_ map[string]string, err_ error)
type VolumesPrune_methods ¶
type VolumesPrune_methods struct{}
VolumesPrune removes unused volumes on the host
func VolumesPrune ¶
func VolumesPrune() VolumesPrune_methods
func (VolumesPrune_methods) Call ¶
func (m VolumesPrune_methods) Call(ctx context.Context, c *varlink.Connection) (prunedNames_out_ []string, prunedErrors_out_ []string, err_ error)
type WaitContainer_methods ¶
type WaitContainer_methods struct{}
WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID or name, a ContainerNotFound(#ContainerNotFound) error is returned.
func WaitContainer ¶
func WaitContainer() WaitContainer_methods
type WantsMoreRequired ¶
type WantsMoreRequired struct {
Reason string `json:"reason"`
}
The Podman endpoint requires that you use a streaming connection.
func (WantsMoreRequired) Error ¶
func (e WantsMoreRequired) Error() string