Documentation
¶
Overview ¶
Package checkdocker provides Docker container health checks.
Index ¶
- type DockerChecker
- func (c *DockerChecker) Execute(ctx context.Context, config checkerdef.Config) (*checkerdef.Result, error)
- func (c *DockerChecker) GetSampleConfigs(_ *checkerdef.ListSampleOptions) []checkerdef.CheckSpec
- func (c *DockerChecker) Type() checkerdef.CheckType
- func (c *DockerChecker) Validate(spec *checkerdef.CheckSpec) error
- type DockerConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DockerChecker ¶
type DockerChecker struct{}
DockerChecker implements the Checker interface for Docker container health checks.
func (*DockerChecker) Execute ¶
func (c *DockerChecker) Execute( ctx context.Context, config checkerdef.Config, ) (*checkerdef.Result, error)
Execute performs the Docker container health check and returns the result.
func (*DockerChecker) GetSampleConfigs ¶
func (c *DockerChecker) GetSampleConfigs(_ *checkerdef.ListSampleOptions) []checkerdef.CheckSpec
GetSampleConfigs returns sample Docker check configurations.
func (*DockerChecker) Type ¶
func (c *DockerChecker) Type() checkerdef.CheckType
Type returns the check type identifier.
func (*DockerChecker) Validate ¶
func (c *DockerChecker) Validate(spec *checkerdef.CheckSpec) error
Validate checks if the configuration is valid. Every rule lives in the light `config` sub-package so an offline validator (`sp checks validate`) can run it without linking this checker's execution client.
type DockerConfig ¶
type DockerConfig = checkconfig.DockerConfig
DockerConfig is this check's configuration. It lives in the light `config` sub-package; this alias keeps every existing `checkdocker.DockerConfig` call site compiling.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config holds the docker check's configuration: the struct, its map parsing and serialization, its key constants and the whole offline rule set (ValidateSpec).
|
Package config holds the docker check's configuration: the struct, its map parsing and serialization, its key constants and the whole offline rule set (ValidateSpec). |