diff options
author | baude <bbaude@redhat.com> | 2018-05-09 15:07:05 -0500 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-05-10 14:32:34 +0000 |
commit | a74107b506857b35c0ca9455177c309cd440a5aa (patch) | |
tree | ab274053cd90135b6bb198dfc9a286f31523dc58 /API.md | |
parent | 1b562b05c51140e3f69bb6f9f6d9c9b604d707f1 (diff) | |
download | podman-a74107b506857b35c0ca9455177c309cd440a5aa.tar.gz podman-a74107b506857b35c0ca9455177c309cd440a5aa.tar.bz2 podman-a74107b506857b35c0ca9455177c309cd440a5aa.zip |
alphabetize the varlink methods, types, and errors in the docs
We have decided to alphabetize things in the API documentation to help users
find things easier. It also solves an issue where when being made, the API.md doc
would remake itself in a different order resulting in massive diffs in the pull
requests but no new content.
Signed-off-by: baude <bbaude@redhat.com>
Closes: #739
Approved by: baude
Diffstat (limited to 'API.md')
-rwxr-xr-x | API.md | 681 |
1 files changed, 342 insertions, 339 deletions
@@ -1,132 +1,168 @@ +# io.projectatomic.podman +Podman Service Interface and API description. The master version of this document can be found +in the [API.md](https://github.com/projectatomic/libpod/blob/master/API.md) file in the upstream libpod repository. ## Index -[func ListImages() ImageInList](#ListImages) +[func AttachToContainer() NotImplemented](#AttachToContainer) -[func PushImage(name: string, tag: string, tlsverify: bool) string](#PushImage) +[func BuildImage() NotImplemented](#BuildImage) -[func TagImage(name: string, tagged: string) string](#TagImage) +[func CreateContainer() NotImplemented](#CreateContainer) -[func GetContainer(name: string) ListContainerData](#GetContainer) +[func CreateFromContainer() NotImplemented](#CreateFromContainer) -[func CreateContainer() NotImplemented](#CreateContainer) +[func CreateImage() NotImplemented](#CreateImage) -[func GetContainerLogs(name: string) []string](#GetContainerLogs) +[func DeleteStoppedContainers() []string](#DeleteStoppedContainers) -[func KillContainer(name: string, signal: int) string](#KillContainer) +[func DeleteUnusedImages() []string](#DeleteUnusedImages) -[func UnpauseContainer(name: string) string](#UnpauseContainer) +[func ExportContainer(name: string, path: string) string](#ExportContainer) -[func AttachToContainer() NotImplemented](#AttachToContainer) +[func ExportImage(name: string, destination: string, compress: bool) string](#ExportImage) -[func BuildImage() NotImplemented](#BuildImage) +[func GetContainer(name: string) ListContainerData](#GetContainer) -[func RemoveImage(name: string, force: bool) string](#RemoveImage) +[func GetContainerLogs(name: string) []string](#GetContainerLogs) -[func ListContainers() ListContainerData](#ListContainers) +[func GetContainerStats(name: string) ContainerStats](#GetContainerStats) -[func ResizeContainerTty() NotImplemented](#ResizeContainerTty) +[func GetVersion() Version](#GetVersion) -[func UpdateContainer() NotImplemented](#UpdateContainer) +[func HistoryImage(name: string) ImageHistory](#HistoryImage) -[func RenameContainer() NotImplemented](#RenameContainer) +[func ImportImage(source: string, reference: string, message: string, changes: []string) string](#ImportImage) -[func SearchImage(name: string, limit: int) ImageSearch](#SearchImage) +[func InspectContainer(name: string) string](#InspectContainer) -[func StartContainer() NotImplemented](#StartContainer) +[func InspectImage(name: string) string](#InspectImage) -[func StopContainer(name: string, timeout: int) string](#StopContainer) +[func KillContainer(name: string, signal: int) string](#KillContainer) -[func RestartContainer(name: string, timeout: int) string](#RestartContainer) +[func ListContainerChanges(name: string) ContainerChanges](#ListContainerChanges) -[func DeleteUnusedImages() []string](#DeleteUnusedImages) +[func ListContainerProcesses(name: string, opts: []string) []string](#ListContainerProcesses) -[func Ping() StringResponse](#Ping) +[func ListContainers() ListContainerData](#ListContainers) -[func GetVersion() Version](#GetVersion) +[func ListImages() ImageInList](#ListImages) -[func InspectContainer(name: string) string](#InspectContainer) +[func PauseContainer(name: string) string](#PauseContainer) -[func ListContainerChanges(name: string) ContainerChanges](#ListContainerChanges) +[func Ping() StringResponse](#Ping) -[func ExportImage(name: string, destination: string, compress: bool) string](#ExportImage) +[func PullImage(name: string) string](#PullImage) -[func CreateFromContainer() NotImplemented](#CreateFromContainer) +[func PushImage(name: string, tag: string, tlsverify: bool) string](#PushImage) [func RemoveContainer(name: string, force: bool) string](#RemoveContainer) -[func CreateImage() NotImplemented](#CreateImage) +[func RemoveImage(name: string, force: bool) string](#RemoveImage) -[func InspectImage(name: string) string](#InspectImage) +[func RenameContainer() NotImplemented](#RenameContainer) -[func HistoryImage(name: string) ImageHistory](#HistoryImage) +[func ResizeContainerTty() NotImplemented](#ResizeContainerTty) -[func ExportContainer(name: string, path: string) string](#ExportContainer) +[func RestartContainer(name: string, timeout: int) string](#RestartContainer) -[func WaitContainer(name: string) int](#WaitContainer) +[func SearchImage(name: string, limit: int) ImageSearch](#SearchImage) -[func ImportImage(source: string, reference: string, message: string, changes: []string) string](#ImportImage) +[func StartContainer() NotImplemented](#StartContainer) -[func PullImage(name: string) string](#PullImage) +[func StopContainer(name: string, timeout: int) string](#StopContainer) -[func DeleteStoppedContainers() []string](#DeleteStoppedContainers) +[func TagImage(name: string, tagged: string) string](#TagImage) -[func ListContainerProcesses(name: string, opts: []string) []string](#ListContainerProcesses) +[func UnpauseContainer(name: string) string](#UnpauseContainer) -[func GetContainerStats(name: string) ContainerStats](#GetContainerStats) +[func UpdateContainer() NotImplemented](#UpdateContainer) + +[func WaitContainer(name: string) int](#WaitContainer) +[type ContainerChanges](#ContainerChanges) -[func PauseContainer(name: string) string](#PauseContainer) [type ContainerMount](#ContainerMount) -[type ImageHistory](#ImageHistory) +[type ContainerNameSpace](#ContainerNameSpace) -[type ImageSearch](#ImageSearch) +[type ContainerPortMappings](#ContainerPortMappings) -[type StringResponse](#StringResponse) +[type ContainerStats](#ContainerStats) -[type ContainerChanges](#ContainerChanges) +[type ImageHistory](#ImageHistory) [type ImageInList](#ImageInList) +[type ImageSearch](#ImageSearch) + [type ListContainerData](#ListContainerData) -[type ContainerStats](#ContainerStats) +[type NotImplemented](#NotImplemented) -[type ContainerPortMappings](#ContainerPortMappings) +[type StringResponse](#StringResponse) [type Version](#Version) -[type NotImplemented](#NotImplemented) - -[type ContainerNameSpace](#ContainerNameSpace) +[error ContainerNotFound](#ContainerNotFound) [error ErrorOccurred](#ErrorOccurred) -[error RuntimeError](#RuntimeError) - [error ImageNotFound](#ImageNotFound) -[error ContainerNotFound](#ContainerNotFound) +[error RuntimeError](#RuntimeError) ## Methods -### <a name="ListImages"></a>func ListImages +### <a name="AttachToContainer"></a>func AttachToContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ListImages() [ImageInList](#ImageInList)</div> -ListImages returns an array of ImageInList structures which provide basic information about -an image currenly in storage. See also [InspectImage](InspectImage). -### <a name="PushImage"></a>func PushImage +method AttachToContainer() [NotImplemented](#NotImplemented)</div> +This method has not be implemented yet. +### <a name="BuildImage"></a>func BuildImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method PushImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string), tlsverify: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> -PushImage takes three input arguments: the name or ID of an image, the fully-qualified destination name of the image, -and a boolean as to whether tls-verify should be used. It will return an [ImageNotFound](#ImageNotFound) error if -the image cannot be found in local storage; otherwise the ID of the image will be returned on success. -### <a name="TagImage"></a>func TagImage +method BuildImage() [NotImplemented](#NotImplemented)</div> +This function is not implemented yet. +### <a name="CreateContainer"></a>func CreateContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method TagImage(name: [string](https://godoc.org/builtin#string), tagged: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -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. +method CreateContainer() [NotImplemented](#NotImplemented)</div> +This method has not been implemented yet. +### <a name="CreateFromContainer"></a>func CreateFromContainer +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method CreateFromContainer() [NotImplemented](#NotImplemented)</div> +This method is not implemented. +### <a name="CreateImage"></a>func CreateImage +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method CreateImage() [NotImplemented](#NotImplemented)</div> +This function is not implemented yet. +### <a name="DeleteStoppedContainers"></a>func DeleteStoppedContainers +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method DeleteStoppedContainers() [[]string](#[]string)</div> +DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted +container IDs. See also [RemoveContainer](RemoveContainer). +### <a name="DeleteUnusedImages"></a>func DeleteUnusedImages +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method DeleteUnusedImages() [[]string](#[]string)</div> +DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned +in a string array. +### <a name="ExportContainer"></a>func ExportContainer +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method ExportContainer(name: [string](https://godoc.org/builtin#string), path: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +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. +### <a name="ExportImage"></a>func ExportImage +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method ExportImage(name: [string](https://godoc.org/builtin#string), destination: [string](https://godoc.org/builtin#string), compress: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> +ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also +a booleon option to force compression. 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). ### <a name="GetContainer"></a>func GetContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -134,11 +170,6 @@ method GetContainer(name: [string](https://godoc.org/builtin#string)) [ListConta GetContainer takes a name or ID of a container and returns single ListContainerData structure. A [ContainerNotFound](#ContainerNotFound) error will be returned if the container cannot be found. See also [ListContainers](ListContainers) and [InspectContainer](InspectContainer). -### <a name="CreateContainer"></a>func CreateContainer -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method CreateContainer() [NotImplemented](#NotImplemented)</div> -This method has not been implemented yet. ### <a name="GetContainerLogs"></a>func GetContainerLogs <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -147,106 +178,120 @@ GetContainerLogs takes a name or ID of a container and returns the logs of that 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. -### <a name="KillContainer"></a>func KillContainer -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method KillContainer(name: [string](https://godoc.org/builtin#string), signal: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> -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). -### <a name="UnpauseContainer"></a>func UnpauseContainer -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method UnpauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -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). -### <a name="AttachToContainer"></a>func AttachToContainer -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method AttachToContainer() [NotImplemented](#NotImplemented)</div> -This method has not be implemented yet. -### <a name="BuildImage"></a>func BuildImage -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method BuildImage() [NotImplemented](#NotImplemented)</div> -This function is not implemented yet. -### <a name="RemoveImage"></a>func RemoveImage +### <a name="GetContainerStats"></a>func GetContainerStats <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method RemoveImage(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> -RemoveImage takes the name or ID of an image as well as a booleon 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). +method GetContainerStats(name: [string](https://godoc.org/builtin#string)) [ContainerStats](#ContainerStats)</div> +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. #### Example ~~~ -varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.RemoveImage '{"name": "registry.fedoraproject.org/fedora", "force": true}' +$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.GetContainerStats '{"name": "c33e4164f384"}' { - "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" + "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 + } } ~~~ -### <a name="ListContainers"></a>func ListContainers +### <a name="GetVersion"></a>func GetVersion <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ListContainers() [ListContainerData](#ListContainerData)</div> -ListContainers returns a list of containers in no particular order. There are -returned as an array of ListContainerData structs. See also [GetContainer](#GetContainer). -### <a name="ResizeContainerTty"></a>func ResizeContainerTty +method GetVersion() [Version](#Version)</div> +GetVersion returns a Version structure describing the libpod setup on their +system. +### <a name="HistoryImage"></a>func HistoryImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ResizeContainerTty() [NotImplemented](#NotImplemented)</div> -This method has not be implemented yet. -### <a name="UpdateContainer"></a>func UpdateContainer +method HistoryImage(name: [string](https://godoc.org/builtin#string)) [ImageHistory](#ImageHistory)</div> +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. +### <a name="ImportImage"></a>func ImportImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method UpdateContainer() [NotImplemented](#NotImplemented)</div> -This method has not be implemented yet. -### <a name="RenameContainer"></a>func RenameContainer +method ImportImage(source: [string](https://godoc.org/builtin#string), reference: [string](https://godoc.org/builtin#string), message: [string](https://godoc.org/builtin#string), changes: [[]string](#[]string)) [string](https://godoc.org/builtin#string)</div> +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). +### <a name="InspectContainer"></a>func InspectContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method RenameContainer() [NotImplemented](#NotImplemented)</div> -This method has not be implemented yet. -### <a name="SearchImage"></a>func SearchImage +method InspectContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +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). +### <a name="InspectImage"></a>func InspectImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method SearchImage(name: [string](https://godoc.org/builtin#string), limit: [int](https://godoc.org/builtin#int)) [ImageSearch](#ImageSearch)</div> -SearchImage takes the string of an image name and a limit of searches from each registries to be returned. SearchImage -will then use a glob-like match to find the image you are searching for. The images are returned in an array of -ImageSearch structures which contain information about the image as well as its fully-qualified name. -### <a name="StartContainer"></a>func StartContainer +method InspectImage(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +InspectImage takes the name or ID of an image and returns a string respresentation 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. +### <a name="KillContainer"></a>func KillContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method StartContainer() [NotImplemented](#NotImplemented)</div> -This method has not be implemented yet. -### <a name="StopContainer"></a>func StopContainer +method KillContainer(name: [string](https://godoc.org/builtin#string), signal: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> +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). +### <a name="ListContainerChanges"></a>func ListContainerChanges <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method StopContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> -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 forceable 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 +method ListContainerChanges(name: [string](https://godoc.org/builtin#string)) [ContainerChanges](#ContainerChanges)</div> +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. If the +container cannot be found, a [ContainerNotFound](#ContainerNotFound) error will be returned. +### <a name="ListContainerProcesses"></a>func ListContainerProcesses +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method ListContainerProcesses(name: [string](https://godoc.org/builtin#string), opts: [[]string](#[]string)) [[]string](#[]string)</div> +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 +arguements that represent ps options. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) +error will be returned. +#### Example ~~~ -$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.StopContainer '{"name": "135d71b9495f", "timeout": 5}' +$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.ListContainerProcesses '{"name": "135d71b9495f", "opts": []}' { - "container": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" + "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" + ] } ~~~ -### <a name="RestartContainer"></a>func RestartContainer +### <a name="ListContainers"></a>func ListContainers <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method RestartContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> -RestartContainer will restart a running container given a container name or ID and timeout value. The timeout -value is the time before a forceable 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. -### <a name="DeleteUnusedImages"></a>func DeleteUnusedImages +method ListContainers() [ListContainerData](#ListContainerData)</div> +ListContainers returns a list of containers in no particular order. There are +returned as an array of ListContainerData structs. See also [GetContainer](#GetContainer). +### <a name="ListImages"></a>func ListImages <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method DeleteUnusedImages() [[]string](#[]string)</div> -DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned -in a string array. +method ListImages() [ImageInList](#ImageInList)</div> +ListImages returns an array of ImageInList structures which provide basic information about +an image currenly in storage. See also [InspectImage](InspectImage). +### <a name="PauseContainer"></a>func PauseContainer +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method PauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +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). ### <a name="Ping"></a>func Ping <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -261,38 +306,26 @@ $ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.Ping } } ~~~ -### <a name="GetVersion"></a>func GetVersion -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method GetVersion() [Version](#Version)</div> -GetVersion returns a Version structure describing the libpod setup on their -system. -### <a name="InspectContainer"></a>func InspectContainer -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method InspectContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -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). -### <a name="ListContainerChanges"></a>func ListContainerChanges -<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> - -method ListContainerChanges(name: [string](https://godoc.org/builtin#string)) [ContainerChanges](#ContainerChanges)</div> -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. If the -container cannot be found, a [ContainerNotFound](#ContainerNotFound) error will be returned. -### <a name="ExportImage"></a>func ExportImage +### <a name="PullImage"></a>func PullImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ExportImage(name: [string](https://godoc.org/builtin#string), destination: [string](https://godoc.org/builtin#string), compress: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> -ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also -a booleon option to force compression. 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). -### <a name="CreateFromContainer"></a>func CreateFromContainer +method PullImage(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +PullImage pulls an image from a repository to local storage. After the pull is successful, the ID of the image +is returned. +#### Example +~~~ +$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.PullImage '{"name": "registry.fedoraproject.org/fedora"}' +{ + "id": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" +} +~~~ +### <a name="PushImage"></a>func PushImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method CreateFromContainer() [NotImplemented](#NotImplemented)</div> -This method is not implemented. +method PushImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string), tlsverify: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> +PushImage takes three input arguments: the name or ID of an image, the fully-qualified destination name of the image, +and a boolean as to whether tls-verify should be used. It will return an [ImageNotFound](#ImageNotFound) error if +the image cannot be found in local storage; otherwise the ID of the image will be returned on success. ### <a name="RemoveContainer"></a>func RemoveContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -307,121 +340,100 @@ $ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.Remo "container": "62f4fd98cb57f529831e8f90610e54bba74bd6f02920ffb485e15376ed365c20" } ~~~ -### <a name="CreateImage"></a>func CreateImage +### <a name="RemoveImage"></a>func RemoveImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method CreateImage() [NotImplemented](#NotImplemented)</div> -This function is not implemented yet. -### <a name="InspectImage"></a>func InspectImage +method RemoveImage(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> +RemoveImage takes the name or ID of an image as well as a booleon 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/io.projectatomic.podman/io.projectatomic.podman.RemoveImage '{"name": "registry.fedoraproject.org/fedora", "force": true}' +{ + "image": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" +} +~~~ +### <a name="RenameContainer"></a>func RenameContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method InspectImage(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -InspectImage takes the name or ID of an image and returns a string respresentation 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. -### <a name="HistoryImage"></a>func HistoryImage +method RenameContainer() [NotImplemented](#NotImplemented)</div> +This method has not be implemented yet. +### <a name="ResizeContainerTty"></a>func ResizeContainerTty <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method HistoryImage(name: [string](https://godoc.org/builtin#string)) [ImageHistory](#ImageHistory)</div> -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. -### <a name="ExportContainer"></a>func ExportContainer +method ResizeContainerTty() [NotImplemented](#NotImplemented)</div> +This method has not be implemented yet. +### <a name="RestartContainer"></a>func RestartContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ExportContainer(name: [string](https://godoc.org/builtin#string), path: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -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. -### <a name="WaitContainer"></a>func WaitContainer +method RestartContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> +RestartContainer will restart a running container given a container name or ID and timeout value. The timeout +value is the time before a forceable 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. +### <a name="SearchImage"></a>func SearchImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method WaitContainer(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> -WaitContainer takes the name of ID of a container and waits 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. -### <a name="ImportImage"></a>func ImportImage +method SearchImage(name: [string](https://godoc.org/builtin#string), limit: [int](https://godoc.org/builtin#int)) [ImageSearch](#ImageSearch)</div> +SearchImage takes the string of an image name and a limit of searches from each registries to be returned. SearchImage +will then use a glob-like match to find the image you are searching for. The images are returned in an array of +ImageSearch structures which contain information about the image as well as its fully-qualified name. +### <a name="StartContainer"></a>func StartContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ImportImage(source: [string](https://godoc.org/builtin#string), reference: [string](https://godoc.org/builtin#string), message: [string](https://godoc.org/builtin#string), changes: [[]string](#[]string)) [string](https://godoc.org/builtin#string)</div> -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). -### <a name="PullImage"></a>func PullImage +method StartContainer() [NotImplemented](#NotImplemented)</div> +This method has not be implemented yet. +### <a name="StopContainer"></a>func StopContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method PullImage(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -PullImage pulls an image from a repository to local storage. After the pull is successful, the ID of the image -is returned. -#### Example +method StopContainer(name: [string](https://godoc.org/builtin#string), timeout: [int](https://godoc.org/builtin#int)) [string](https://godoc.org/builtin#string)</div> +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 forceable 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/io.projectatomic.podman/io.projectatomic.podman.PullImage '{"name": "registry.fedoraproject.org/fedora"}' +$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.podman.StopContainer '{"name": "135d71b9495f", "timeout": 5}' { - "id": "426866d6fa419873f97e5cbd320eeb22778244c1dfffa01c944db3114f55772e" + "container": "135d71b9495f7c3967f536edad57750bfdb569336cd107d8aabab45565ffcfb6" } ~~~ -### <a name="DeleteStoppedContainers"></a>func DeleteStoppedContainers +### <a name="TagImage"></a>func TagImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method DeleteStoppedContainers() [[]string](#[]string)</div> -DeleteStoppedContainers will delete all containers that are not running. It will return a list the deleted -container IDs. See also [RemoveContainer](RemoveContainer). -### <a name="ListContainerProcesses"></a>func ListContainerProcesses +method TagImage(name: [string](https://godoc.org/builtin#string), tagged: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +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. +### <a name="UnpauseContainer"></a>func UnpauseContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method ListContainerProcesses(name: [string](https://godoc.org/builtin#string), opts: [[]string](#[]string)) [[]string](#[]string)</div> -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 -arguements that represent ps options. If the container cannot be found, a [ContainerNotFound](#ContainerNotFound) -error will be returned. -#### Example -~~~ -$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.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" - ] -} -~~~ -### <a name="GetContainerStats"></a>func GetContainerStats +method UnpauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> +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). +### <a name="UpdateContainer"></a>func UpdateContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method GetContainerStats(name: [string](https://godoc.org/builtin#string)) [ContainerStats](#ContainerStats)</div> -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. -#### Example -~~~ -$ varlink call -m unix:/run/io.projectatomic.podman/io.projectatomic.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 - } -} -~~~ -### <a name="PauseContainer"></a>func PauseContainer +method UpdateContainer() [NotImplemented](#NotImplemented)</div> +This method has not be implemented yet. +### <a name="WaitContainer"></a>func WaitContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method PauseContainer(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div> -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). +method WaitContainer(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> +WaitContainer takes the name of ID of a container and waits 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. ## Types +### <a name="ContainerChanges"></a>type ContainerChanges + +ContainerChanges describes the return struct for ListContainerChanges + +changed [[]string](#[]string) + +added [[]string](#[]string) + +deleted [[]string](#[]string) ### <a name="ContainerMount"></a>type ContainerMount ContainerMount describes the struct for mounts in a container @@ -433,49 +445,80 @@ type [string](https://godoc.org/builtin#string) source [string](https://godoc.org/builtin#string) options [[]string](#[]string) -### <a name="ImageHistory"></a>type ImageHistory +### <a name="ContainerNameSpace"></a>type ContainerNameSpace -ImageHistory describes the returned structure from ImageHistory. +ContainerNamespace describes the namespace structure for an existing container -id [string](https://godoc.org/builtin#string) +user [string](https://godoc.org/builtin#string) -created [string](https://godoc.org/builtin#string) +uts [string](https://godoc.org/builtin#string) -createdBy [string](https://godoc.org/builtin#string) +pidns [string](https://godoc.org/builtin#string) -tags [[]string](#[]string) +pid [string](https://godoc.org/builtin#string) -size [int](https://godoc.org/builtin#int) +cgroup [string](https://godoc.org/builtin#string) -comment [string](https://godoc.org/builtin#string) -### <a name="ImageSearch"></a>type ImageSearch +net [string](https://godoc.org/builtin#string) -ImageSearch is the returned structure for SearchImage. It is returned -in arrary form. +mnt [string](https://godoc.org/builtin#string) -description [string](https://godoc.org/builtin#string) +ipc [string](https://godoc.org/builtin#string) +### <a name="ContainerPortMappings"></a>type ContainerPortMappings -is_official [bool](https://godoc.org/builtin#bool) +ContainerPortMappings describes the struct for portmappings in an existing container -is_automated [bool](https://godoc.org/builtin#bool) +host_port [string](https://godoc.org/builtin#string) + +host_ip [string](https://godoc.org/builtin#string) + +protocol [string](https://godoc.org/builtin#string) + +container_port [string](https://godoc.org/builtin#string) +### <a name="ContainerStats"></a>type ContainerStats + +ContainerStats is the return struct for the stats of a container + +id [string](https://godoc.org/builtin#string) name [string](https://godoc.org/builtin#string) -star_count [int](https://godoc.org/builtin#int) -### <a name="StringResponse"></a>type StringResponse +cpu [float](https://golang.org/src/builtin/builtin.go#L58) +cpu_nano [int](https://godoc.org/builtin#int) +system_nano [int](https://godoc.org/builtin#int) -message [string](https://godoc.org/builtin#string) -### <a name="ContainerChanges"></a>type ContainerChanges +mem_usage [int](https://godoc.org/builtin#int) -ContainerChanges describes the return struct for ListContainerChanges +mem_limit [int](https://godoc.org/builtin#int) -changed [[]string](#[]string) +mem_perc [float](https://golang.org/src/builtin/builtin.go#L58) -added [[]string](#[]string) +net_input [int](https://godoc.org/builtin#int) -deleted [[]string](#[]string) +net_output [int](https://godoc.org/builtin#int) + +block_output [int](https://godoc.org/builtin#int) + +block_input [int](https://godoc.org/builtin#int) + +pids [int](https://godoc.org/builtin#int) +### <a name="ImageHistory"></a>type ImageHistory + +ImageHistory describes the returned structure from ImageHistory. + +id [string](https://godoc.org/builtin#string) + +created [string](https://godoc.org/builtin#string) + +createdBy [string](https://godoc.org/builtin#string) + +tags [[]string](#[]string) + +size [int](https://godoc.org/builtin#int) + +comment [string](https://godoc.org/builtin#string) ### <a name="ImageInList"></a>type ImageInList ImageInList describes the structure that is returned in @@ -498,6 +541,20 @@ virtualSize [int](https://godoc.org/builtin#int) containers [int](https://godoc.org/builtin#int) labels [map[string]](#map[string]) +### <a name="ImageSearch"></a>type ImageSearch + +ImageSearch is the returned structure for SearchImage. It is returned +in arrary form. + +description [string](https://godoc.org/builtin#string) + +is_official [bool](https://godoc.org/builtin#bool) + +is_automated [bool](https://godoc.org/builtin#bool) + +name [string](https://godoc.org/builtin#string) + +star_count [int](https://godoc.org/builtin#int) ### <a name="ListContainerData"></a>type ListContainerData ListContainer is the returned struct for an individual container @@ -531,46 +588,16 @@ mounts [ContainerMount](#ContainerMount) containerrunning [bool](https://godoc.org/builtin#bool) namespaces [ContainerNameSpace](#ContainerNameSpace) -### <a name="ContainerStats"></a>type ContainerStats - -ContainerStats is the return struct for the stats of a container - -id [string](https://godoc.org/builtin#string) - -name [string](https://godoc.org/builtin#string) - -cpu [float](https://golang.org/src/builtin/builtin.go#L58) - -cpu_nano [int](https://godoc.org/builtin#int) - -system_nano [int](https://godoc.org/builtin#int) - -mem_usage [int](https://godoc.org/builtin#int) - -mem_limit [int](https://godoc.org/builtin#int) - -mem_perc [float](https://golang.org/src/builtin/builtin.go#L58) - -net_input [int](https://godoc.org/builtin#int) - -net_output [int](https://godoc.org/builtin#int) - -block_output [int](https://godoc.org/builtin#int) - -block_input [int](https://godoc.org/builtin#int) +### <a name="NotImplemented"></a>type NotImplemented -pids [int](https://godoc.org/builtin#int) -### <a name="ContainerPortMappings"></a>type ContainerPortMappings -ContainerPortMappings describes the struct for portmappings in an existing container -host_port [string](https://godoc.org/builtin#string) +comment [string](https://godoc.org/builtin#string) +### <a name="StringResponse"></a>type StringResponse -host_ip [string](https://godoc.org/builtin#string) -protocol [string](https://godoc.org/builtin#string) -container_port [string](https://godoc.org/builtin#string) +message [string](https://godoc.org/builtin#string) ### <a name="Version"></a>type Version Version is the structure returned by GetVersion @@ -584,41 +611,17 @@ git_commit [string](https://godoc.org/builtin#string) built [int](https://godoc.org/builtin#int) os_arch [string](https://godoc.org/builtin#string) -### <a name="NotImplemented"></a>type NotImplemented - - - -comment [string](https://godoc.org/builtin#string) -### <a name="ContainerNameSpace"></a>type ContainerNameSpace - -ContainerNamespace describes the namespace structure for an existing container - -user [string](https://godoc.org/builtin#string) - -uts [string](https://godoc.org/builtin#string) - -pidns [string](https://godoc.org/builtin#string) - -pid [string](https://godoc.org/builtin#string) - -cgroup [string](https://godoc.org/builtin#string) - -net [string](https://godoc.org/builtin#string) - -mnt [string](https://godoc.org/builtin#string) - -ipc [string](https://godoc.org/builtin#string) ## Errors +### <a name="ContainerNotFound"></a>type ContainerNotFound + +ContainerNotFound means the container could not be found by the provided name or ID in local storage. ### <a name="ErrorOccurred"></a>type ErrorOccurred 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. -### <a name="RuntimeError"></a>type RuntimeError - -RuntimeErrors generally means a runtime could not be found or gotten. ### <a name="ImageNotFound"></a>type ImageNotFound ImageNotFound means the image could not be found by the provided name or ID in local storage. -### <a name="ContainerNotFound"></a>type ContainerNotFound +### <a name="RuntimeError"></a>type RuntimeError -ContainerNotFound means the container could not be found by the provided name or ID in local storage. +RuntimeErrors generally means a runtime could not be found or gotten. |