internal

Documentation

Index

• Variables
• func BinPathFinder(symbolicName string) (binPath string)
• func DoAPIServerArgDefaulting(args []string) []string
• func DoEtcdArgDefaulting(args []string) []string
• func GetEtcdStartMessage(listenUrl url.URL) string
• func RenderTemplates(argTemplates []string, data interface{}) (args []string, err error)
• type DefaultedProcessInput
  • func DoDefaulting(name string, listenUrl *url.URL, dir string, path string, ...) (DefaultedProcessInput, error)
• type ProcessState
  • func (ps *ProcessState) Start(stdout, stderr io.Writer) (err error)
  • func (ps *ProcessState) Stop() error

Variables

var APIServerDefaultArgs = []string{
	"--etcd-servers={{ if .EtcdURL }}{{ .EtcdURL.String }}{{ end }}",
	"--cert-dir={{ .CertDir }}",
	"--insecure-port={{ if .URL }}{{ .URL.Port }}{{ end }}",
	"--insecure-bind-address={{ if .URL }}{{ .URL.Hostname }}{{ end }}",
	"--secure-port={{ if .SecurePort }}{{ .SecurePort }}{{ end }}",
}

var EtcdDefaultArgs = []string{
	"--listen-peer-urls=http://localhost:0",
	"--advertise-client-urls={{ if .URL }}{{ .URL.String }}{{ end }}",
	"--listen-client-urls={{ if .URL }}{{ .URL.String }}{{ end }}",
	"--data-dir={{ .DataDir }}",
}

Functions

func BinPathFinder

func BinPathFinder(symbolicName string) (binPath string)

BinPathFinder checks the an environment variable, derived from the symbolic name, and falls back to a default assets location when this variable is not set

func DoAPIServerArgDefaulting

func DoAPIServerArgDefaulting(args []string) []string

func DoEtcdArgDefaulting

func DoEtcdArgDefaulting(args []string) []string

func GetEtcdStartMessage

func GetEtcdStartMessage(listenUrl url.URL) string

func RenderTemplates

func RenderTemplates(argTemplates []string, data interface{}) (args []string, err error)

Types

type DefaultedProcessInput

type DefaultedProcessInput struct {
	URL              url.URL
	Dir              string
	DirNeedsCleaning bool
	Path             string
	StopTimeout      time.Duration
	StartTimeout     time.Duration
}

func DoDefaulting

func DoDefaulting(
	name string,
	listenUrl *url.URL,
	dir string,
	path string,
	startTimeout time.Duration,
	stopTimeout time.Duration,
) (DefaultedProcessInput, error)

type ProcessState

type ProcessState struct {
	DefaultedProcessInput
	Session *gexec.Session
	// Healthcheck Endpoint. If we get http.StatusOK from this endpoint, we
	// assume the process is ready to operate. E.g. "/healthz". If this is set,
	// we ignore StartMessage.
	HealthCheckEndpoint string
	// HealthCheckPollInterval is the interval which will be used for polling the
	// HealthCheckEndpoint.
	// If left empty it will default to 100 Milliseconds.
	HealthCheckPollInterval time.Duration
	// StartMessage is the message to wait for on stderr. If we recieve this
	// message, we assume the process is ready to operate. Ignored if
	// HealthCheckEndpoint is specified.
	//
	// The usage of StartMessage is discouraged, favour HealthCheckEndpoint
	// instead!
	//
	// Deprecated: Use HealthCheckEndpoint in favour of StartMessage
	StartMessage string
	Args         []string
	// contains filtered or unexported fields
}

func (*ProcessState) Start

func (ps *ProcessState) Start(stdout, stderr io.Writer) (err error)

func (*ProcessState) Stop

func (ps *ProcessState) Stop() error