impersonator

Documentation

Index

• Constants
• func New(port int, dynamicCertProvider dynamiccert.Private, ...) (func(stopCh <-chan struct{}) error, error)
• type Config
  • func ConfigFromConfigMap(configMap *v1.ConfigMap) (*Config, error)
  • func NewConfig() *Config
  • func (c *Config) HasEndpoint() bool
• type FactoryFunc
• type Mode

Constants

const (
	ConfigMapDataKey = "config.yaml"
)

Functions

func New

func New(
	port int,
	dynamicCertProvider dynamiccert.Private,
	impersonationProxySignerCA dynamiccert.Public,
) (func(stopCh <-chan struct{}) error, error)

Types

type Config

type Config struct {
	// Enable or disable the impersonation proxy. Optional. Defaults to ModeAuto.
	Mode Mode `json:"mode,omitempty"`

	// Used when creating TLS certificates and for clients to discover the endpoint. Optional. When not specified, if the
	// impersonation proxy is started, then it will automatically create a LoadBalancer Service and use its ingress as the
	// endpoint.
	//
	// When specified, it may be a hostname or IP address, optionally with a port number, of the impersonation proxy
	// for clients to use from outside the cluster. E.g. myhost.mycompany.com:8443. Clients should assume that they should
	// connect via HTTPS to this service.
	Endpoint string `json:"endpoint,omitempty"`
}

func ConfigFromConfigMap

func ConfigFromConfigMap(configMap *v1.ConfigMap) (*Config, error)

func NewConfig

func NewConfig() *Config

func (*Config) HasEndpoint

func (c *Config) HasEndpoint() bool

type FactoryFunc

type FactoryFunc func(
	port int,
	dynamicCertProvider dynamiccert.Private,
	impersonationProxySignerCA dynamiccert.Public,
) (func(stopCh <-chan struct{}) error, error)

FactoryFunc is a function which can create an impersonator server. It returns a function which will start the impersonator server. That start function takes a stopCh which can be used to stop the server. Once a server has been stopped, don't start it again using the start function. Instead, call the factory function again to get a new start function.

type Mode

type Mode string

const (
	// Explicitly enable the impersonation proxy.
	ModeEnabled Mode = "enabled"

	// Explicitly disable the impersonation proxy.
	ModeDisabled Mode = "disabled"

	// Allow the proxy to decide if it should be enabled or disabled based upon the cluster in which it is running.
	ModeAuto Mode = "auto"
)