kubernetes

Documentation

Index

• type Config
  • func NewConfig() *Config
  • func NewConfigFromPath(kubeConfigFilePath string) *Config
  • func (c *Config) GetRestClientConfig() (*rest.Config, error)
  • func (c *Config) Modify(options *ConfigOptions) error
• type ConfigOptions
• type Kubernetes
  • func New(config *Config) (*Kubernetes, error)
  • func (k *Kubernetes) DiscoveryClient() (*discovery.DiscoveryClient, error)
  • func (k *Kubernetes) GetClientset() (*kubernetes.Clientset, error)
  • func (k *Kubernetes) GetConfig() *Config
  • func (k *Kubernetes) Version() (string, error)

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config effectivly represents a kubeconfig file configuration allowing for creating or modifying the values in that file

func NewConfig

func NewConfig() *Config

NewConfig creates a new config object using the environment defaults

func NewConfigFromPath

func NewConfigFromPath(kubeConfigFilePath string) *Config

NewConfigFromPath creates a new config object using the specified kubeconfig path

func (*Config) GetRestClientConfig

func (c *Config) GetRestClientConfig() (*rest.Config, error)

GetRestClientConfig returns a rest.Config to be used in a Kubernetes client

func (*Config) Modify

func (c *Config) Modify(options *ConfigOptions) error

Modify updates the kubeconfig with the given options

type ConfigOptions

type ConfigOptions struct {

	// ClusterName is the name of the cluster as it appears in the kubeconfig
	ClusterName string

	// ClusterServer is the hostname of the cluster
	ClusterServer string

	// ClusterCA is the Certificate Authority contents
	ClusterCA string

	// AuthName is the name of the authentication entry as it appears in the kubeconfig
	AuthName string

	// AuthToken is the authentication token
	AuthToken string

	// ContextName is the name of the context
	ContextName string

	// ContextDefaultNamespace is the context's default namespace
	ContextDefaultNamespace string

	// ContextSetCurrent is a flag to set this context as the "current-context" in the kubeconfig
	ContextSetCurrent bool
}

ConfigOptions defines options for configuring the kubeconfig

type Kubernetes

type Kubernetes struct {
	// contains filtered or unexported fields
}

Kubernetes represents a interface with a Kubernetes cluster

func New

func New(config *Config) (*Kubernetes, error)

New returns a new Kubernetes object with the given config

func (*Kubernetes) DiscoveryClient

func (k *Kubernetes) DiscoveryClient() (*discovery.DiscoveryClient, error)

DiscoveryClient returns the Kubernetes discovery client The discovery client implements the functions that discover server-supported API groups, versions and resources.

func (*Kubernetes) GetClientset

func (k *Kubernetes) GetClientset() (*kubernetes.Clientset, error)

GetClientset returns the Kubernetes clientset, which can be acted on directly to perform API calls

func (*Kubernetes) GetConfig

func (k *Kubernetes) GetConfig() *Config

GetConfig returns the config object assicated with this instance

func (*Kubernetes) Version

func (k *Kubernetes) Version() (string, error)

Version returns the version of the Kubernetes cluster