Documentation
¶
Index ¶
Constants ¶
const APIVERSION = "1.22"
APIVERSION is the API version supported by swarm manager
const DefaultDockerPort = ":2375"
DefaultDockerPort is the default port to listen on for incoming connections.
Variables ¶
var ( ShouldRefreshOnNodeFilter = false ContainerNameRefreshFilter = "" )
Functions ¶
func NewPrimary ¶ added in v0.3.0
func NewPrimary(cluster cluster.Cluster, tlsConfig *tls.Config, status StatusHandler, debug, enableCors bool) *mux.Router
NewPrimary creates a new API router.
Types ¶
type ContainerSorter ¶
ContainerSorter implements the Sort interface to sort Docker containers. It is not guaranteed to be a stable sort.
func (ContainerSorter) Len ¶
func (s ContainerSorter) Len() int
Len returns the number of containers to be sorted.
func (ContainerSorter) Less ¶
func (s ContainerSorter) Less(i, j int) bool
Less reports whether the container with index i should sort before the container with index j. Containers are sorted chronologically by when they were created.
func (ContainerSorter) Swap ¶
func (s ContainerSorter) Swap(i, j int)
Swap exchanges the container elements with indices i and j.
type ImageSorter ¶ added in v1.1.0
type ImageSorter []types.ImageSummary
ImageSorter implements the Sort interface to sort Docker Images. It is not guaranteed to be a stable sort.
func (ImageSorter) Len ¶ added in v1.1.0
func (s ImageSorter) Len() int
Len returns the number of images to be sorted.
func (ImageSorter) Less ¶ added in v1.1.0
func (s ImageSorter) Less(i, j int) bool
Less reports whether the Image with index i should sort before the Image with index j. Images are sorted chronologically by when they were created.
func (ImageSorter) Swap ¶ added in v1.1.0
func (s ImageSorter) Swap(i, j int)
Swap exchanges the container elements with indices i and j.
type Replica ¶ added in v0.3.0
type Replica struct {
// contains filtered or unexported fields
}
Replica is an API replica that reserves proxy to the primary.
func NewReplica ¶ added in v0.3.0
NewReplica creates a new API replica.
func (*Replica) ServeHTTP ¶ added in v0.3.0
func (p *Replica) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP is the http.Handler.
func (*Replica) SetPrimary ¶ added in v0.3.0
SetPrimary sets the address of the primary Swarm manager
type Server ¶ added in v0.3.0
type Server struct {
// contains filtered or unexported fields
}
Server is a Docker API server.
func (*Server) ListenAndServe ¶ added in v0.3.0
ListenAndServe starts an HTTP server on each host to listen on its TCP or Unix network address and calls Serve on each host's server to handle requests on incoming connections.
The expected format for a host string is [protocol://]address. The protocol must be either "tcp" or "unix", with "tcp" used by default if not specified.
func (*Server) SetHandler ¶ added in v0.3.0
SetHandler is used to overwrite the HTTP handler for the API. This can be the api router or a reverse proxy.
type StatusHandler ¶ added in v0.3.0
type StatusHandler interface { // Info provides key/values to be added to docker info. Status() [][2]string }
StatusHandler allows the API to display extra information on docker info.
type WriteFlusher ¶
A WriteFlusher provides synchronized write access to the writer's underlying data stream and ensures that each write is flushed immediately.
func NewWriteFlusher ¶
func NewWriteFlusher(w io.Writer) *WriteFlusher
NewWriteFlusher creates a new WriteFlusher for the writer.