config

Documentation

Index

• type Check
• type HTTPGetAction
• type Probe
  • func (p *Probe) UnmarshalYAML(unmarshal func(interface{}) error) error
• type TCPSocketAction
• type Validator
• type Volume

Types

type Check

type Check struct {
	// The check name.
	// +optional
	Name string

	// The check description.
	// +optional
	Description string

	// A probe to run.
	Probe Probe
}

type HTTPGetAction

type HTTPGetAction struct {
	// Path to access on the HTTP server.
	// +optional
	Path string `yaml:"path,omitempty"`
	// Number of the port to access on the container.
	// Number must be in the range 1 to 65535.
	Port int `yaml:"port"`
	// Scheme to use for connecting to the host.
	// Defaults to HTTP.
	// +optional
	Scheme v1.URIScheme `yaml:"scheme,omitempty"`
	// Custom headers to set in the request. HTTP allows repeated headers.
	// +optional
	HTTPHeaders []v1.HTTPHeader `yaml:"httpHeaders,omitempty"`
	// Headers expected in the response. Check will fail if any are missing.
	// +optional
	ResponseHTTPHeaders []v1.HTTPHeader `yaml:"responseHttpHeaders,omitempty"`
}

type Probe

type Probe struct {
	InitialDelaySeconds int `yaml:"initialDelaySeconds"`

	TimeoutSeconds int `yaml:"timeoutSeconds"`

	PeriodSeconds int `yaml:"periodSeconds"`

	SuccessThreshold int `yaml:"successThreshold"`

	FailureThreshold int `yaml:"failureThreshold"`

	TerminationGracePeriodSeconds int `yaml:"terminationGracePeriodSeconds"`

	Exec *v1.ExecAction `yaml:"exec"`

	HTTPGet *HTTPGetAction `yaml:"httpGet"`

	TCPSocket *TCPSocketAction `yaml:"tcpSocket" `
}

func (*Probe) UnmarshalYAML

func (p *Probe) UnmarshalYAML(unmarshal func(interface{}) error) error

type TCPSocketAction

type TCPSocketAction struct {
	// Number or name of the port to access on the container.
	// Number must be in the range 1 to 65535.
	Port int `yaml:"port"`
}

type Validator

type Validator struct {
	// The validator name.
	// +optional
	Name string

	// The validator description.
	// +optional
	Description string

	// A link to the documentation where the requirements are defined.
	// +optional
	Documentation string

	// A list of checks to perform validation against.
	Checks []Check

	// A list of environment variables to set on the container before starting.
	Env []v1.EnvVar

	// A list of ports to expose on the container.
	Ports []v1.ServicePort

	// A list of volumes to mount on the container.
	Volumes []Volume

	// A command to run in the container
	// +optional
	Command []string

	// Additional flags to pass to the docker CLI.
	// +optional
	DockerRunOptions []string `yaml:"dockerRunOptions"`
}

Validator contains validator specification

type Volume

type Volume struct {
	// Path to mount in the container
	MountPath string `yaml:"mountPath,omitempty"`

	// Path to mount from host, will use empty volume if omitted
	// +optional
	Path string `yaml:"path,omitempty"`
}