probehttp

Documentation

Overview

package probehttp is vendored from k8s.io/kubernetes/pkg/probe and k8s.io/kubernetes/pkg/probe/http

Index

• type HTTPGetInterface
• type HTTPProber
  • func New() HTTPProber
  • func NewWithTLSConfig(config *tls.Config) HTTPProber
• type Result
  • func DoHTTPProbe(url *url.URL, headers http.Header, client HTTPGetInterface) (Result, string, error)

Types

type HTTPGetInterface

type HTTPGetInterface interface {
	Do(req *http.Request) (*http.Response, error)
}

type HTTPProber

type HTTPProber interface {
	Probe(url *url.URL, headers http.Header, timeout time.Duration) (Result, string, error)
}

func New

func New() HTTPProber

func NewWithTLSConfig

func NewWithTLSConfig(config *tls.Config) HTTPProber

NewWithTLSConfig takes tls config as parameter.

type Result

type Result string

const (
	Success Result = "success"
	Failure Result = "failure"
	Unknown Result = "unknown"
)

func DoHTTPProbe

func DoHTTPProbe(url *url.URL, headers http.Header, client HTTPGetInterface) (Result, string, error)

DoHTTPProbe checks if a GET request to the url succeeds. If the HTTP response code is successful (i.e. 400 > code >= 200), it returns Success. If the HTTP response code is unsuccessful or HTTP communication fails, it returns Failure. This is exported because some other packages may want to do direct HTTP probes.