supervisor

Documentation

Overview

Package supervisor contains functionality to load/store Config's from/to some source.

Index

• Constants
• type Config
  • func FromPath(ctx context.Context, path string) (*Config, error)
• type Endpoint
• type Endpoints
• type NamesConfigSpec

Constants

const (
	NetworkDisabled = "disabled"
	NetworkUnix     = "unix"
	NetworkTCP      = "tcp"
)

Types

type Config

type Config struct {
	APIGroupSuffix *string           `json:"apiGroupSuffix,omitempty"`
	Labels         map[string]string `json:"labels"`
	NamesConfig    NamesConfigSpec   `json:"names"`
	// Deprecated: use log.level instead
	LogLevel          *plog.LogLevel     `json:"logLevel"`
	Log               plog.LogSpec       `json:"log"`
	Endpoints         *Endpoints         `json:"endpoints"`
	AllowExternalHTTP stringOrBoolAsBool `json:"insecureAcceptExternalUnencryptedHttpRequests"`
}

Config contains knobs to setup an instance of the Pinniped Supervisor.

func FromPath

func FromPath(ctx context.Context, path string) (*Config, error)

FromPath loads an Config from a provided local file path, inserts any defaults (from the Config documentation), and verifies that the config is valid (Config documentation).

type Endpoint

type Endpoint struct {
	Network string `json:"network"`
	Address string `json:"address"`
}

type Endpoints

type Endpoints struct {
	HTTPS *Endpoint `json:"https,omitempty"`
	HTTP  *Endpoint `json:"http,omitempty"`
}

type NamesConfigSpec

type NamesConfigSpec struct {
	DefaultTLSCertificateSecret string `json:"defaultTLSCertificateSecret"`
}

NamesConfigSpec configures the names of some Kubernetes resources for the Supervisor.