status

Documentation

Index

• Constants
• Variables
• func FormatProberURL(container string) (string, string, string)
• type KubeAppProbers
• type Options
• type Prober
• type PrometheusScrapeConfiguration
• type Server
  • func NewServer(config Options) (*Server, error)
  • func (s *Server) Run(ctx context.Context)

Constants

const (

	// KubeAppProberEnvName is the name of the command line flag for pilot agent to pass app prober config.
	// The json encoded string to pass app HTTP probe information from injector(istioctl or webhook).
	// For example, ISTIO_KUBE_APP_PROBERS='{"/app-health/httpbin/livez":{"httpGet":{"path": "/hello", "port": 8080}}.
	// indicates that httpbin container liveness prober port is 8080 and probing path is /hello.
	// This environment variable should never be set manually.
	KubeAppProberEnvName = "ISTIO_KUBE_APP_PROBERS"
)

Variables

var (
	UpstreamLocalAddressIPv4 = &net.TCPAddr{IP: net.ParseIP("127.0.0.6")}
	UpstreamLocalAddressIPv6 = &net.TCPAddr{IP: net.ParseIP("::6")}
)

var (
	LegacyLocalhostProbeDestination = env.RegisterBoolVar("REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION", false,
		"If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior.")

	ProbeKeepaliveConnections = env.RegisterBoolVar("ENABLE_PROBE_KEEPALIVE_CONNECTIONS", false,
		"If enabled, readiness probes will keep the connection from pilot-agent to the application alive. "+
			"This mirrors older Istio versions' behaviors, but not kubelet's.").Get()
)

var PrometheusScrapingConfig = env.RegisterStringVar("ISTIO_PROMETHEUS_ANNOTATIONS", "", "")

Functions

func FormatProberURL

func FormatProberURL(container string) (string, string, string)

FormatProberURL returns a set of HTTP URLs that pilot agent will serve to take over Kubernetes app probers.

Types

type KubeAppProbers

type KubeAppProbers map[string]*Prober

KubeAppProbers holds the information about a Kubernetes pod prober. It's a map from the prober URL path to the Kubernetes Prober config. For example, "/app-health/hello-world/livez" entry contains liveness prober config for container "hello-world".

type Options

type Options struct {
	// Ip of the pod. Note: this is only applicable for Kubernetes pods and should only be used for
	// the prober.
	PodIP string
	// KubeAppProbers is a json with Kubernetes application prober config encoded.
	KubeAppProbers      string
	NodeType            model.NodeType
	StatusPort          uint16
	AdminPort           uint16
	IPv6                bool
	Probes              []ready.Prober
	EnvoyPrometheusPort int
	Context             context.Context
	FetchDNS            func() *dnsProto.NameTable
	NoEnvoy             bool
	GRPCBootstrap       string
}

Options for the status server.

type Prober

type Prober struct {
	HTTPGet        *apimirror.HTTPGetAction   `json:"httpGet,omitempty"`
	TCPSocket      *apimirror.TCPSocketAction `json:"tcpSocket,omitempty"`
	GRPC           *apimirror.GRPCAction      `json:"grpc,omitempty"`
	TimeoutSeconds int32                      `json:"timeoutSeconds,omitempty"`
}

Prober represents a single container prober

type PrometheusScrapeConfiguration

type PrometheusScrapeConfiguration struct {
	Scrape string `json:"scrape"`
	Path   string `json:"path"`
	Port   string `json:"port"`
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server provides an endpoint for handling status probes.

func NewServer

func NewServer(config Options) (*Server, error)

NewServer creates a new status server.

func (*Server) Run

func (s *Server) Run(ctx context.Context)

Run opens a the status port and begins accepting probes.