diff options
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() |