kubernetes

Documentation

Index

• func MakeClient(apiConf *APIConfig) (*k8s.Clientset, error)
• type APIConfig
  • func (c *APIConfig) Validate() error
• type AuthType

Functions

func MakeClient

func MakeClient(apiConf *APIConfig) (*k8s.Clientset, error)

MakeClient can take configuration if needed for other types of auth

Types

type APIConfig

type APIConfig struct {
	// How to authenticate to the K8s API server.  This can be one of `none`
	// (for no auth), `tls` (to use manually specified TLS client certs, not
	// recommended), or `serviceAccount` (to use the standard service account
	// token provided to the agent pod).
	AuthType AuthType `yaml:"authType" default:"serviceAccount"`
	// Whether to skip verifying the TLS cert from the API server.  Almost
	// never needed.
	SkipVerify bool `yaml:"skipVerify" default:"false"`
	// The path to the TLS client cert on the pod's filesystem, if using `tls`
	// auth.
	ClientCertPath string `yaml:"clientCertPath"`
	// The path to the TLS client key on the pod's filesystem, if using `tls`
	// auth.
	ClientKeyPath string `yaml:"clientKeyPath"`
	// Path to a CA certificate to use when verifying the API server's TLS
	// cert.  Generally this is provided by K8s alongside the service account
	// token, which will be picked up automatically, so this should rarely be
	// necessary to specify.
	CACertPath string `yaml:"caCertPath"`
}

APIConfig contains options relevant to connecting to the K8s API

func (*APIConfig) Validate

func (c *APIConfig) Validate() error

Validate validates the K8s API config

type AuthType

type AuthType string

AuthType describes the type of authentication to use for the K8s API

const (
	// AuthTypeNone means no auth is required
	AuthTypeNone AuthType = "none"
	// AuthTypeTLS means to use client TLS certs
	AuthTypeTLS AuthType = "tls"
	// AuthTypeServiceAccount means to use the built-in service account that
	// K8s automatically provisions for each pod.
	AuthTypeServiceAccount AuthType = "serviceAccount"
)