diff options
| author | W. Trevor King <wking@tremily.us> | 2018-07-05 13:25:24 -0700 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-07-06 00:48:39 +0000 |
| commit | 537f021733468d6b3d8490d87a076740cd76add8 (patch) | |
| tree | 02248bf0a58f0e2e6cc069a744ba99128739b7b7 /libpod/runtime_pod.go | |
| parent | cad28cc2d30a2282702ea6f7061b742d1ef94aff (diff) | |
| download | podman-537f021733468d6b3d8490d87a076740cd76add8.tar.gz podman-537f021733468d6b3d8490d87a076740cd76add8.tar.bz2 podman-537f021733468d6b3d8490d87a076740cd76add8.zip | |
libpod/runtime_pod: Make removePod per-platform
b96be3af (changes to allow for darwin compilation, 2018-06-20, #1015)
made RemovePod per-platform, but left out docs for the unsupported
version [1]:
libpod/runtime_pod_unsupported.go:14:1:warning: exported method
Runtime.RemovePod should have comment or be unexported (golint)
To keep the docs DRY, I've restored RemovePod and its docs to their
previous location, and named a new, internal removePod for the
per-platform implementations.
[1]: https://travis-ci.org/projectatomic/libpod/jobs/400555937#L159
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #1034
Approved by: baude
Diffstat (limited to 'libpod/runtime_pod.go')
| -rw-r--r-- | libpod/runtime_pod.go | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/libpod/runtime_pod.go b/libpod/runtime_pod.go index af277c5cc..34925c2d5 100644 --- a/libpod/runtime_pod.go +++ b/libpod/runtime_pod.go @@ -1,5 +1,9 @@ package libpod +import ( + "context" +) + // Contains the public Runtime API for pods // A PodCreateOption is a functional option which alters the Pod created by @@ -11,6 +15,16 @@ type PodCreateOption func(*Pod) error // will include the pod, a false return will exclude it. type PodFilter func(*Pod) bool +// RemovePod removes a pod +// If removeCtrs is specified, containers will be removed +// Otherwise, a pod that is not empty will return an error and not be removed +// If force is specified with removeCtrs, all containers will be stopped before +// being removed +// Otherwise, the pod will not be removed if any containers are running +func (r *Runtime) RemovePod(ctx context.Context, p *Pod, removeCtrs, force bool) error { + return r.removePod(ctx, p, removeCtrs, force) +} + // GetPod retrieves a pod by its ID func (r *Runtime) GetPod(id string) (*Pod, error) { r.lock.RLock() |