server

Documentation

Overview

Package api Provides a container compatible interface. (Experimental)

This documentation describes the HTTP Libpod interface. It is to be considered only as experimental as this point. The endpoints, parameters, inputs, and return values can all change.

Terms Of Service:

Schemes: http, https
Host: podman.io
BasePath: /
Version: 0.0.1
License: Apache-2.0 https://opensource.org/licenses/Apache-2.0
Contact: Podman <podman@lists.podman.io> https://podman.io/community/

InfoExtensions:
x-logo:
  - url: https://raw.githubusercontent.com/containers/libpod/master/logo/podman-logo.png
  - altText: "Podman logo"

Produces:
- application/json
- text/plain
- text/html

Consumes:
- application/json
- application/x-tar

swagger:meta

Index

• Constants
• func ListenUnix(network string, path string) (net.Listener, error)
• func VersionedPath(p string) string
• type APIServer
  • func NewServer(runtime *libpod.Runtime) (*APIServer, error)
  • func NewServerWithSettings(runtime *libpod.Runtime, duration time.Duration, listener *net.Listener) (*APIServer, error)
  • func (s *APIServer) APIHandler(h http.HandlerFunc) http.HandlerFunc
  • func (s *APIServer) Close() error
  • func (s *APIServer) RegisterSwaggerHandlers(r *mux.Router) error
  • func (s *APIServer) Serve() error
  • func (s *APIServer) Shutdown() error

Constants

const (
	DefaultServiceDuration   = 300 * time.Second
	UnlimitedServiceDuration = 0 * time.Second
	EnterHandler             = 1
	ExitHandler              = -1
	NOOPHandler              = 0
)

Number of seconds to wait for next request, if exceeded shutdown server

const DefaultPodmanSwaggerSpec = "/usr/share/containers/podman/swagger.yaml"

DefaultPodmanSwaggerSpec provides the default path to the podman swagger spec file

Functions

func ListenUnix

func ListenUnix(network string, path string) (net.Listener, error)

ListenUnix follows stdlib net.Listen() API, providing a unix listener for given path

ListenUnix will delete and create files/directories as needed

func VersionedPath

func VersionedPath(p string) string

VersionedPath prepends the version parsing code any handler may override this default when registering URL(s)

Types

type APIServer

type APIServer struct {
	http.Server                 // The  HTTP work happens here
	*schema.Decoder             // Decoder for Query parameters to structs
	context.Context             // Context to carry objects to handlers
	*libpod.Runtime             // Where the real work happens
	net.Listener                // mux for routing HTTP API calls to libpod routines
	context.CancelFunc          // Stop APIServer
	*time.Timer                 // Hold timer for sliding window
	time.Duration               // Duration of client access sliding window
	ActiveConnections  uint64   // Number of handlers holding a connection
	TotalConnections   uint64   // Number of connections handled
	ConnectionCh       chan int // Channel for signalling handler enter/exit
}

func NewServer

func NewServer(runtime *libpod.Runtime) (*APIServer, error)

NewServer will create and configure a new API server with all defaults

func NewServerWithSettings

func NewServerWithSettings(runtime *libpod.Runtime, duration time.Duration, listener *net.Listener) (*APIServer, error)

NewServerWithSettings will create and configure a new API server using provided settings

func (*APIServer) APIHandler

func (s *APIServer) APIHandler(h http.HandlerFunc) http.HandlerFunc

APIHandler is a wrapper to enhance HandlerFunc's and remove redundant code

func (*APIServer) Close

func (s *APIServer) Close() error

Close immediately stops responding to clients and exits

func (*APIServer) RegisterSwaggerHandlers

func (s *APIServer) RegisterSwaggerHandlers(r *mux.Router) error

RegisterSwaggerHandlers maps the swagger endpoint for the server

func (*APIServer) Serve

func (s *APIServer) Serve() error

Serve starts responding to HTTP requests

func (*APIServer) Shutdown

func (s *APIServer) Shutdown() error

Shutdown is a clean shutdown waiting on existing clients