models

Documentation

Overview

Package models implements the HealthProbe struct.

Index

• type HealthProbe
• type HealthProbes
  • func (probes *HealthProbes) UsesTCP() bool
• type Proxy
• type ProxyKind
• type TypeURI
  • func (t TypeURI) String() string

Types

type HealthProbe

type HealthProbe struct {
	Path    string
	Port    int32
	Timeout time.Duration

	// isHTTP corresponds to an httpGet probe with a scheme of HTTP or undefined.
	// This helps inform what kind of Sidecar config to add to the pod.
	IsHTTP bool

	// isTCPSocket indicates if the probe defines a TCPSocketAction.
	IsTCPSocket bool
}

HealthProbe represents a health probe.

type HealthProbes

type HealthProbes struct {
	Liveness, Readiness, Startup *HealthProbe
}

HealthProbes is to serve as an indication of whether the given healthProbe has been rewritten

func (*HealthProbes) UsesTCP

func (probes *HealthProbes) UsesTCP() bool

UsesTCP returns true if any of the configured probes uses a TCP probe.

type Proxy

type Proxy interface {
	GetUUID() uuid.UUID
	GetIdentity() identity.ServiceIdentity
	GetConnectedAt() time.Time
}

Proxy is an interface providing adaptiving proxies of multiple sidecars

type ProxyKind

type ProxyKind string

ProxyKind is the type used to define the proxy's kind

const (
	// KindSidecar implies the proxy is a sidecar
	KindSidecar ProxyKind = "sidecar"
)

type TypeURI

type TypeURI string

TypeURI is a string describing the sidecar xDS payload.

func (TypeURI) String

func (t TypeURI) String() string