Documentation
¶
Index ¶
- type Middleware
- func (Middleware) CaddyModule() caddy.ModuleInfo
- func (m *Middleware) Cleanup() error
- func (m *Middleware) Provision(ctx caddy.Context) error
- func (m Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
- func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
- func (m *Middleware) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Middleware ¶
type Middleware struct {
// Secret is the shared webhook credential. It must match the {secret}
// path segment. Required.
Secret string `json:"secret,omitempty"`
// DockerHosts is the list of Docker Engine API endpoints to consider
// (for example unix:///var/run/docker.sock or tcp://host:2375).
// Defaults to the local Docker socket when omitted.
DockerHosts []string `json:"docker_hosts,omitempty"`
// contains filtered or unexported fields
}
Middleware is an HTTP handler that triggers rolling Docker deployments via a webhook at /webhooks/rolling-deployment/{secret}/{container}/{image}.
Only Docker hosts where the named container is already running are updated. The previous container's configuration (env, labels, mounts, ports, networks, restart policy, and related create options) is preserved. Concurrent deploys of the same container name are rejected.
func (Middleware) CaddyModule ¶
func (Middleware) CaddyModule() caddy.ModuleInfo
CaddyModule returns the Caddy module information.
func (*Middleware) Cleanup ¶
func (m *Middleware) Cleanup() error
Cleanup implements caddy.CleanerUpper, closing all Docker clients.
func (*Middleware) Provision ¶
func (m *Middleware) Provision(ctx caddy.Context) error
Provision implements caddy.Provisioner.
func (Middleware) ServeHTTP ¶
func (m Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
ServeHTTP implements caddyhttp.MiddlewareHandler.
Only /webhooks/rolling-deployment/{secret}/{service_container}/{service_image} is handled here (terminal). All other requests are passed to the next handler.
func (*Middleware) UnmarshalCaddyfile ¶
func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
UnmarshalCaddyfile implements caddyfile.Unmarshaler.
func (*Middleware) Validate ¶
func (m *Middleware) Validate() error
Validate implements caddy.Validator.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package deploy performs rolling container deployments across one or more Docker hosts, using docker.Client instances for the underlying operations.
|
Package deploy performs rolling container deployments across one or more Docker hosts, using docker.Client instances for the underlying operations. |
|
Package docker provides Docker Engine operations used by rolling deployments.
|
Package docker provides Docker Engine operations used by rolling deployments. |