compat

Documentation

Index

• Constants
• func Archive(w http.ResponseWriter, r *http.Request)
• func AttachContainer(w http.ResponseWriter, r *http.Request)
• func Auth(w http.ResponseWriter, r *http.Request)
• func BuildImage(w http.ResponseWriter, r *http.Request)
• func Changes(w http.ResponseWriter, r *http.Request)
• func CommitContainer(w http.ResponseWriter, r *http.Request)
• func Connect(w http.ResponseWriter, r *http.Request)
• func CreateContainer(w http.ResponseWriter, r *http.Request)
• func CreateImageFromImage(w http.ResponseWriter, r *http.Request)
• func CreateImageFromSrc(w http.ResponseWriter, r *http.Request)
• func CreateNetwork(w http.ResponseWriter, r *http.Request)
• func CreateSecret(w http.ResponseWriter, r *http.Request)
• func CreateVolume(w http.ResponseWriter, r *http.Request)
• func Disconnect(w http.ResponseWriter, r *http.Request)
• func ExecCreateHandler(w http.ResponseWriter, r *http.Request)
• func ExecInspectHandler(w http.ResponseWriter, r *http.Request)
• func ExecStartHandler(w http.ResponseWriter, r *http.Request)
• func ExportContainer(w http.ResponseWriter, r *http.Request)
• func ExportImage(w http.ResponseWriter, r *http.Request)
• func ExportImages(w http.ResponseWriter, r *http.Request)
• func GetContainer(w http.ResponseWriter, r *http.Request)
• func GetDiskUsage(w http.ResponseWriter, r *http.Request)
• func GetEvents(w http.ResponseWriter, r *http.Request)
• func GetImage(w http.ResponseWriter, r *http.Request)
• func GetImages(w http.ResponseWriter, r *http.Request)
• func GetInfo(w http.ResponseWriter, r *http.Request)
• func HistoryImage(w http.ResponseWriter, r *http.Request)
• func InspectNetwork(w http.ResponseWriter, r *http.Request)
• func InspectSecret(w http.ResponseWriter, r *http.Request)
• func InspectVolume(w http.ResponseWriter, r *http.Request)
• func KillContainer(w http.ResponseWriter, r *http.Request)
• func LibpodToContainer(l *libpod.Container, sz bool) (*handlers.Container, error)
• func LibpodToContainerJSON(l *libpod.Container, sz bool) (*types.ContainerJSON, error)
• func ListContainers(w http.ResponseWriter, r *http.Request)
• func ListNetworks(w http.ResponseWriter, r *http.Request)
• func ListSecrets(w http.ResponseWriter, r *http.Request)
• func ListVolumes(w http.ResponseWriter, r *http.Request)
• func LoadImages(w http.ResponseWriter, r *http.Request)
• func LogsFromContainer(w http.ResponseWriter, r *http.Request)
• func PauseContainer(w http.ResponseWriter, r *http.Request)
• func Ping(w http.ResponseWriter, r *http.Request)
• func Prune(w http.ResponseWriter, r *http.Request)
• func PruneContainers(w http.ResponseWriter, r *http.Request)
• func PruneContainersHelper(r *http.Request, filterFuncs []libpod.ContainerFilter) ([]*reports.PruneReport, error)
• func PruneImages(w http.ResponseWriter, r *http.Request)
• func PruneVolumes(w http.ResponseWriter, r *http.Request)
• func PushImage(w http.ResponseWriter, r *http.Request)
• func RemoveContainer(w http.ResponseWriter, r *http.Request)
• func RemoveImage(w http.ResponseWriter, r *http.Request)
• func RemoveNetwork(w http.ResponseWriter, r *http.Request)
• func RemoveSecret(w http.ResponseWriter, r *http.Request)
• func RemoveVolume(w http.ResponseWriter, r *http.Request)
• func RenameContainer(w http.ResponseWriter, r *http.Request)
• func ResizeTTY(w http.ResponseWriter, r *http.Request)
• func RestartContainer(w http.ResponseWriter, r *http.Request)
• func SaveFromBody(f *os.File, r *http.Request) error
• func SearchImages(w http.ResponseWriter, r *http.Request)
• func StartContainer(w http.ResponseWriter, r *http.Request)
• func StatsContainer(w http.ResponseWriter, r *http.Request)
• func StopContainer(w http.ResponseWriter, r *http.Request)
• func TagImage(w http.ResponseWriter, r *http.Request)
• func TopContainer(w http.ResponseWriter, r *http.Request)
• func UnpauseContainer(w http.ResponseWriter, r *http.Request)
• func UnsupportedHandler(w http.ResponseWriter, r *http.Request)
• func UpdateSecret(w http.ResponseWriter, r *http.Request)
• func VersionHandler(w http.ResponseWriter, r *http.Request)
• func WaitContainer(w http.ResponseWriter, r *http.Request)
• type CPUStats
• type Stats
• type StatsJSON

Constants

const DefaultStatsPeriod = 5 * time.Second

Functions

func Archive

func Archive(w http.ResponseWriter, r *http.Request)

func AttachContainer

func AttachContainer(w http.ResponseWriter, r *http.Request)

func Auth

func Auth(w http.ResponseWriter, r *http.Request)

func BuildImage

func BuildImage(w http.ResponseWriter, r *http.Request)

func Changes

func Changes(w http.ResponseWriter, r *http.Request)

func CommitContainer

func CommitContainer(w http.ResponseWriter, r *http.Request)

func Connect

func Connect(w http.ResponseWriter, r *http.Request)

Connect adds a container to a network

func CreateContainer

func CreateContainer(w http.ResponseWriter, r *http.Request)

func CreateImageFromImage

func CreateImageFromImage(w http.ResponseWriter, r *http.Request)

func CreateImageFromSrc

func CreateImageFromSrc(w http.ResponseWriter, r *http.Request)

func CreateNetwork

func CreateNetwork(w http.ResponseWriter, r *http.Request)

func CreateSecret

func CreateSecret(w http.ResponseWriter, r *http.Request)

func CreateVolume

func CreateVolume(w http.ResponseWriter, r *http.Request)

func Disconnect

func Disconnect(w http.ResponseWriter, r *http.Request)

Disconnect removes a container from a network

func ExecCreateHandler

func ExecCreateHandler(w http.ResponseWriter, r *http.Request)

ExecCreateHandler creates an exec session for a given container.

func ExecInspectHandler

func ExecInspectHandler(w http.ResponseWriter, r *http.Request)

ExecInspectHandler inspects a given exec session.

func ExecStartHandler

func ExecStartHandler(w http.ResponseWriter, r *http.Request)

ExecStartHandler runs a given exec session.

func ExportContainer

func ExportContainer(w http.ResponseWriter, r *http.Request)

func ExportImage

func ExportImage(w http.ResponseWriter, r *http.Request)

func ExportImages

func ExportImages(w http.ResponseWriter, r *http.Request)

func GetContainer

func GetContainer(w http.ResponseWriter, r *http.Request)

func GetDiskUsage

func GetDiskUsage(w http.ResponseWriter, r *http.Request)

func GetEvents

func GetEvents(w http.ResponseWriter, r *http.Request)

GetEvents endpoint serves both the docker-compatible one and the new libpod one

func GetImage

func GetImage(w http.ResponseWriter, r *http.Request)

func GetImages

func GetImages(w http.ResponseWriter, r *http.Request)

func GetInfo

func GetInfo(w http.ResponseWriter, r *http.Request)

func HistoryImage

func HistoryImage(w http.ResponseWriter, r *http.Request)

func InspectNetwork

func InspectNetwork(w http.ResponseWriter, r *http.Request)

func InspectSecret

func InspectSecret(w http.ResponseWriter, r *http.Request)

func InspectVolume

func InspectVolume(w http.ResponseWriter, r *http.Request)

func KillContainer

func KillContainer(w http.ResponseWriter, r *http.Request)

func LibpodToContainer

func LibpodToContainer(l *libpod.Container, sz bool) (*handlers.Container, error)

func LibpodToContainerJSON

func LibpodToContainerJSON(l *libpod.Container, sz bool) (*types.ContainerJSON, error)

func ListContainers

func ListContainers(w http.ResponseWriter, r *http.Request)

func ListNetworks

func ListNetworks(w http.ResponseWriter, r *http.Request)

func ListSecrets

func ListSecrets(w http.ResponseWriter, r *http.Request)

func ListVolumes

func ListVolumes(w http.ResponseWriter, r *http.Request)

func LoadImages

func LoadImages(w http.ResponseWriter, r *http.Request)

func LogsFromContainer

func LogsFromContainer(w http.ResponseWriter, r *http.Request)

func PauseContainer

func PauseContainer(w http.ResponseWriter, r *http.Request)

func Ping

func Ping(w http.ResponseWriter, r *http.Request)

Ping returns headers to client about the service

This handler must always be the same for the compatibility and libpod URL trees! Clients will use the Header availability to test which backend engine is in use. Note: Additionally handler supports GET and HEAD methods

func Prune

func Prune(w http.ResponseWriter, r *http.Request)

Prune removes unused networks

func PruneContainers

func PruneContainers(w http.ResponseWriter, r *http.Request)

func PruneContainersHelper

func PruneContainersHelper(r *http.Request, filterFuncs []libpod.ContainerFilter) ([]*reports.PruneReport, error)

func PruneImages

func PruneImages(w http.ResponseWriter, r *http.Request)

func PruneVolumes

func PruneVolumes(w http.ResponseWriter, r *http.Request)

func PushImage

func PushImage(w http.ResponseWriter, r *http.Request)

PushImage is the handler for the compat http endpoint for pushing images.

func RemoveContainer

func RemoveContainer(w http.ResponseWriter, r *http.Request)

func RemoveImage

func RemoveImage(w http.ResponseWriter, r *http.Request)

func RemoveNetwork

func RemoveNetwork(w http.ResponseWriter, r *http.Request)

func RemoveSecret

func RemoveSecret(w http.ResponseWriter, r *http.Request)

func RemoveVolume

func RemoveVolume(w http.ResponseWriter, r *http.Request)

func RenameContainer

func RenameContainer(w http.ResponseWriter, r *http.Request)

func ResizeTTY

func ResizeTTY(w http.ResponseWriter, r *http.Request)

func RestartContainer

func RestartContainer(w http.ResponseWriter, r *http.Request)

func SaveFromBody

func SaveFromBody(f *os.File, r *http.Request) error

func SearchImages

func SearchImages(w http.ResponseWriter, r *http.Request)

func StartContainer

func StartContainer(w http.ResponseWriter, r *http.Request)

func StatsContainer

func StatsContainer(w http.ResponseWriter, r *http.Request)

func StopContainer

func StopContainer(w http.ResponseWriter, r *http.Request)

func TagImage

func TagImage(w http.ResponseWriter, r *http.Request)

func TopContainer

func TopContainer(w http.ResponseWriter, r *http.Request)

func UnpauseContainer

func UnpauseContainer(w http.ResponseWriter, r *http.Request)

func UnsupportedHandler

func UnsupportedHandler(w http.ResponseWriter, r *http.Request)

func UpdateSecret

func UpdateSecret(w http.ResponseWriter, r *http.Request)

func VersionHandler

func VersionHandler(w http.ResponseWriter, r *http.Request)

func WaitContainer

func WaitContainer(w http.ResponseWriter, r *http.Request)

Types

type CPUStats

type CPUStats struct {
	// CPU Usage. Linux and Windows.
	CPUUsage docker.CPUUsage `json:"cpu_usage"`

	// System Usage. Linux only.
	SystemUsage uint64 `json:"system_cpu_usage,omitempty"`

	// Online CPUs. Linux only.
	OnlineCPUs uint32 `json:"online_cpus,omitempty"`

	// Usage of CPU in %. Linux only.
	CPU float64 `json:"cpu"`

	// Throttling Data. Linux only.
	ThrottlingData docker.ThrottlingData `json:"throttling_data,omitempty"`
}

CPUStats aggregates and wraps all CPU related info of container

type Stats

type Stats struct {
	// Common stats
	Read    time.Time `json:"read"`
	PreRead time.Time `json:"preread"`

	// Linux specific stats, not populated on Windows.
	PidsStats  docker.PidsStats  `json:"pids_stats,omitempty"`
	BlkioStats docker.BlkioStats `json:"blkio_stats,omitempty"`

	// Windows specific stats, not populated on Linux.
	NumProcs     uint32              `json:"num_procs"`
	StorageStats docker.StorageStats `json:"storage_stats,omitempty"`

	// Shared stats
	CPUStats    CPUStats           `json:"cpu_stats,omitempty"`
	PreCPUStats CPUStats           `json:"precpu_stats,omitempty"` // "Pre"="Previous"
	MemoryStats docker.MemoryStats `json:"memory_stats,omitempty"`
}

Stats is Ultimate struct aggregating all types of stats of one container

type StatsJSON

type StatsJSON struct {
	Stats

	Name string `json:"name,omitempty"`
	ID   string `json:"Id,omitempty"`

	// Networks request version >=1.21
	Networks map[string]docker.NetworkStats `json:"networks,omitempty"`
}