mirror of
https://github.com/containers/podman
synced 2024-10-21 17:53:44 +00:00
018d2c6b1d
Add a mutable state to pods, and database backend sutable for modifying and updating said state. Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #784 Approved by: rhatdan
76 lines
3.1 KiB
Go
76 lines
3.1 KiB
Go
package libpod
|
|
|
|
// State is a storage backend for libpod's current state
|
|
type State interface {
|
|
// Close performs any pre-exit cleanup (e.g. closing database
|
|
// connections) that may be required
|
|
Close() error
|
|
|
|
// Refresh clears container and pod states after a reboot
|
|
Refresh() error
|
|
|
|
// Return a container from the database from its full ID
|
|
Container(id string) (*Container, error)
|
|
// Return a container from the database by full or partial ID or full
|
|
// name
|
|
LookupContainer(idOrName string) (*Container, error)
|
|
// Check if a container with the given full ID exists in the database
|
|
HasContainer(id string) (bool, error)
|
|
// Adds container to state
|
|
// The container cannot be part of a pod
|
|
// The container must have globally unique name and ID - pod names and
|
|
// IDs also conflict with container names and IDs
|
|
AddContainer(ctr *Container) error
|
|
// Removes container from state
|
|
// Containers that are part of pods must use RemoveContainerFromPod
|
|
RemoveContainer(ctr *Container) error
|
|
// UpdateContainer updates a container's state from the backing store
|
|
UpdateContainer(ctr *Container) error
|
|
// SaveContainer saves a container's current state to the backing store
|
|
SaveContainer(ctr *Container) error
|
|
// ContainerInUse checks if other containers depend upon a given
|
|
// container
|
|
// It returns a slice of the IDs of containers which depend on the given
|
|
// container. If the slice is empty, no container depend on the given
|
|
// container.
|
|
// A container cannot be removed if other containers depend on it
|
|
ContainerInUse(ctr *Container) ([]string, error)
|
|
// Retrieves all containers presently in state
|
|
AllContainers() ([]*Container, error)
|
|
|
|
// Accepts full ID of pod
|
|
Pod(id string) (*Pod, error)
|
|
// Accepts full or partial IDs (as long as they are unique) and names
|
|
LookupPod(idOrName string) (*Pod, error)
|
|
// Checks if a pod with the given ID is present in the state
|
|
HasPod(id string) (bool, error)
|
|
// Check if a pod has a container with the given ID
|
|
PodHasContainer(pod *Pod, ctrID string) (bool, error)
|
|
// Get the IDs of all containers in a pod
|
|
PodContainersByID(pod *Pod) ([]string, error)
|
|
// Get all the containers in a pod
|
|
PodContainers(pod *Pod) ([]*Container, error)
|
|
// Adds pod to state
|
|
AddPod(pod *Pod) error
|
|
// Removes pod from state
|
|
// Only empty pods can be removed from the state
|
|
RemovePod(pod *Pod) error
|
|
// Remove all containers from a pod
|
|
// Used to simulataneously remove containers that might otherwise have
|
|
// dependency issues
|
|
// Will fail if a dependency outside the pod is encountered
|
|
RemovePodContainers(pod *Pod) error
|
|
// AddContainerToPod adds a container to an existing pod
|
|
// The container given will be added to the state and the pod
|
|
AddContainerToPod(pod *Pod, ctr *Container) error
|
|
// RemoveContainerFromPod removes a container from an existing pod
|
|
// The container will also be removed from the state
|
|
RemoveContainerFromPod(pod *Pod, ctr *Container) error
|
|
// UpdatePod updates a pod's state from the database
|
|
UpdatePod(pod *Pod) error
|
|
// SavePod saves a pod's state to the database
|
|
SavePod(pod *Pod) error
|
|
// Retrieves all pods presently in state
|
|
AllPods() ([]*Pod, error)
|
|
}
|