kubernetes

Documentation

Index

• func NewScheduler(j jobs.Job, cluster cluster.Cluster, kubeConfig, context string) (scheduler.Scheduler, error)
• type AuthInfo
• type AuthInfoEntry
• type AuthProviderConfig
• type Cluster
• type ClusterEntry
• type Config
  • func (c *Config) GetCluster(name string) (*Cluster, error)
  • func (c *Config) GetContext(name string) (*Context, error)
  • func (c *Config) GetCurrentContext() (*Context, error)
  • func (c *Config) GetUser(name string) (*AuthInfo, error)
• type Context
• type ContextEntry
• type Preferences
• type Unit

Functions

func NewScheduler

func NewScheduler(j jobs.Job, cluster cluster.Cluster, kubeConfig, context string) (scheduler.Scheduler, error)

NewScheduler creates a new kubernetes implementation of scheduler.Scheduler.

Types

type AuthInfo

type AuthInfo struct {
	// LocationOfOrigin indicates where this object came from.  It is used for round tripping config post-merge, but never serialized.
	LocationOfOrigin string
	// ClientCertificate is the path to a client cert file for TLS.
	// +optional
	ClientCertificate string `json:"client-certificate,omitempty"`
	// ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate
	// +optional
	ClientCertificateData []byte `json:"client-certificate-data,omitempty"`
	// ClientKey is the path to a client key file for TLS.
	// +optional
	ClientKey string `json:"client-key,omitempty"`
	// ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey
	// +optional
	ClientKeyData []byte `json:"client-key-data,omitempty"`
	// Token is the bearer token for authentication to the kubernetes cluster.
	// +optional
	Token string `json:"token,omitempty"`
	// TokenFile is a pointer to a file that contains a bearer token (as described above).  If both Token and TokenFile are present, Token takes precedence.
	// +optional
	TokenFile string `json:"tokenFile,omitempty"`
	// Impersonate is the username to act-as.
	// +optional
	Impersonate string `json:"act-as,omitempty"`
	// Username is the username for basic authentication to the kubernetes cluster.
	// +optional
	Username string `json:"username,omitempty"`
	// Password is the password for basic authentication to the kubernetes cluster.
	// +optional
	Password string `json:"password,omitempty"`
	// AuthProvider specifies a custom authentication plugin for the kubernetes cluster.
	// +optional
	AuthProvider *AuthProviderConfig `json:"auth-provider,omitempty"`
}

AuthInfo contains information that describes identity information. This is use to tell the kubernetes cluster who you are.

type AuthInfoEntry

type AuthInfoEntry struct {
	Name     string    `json:"name"`
	AuthInfo *AuthInfo `json:"user"`
}

type AuthProviderConfig

type AuthProviderConfig struct {
	Name string `json:"name"`
	// +optional
	Config map[string]string `json:"config,omitempty"`
}

AuthProviderConfig holds the configuration for a specified auth provider.

type Cluster

type Cluster struct {
	// LocationOfOrigin indicates where this object came from.  It is used for round tripping config post-merge, but never serialized.
	LocationOfOrigin string
	// Server is the address of the kubernetes cluster (https://hostname:port).
	Server string `json:"server"`
	// APIVersion is the preferred api version for communicating with the kubernetes cluster (v1, v2, etc).
	// +optional
	APIVersion string `json:"api-version,omitempty"`
	// InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.
	// +optional
	InsecureSkipTLSVerify bool `json:"insecure-skip-tls-verify,omitempty"`
	// CertificateAuthority is the path to a cert file for the certificate authority.
	// +optional
	CertificateAuthority string `json:"certificate-authority,omitempty"`
	// CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority
	// +optional
	CertificateAuthorityData []byte `json:"certificate-authority-data,omitempty"`
}

Cluster contains information about how to communicate with a kubernetes cluster

type ClusterEntry

type ClusterEntry struct {
	Name    string   `json:"name"`
	Cluster *Cluster `json:"cluster"`
}

type Config

type Config struct {
	// Legacy field from pkg/api/types.go TypeMeta.
	// TODO(jlowdermilk): remove this after eliminating downstream dependencies.
	// +optional
	Kind string `json:"kind,omitempty"`
	// DEPRECATED: APIVersion is the preferred api version for communicating with the kubernetes cluster (v1, v2, etc).
	// Because a cluster can run multiple API groups and potentially multiple versions of each, it no longer makes sense to specify
	// a single value for the cluster version.
	// This field isn't really needed anyway, so we are deprecating it without replacement.
	// It will be ignored if it is present.
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
	// Preferences holds general information to be use for cli interactions
	Preferences Preferences `json:"preferences"`
	// Clusters is a map of referencable names to cluster configs
	Clusters []ClusterEntry `json:"clusters"`
	// AuthInfos is a map of referencable names to user configs
	AuthInfos []AuthInfoEntry `json:"users"`
	// Contexts is a map of referencable names to context configs
	Contexts []ContextEntry `json:"contexts"`
	// CurrentContext is the name of the context that you would like to use by default
	CurrentContext string `json:"current-context"`
}

Config holds the information needed to build connect to remote kubernetes clusters as a given user IMPORTANT if you add fields to this struct, please update IsConfigEmpty()

func (*Config) GetCluster

func (c *Config) GetCluster(name string) (*Cluster, error)

func (*Config) GetContext

func (c *Config) GetContext(name string) (*Context, error)

GetContext returns a context with given name

func (*Config) GetCurrentContext

func (c *Config) GetCurrentContext() (*Context, error)

GetCurrentContext returns the current context

func (*Config) GetUser

func (c *Config) GetUser(name string) (*AuthInfo, error)

type Context

type Context struct {
	Name string `json:"name"`
	// LocationOfOrigin indicates where this object came from.  It is used for round tripping config post-merge, but never serialized.
	LocationOfOrigin string
	// Cluster is the name of the cluster for this context
	Cluster string `json:"cluster"`
	// AuthInfo is the name of the authInfo for this context
	AuthInfo string `json:"user"`
	// Namespace is the default namespace to use on unspecified requests
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

Context is a tuple of references to a cluster (how do I communicate with a kubernetes cluster), a user (how do I identify myself), and a namespace (what subset of resources do I want to work with)

type ContextEntry

type ContextEntry struct {
	Name    string   `json:"name"`
	Context *Context `json:"context"`
}

type Preferences

type Preferences struct {
	// +optional
	Colors bool `json:"colors,omitempty"`
}

IMPORTANT if you add fields to this struct, please update IsConfigEmpty()

type Unit

type Unit interface {
	scheduler.UnitData
	ObjectMeta() *k8s.ObjectMeta
	Namespace() string
	GetCurrent(cs k8s.Client) (interface{}, error)
	IsEqual(interface{}) ([]string, bool, error)
	IsValidState(cs k8s.Client) (bool, string, error)
	Start(cs k8s.Client, events chan string) error
	Destroy(cs k8s.Client, events chan string) error
}

Unit extends scheduler.Unit with methods used to start & stop units.