supervisor

Documentation

Overview

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

Index

• Constants
• type AuditInternalPaths
  • func (l AuditInternalPaths) Enabled() bool
• type AuditSpec
• type AuditUsernamesAndGroups
  • func (l AuditUsernamesAndGroups) Enabled() bool
• type Config
  • func FromPath(ctx context.Context, path string, setAllowedCiphers ptls.SetAllowedCiphersFunc) (*Config, error)
• type Endpoint
• type Endpoints
• type NamesConfigSpec
• type TLSProtocolSpec
• type TLSSpec

Constants

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

const (
	Enabled  = "enabled"
	Disabled = "disabled"
)

Types

type AuditInternalPaths

type AuditInternalPaths string

func (AuditInternalPaths) Enabled

func (l AuditInternalPaths) Enabled() bool

type AuditSpec

type AuditSpec struct {
	LogInternalPaths      AuditInternalPaths      `json:"logInternalPaths"`
	LogUsernamesAndGroups AuditUsernamesAndGroups `json:"logUsernamesAndGroups"`
}

type AuditUsernamesAndGroups

type AuditUsernamesAndGroups string

func (AuditUsernamesAndGroups) Enabled

func (l AuditUsernamesAndGroups) Enabled() bool

type Config

type Config struct {
	APIGroupSuffix          *string           `json:"apiGroupSuffix,omitempty"`
	Labels                  map[string]string `json:"labels"`
	NamesConfig             NamesConfigSpec   `json:"names"`
	Log                     plog.LogSpec      `json:"log"`
	Endpoints               *Endpoints        `json:"endpoints"`
	AggregatedAPIServerPort *int64            `json:"aggregatedAPIServerPort"`
	TLS                     TLSSpec           `json:"tls"`
	Audit                   AuditSpec         `json:"audit"`
}

Config contains knobs to set up an instance of the Pinniped Supervisor.

func FromPath

func FromPath(ctx context.Context, path string, setAllowedCiphers ptls.SetAllowedCiphersFunc) (*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"`
	APIService                  string `json:"apiService"`
}

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

type TLSProtocolSpec

type TLSProtocolSpec struct {
	// AllowedCiphers will permit Pinniped to use only the listed ciphers.
	// This affects Pinniped both when it acts as a client and as a server.
	// If empty, Pinniped will use a built-in list of ciphers.
	AllowedCiphers []string `json:"allowedCiphers"`
}

type TLSSpec

type TLSSpec struct {
	OneDotTwo TLSProtocolSpec `json:"onedottwo"`
}