kubernetes

Documentation

Overview

Package kubernetes provides objects for starting the Kubernetes master and node code.

Index

• Constants
• Variables
• func SetFakeCadvisorInterfaceForIntegrationTest()
• type FilteringEndpointsConfigHandler
• type MasterConfig
  • func BuildKubernetesMasterConfig(options configapi.MasterConfig, requestContextMapper kapi.RequestContextMapper, ...) (*MasterConfig, error)
  • func (c *MasterConfig) InstallAPI(container *restful.Container) []string
  • func (c *MasterConfig) RunEndpointController()
  • func (c *MasterConfig) RunHPAController(client *client.Client)
  • func (c *MasterConfig) RunJobController(client *client.Client)
  • func (c *MasterConfig) RunNamespaceController()
  • func (c *MasterConfig) RunNodeController()
  • func (c *MasterConfig) RunPersistentVolumeClaimBinder()
  • func (c *MasterConfig) RunPersistentVolumeClaimRecycler(recyclerImageName string)
  • func (c *MasterConfig) RunReplicationController(client *client.Client)
  • func (c *MasterConfig) RunResourceQuotaManager()
  • func (c *MasterConfig) RunScheduler()
• type NodeAuthorizerAttributesGetter
  • func (n NodeAuthorizerAttributesGetter) GetRequestAttributes(u user.Info, r *http.Request) kauthorizer.Attributes
• type NodeConfig
  • func BuildKubernetesNodeConfig(options configapi.NodeConfig) (*NodeConfig, error)
  • func (c *NodeConfig) EnsureDocker(docker *dockerutil.Helper)
  • func (c *NodeConfig) EnsureVolumeDir()
  • func (c *NodeConfig) HandleDockerError(message string)
  • func (c *NodeConfig) RunKubelet()
  • func (c *NodeConfig) RunProxy(endpointsFilterer FilteringEndpointsConfigHandler)
• type ProxyConfig
  • func (c *ProxyConfig) InstallAPI(container *restful.Container) []string

Constants

const (
	KubeAPIPrefix                  = "/api"
	KubeAPIPrefixV1                = KubeAPIPrefix + "/v1"
	KubeAPIGroupPrefix             = "/apis"
	KubeAPIExtensionsPrefixV1beta1 = KubeAPIGroupPrefix + "/extensions/v1beta1"
)

Variables

var AdmissionPlugins = []string{"NamespaceLifecycle", "OriginPodNodeEnvironment", "LimitRanger", "ServiceAccount", "SecurityContextConstraint", "ResourceQuota", "SCCExecRestrictions"}

AdmissionPlugins is the full list of admission control plugins to enable in the order they must run

Functions

func SetFakeCadvisorInterfaceForIntegrationTest

func SetFakeCadvisorInterfaceForIntegrationTest()

SetFakeCadvisorInterfaceForIntegrationTest sets a fake cadvisor implementation to allow the node to run in integration tests

Types

type FilteringEndpointsConfigHandler

type FilteringEndpointsConfigHandler interface {
	pconfig.EndpointsConfigHandler
	SetBaseEndpointsHandler(base pconfig.EndpointsConfigHandler)
}

type MasterConfig

type MasterConfig struct {
	Options    configapi.KubernetesMasterConfig
	KubeClient *kclient.Client

	Master            *master.Config
	ControllerManager *cmapp.CMServer
	CloudProvider     cloudprovider.Interface
}

MasterConfig defines the required values to start a Kubernetes master

func BuildKubernetesMasterConfig

func BuildKubernetesMasterConfig(options configapi.MasterConfig, requestContextMapper kapi.RequestContextMapper, kubeClient *kclient.Client) (*MasterConfig, error)

func (*MasterConfig) InstallAPI

func (c *MasterConfig) InstallAPI(container *restful.Container) []string

InstallAPI starts a Kubernetes master and registers the supported REST APIs into the provided mux, then returns an array of strings indicating what endpoints were started (these are format strings that will expect to be sent a single string value).

func (*MasterConfig) RunEndpointController

func (c *MasterConfig) RunEndpointController()

RunEndpointController starts the Kubernetes replication controller sync loop

func (*MasterConfig) RunHPAController

func (c *MasterConfig) RunHPAController(client *client.Client)

RunHPAController starts the Kubernetes hpa controller sync loop

func (*MasterConfig) RunJobController

func (c *MasterConfig) RunJobController(client *client.Client)

RunJobController starts the Kubernetes job controller sync loop

func (*MasterConfig) RunNamespaceController

func (c *MasterConfig) RunNamespaceController()

RunNamespaceController starts the Kubernetes Namespace Manager

func (*MasterConfig) RunNodeController

func (c *MasterConfig) RunNodeController()

RunNodeController starts the node controller

func (*MasterConfig) RunPersistentVolumeClaimBinder

func (c *MasterConfig) RunPersistentVolumeClaimBinder()

RunPersistentVolumeClaimBinder starts the Kubernetes Persistent Volume Claim Binder

func (*MasterConfig) RunPersistentVolumeClaimRecycler

func (c *MasterConfig) RunPersistentVolumeClaimRecycler(recyclerImageName string)

func (*MasterConfig) RunReplicationController

func (c *MasterConfig) RunReplicationController(client *client.Client)

RunReplicationController starts the Kubernetes replication controller sync loop

func (*MasterConfig) RunResourceQuotaManager

func (c *MasterConfig) RunResourceQuotaManager()

RunResourceQuotaManager starts the resource quota manager

func (*MasterConfig) RunScheduler

func (c *MasterConfig) RunScheduler()

RunScheduler starts the Kubernetes scheduler

type NodeAuthorizerAttributesGetter

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

func (NodeAuthorizerAttributesGetter) GetRequestAttributes

func (n NodeAuthorizerAttributesGetter) GetRequestAttributes(u user.Info, r *http.Request) kauthorizer.Attributes

GetRequestAttributes populates authorizer attributes for the requests to the kubelet API. Default attributes are {apiVersion=v1,verb=proxy,resource=nodes,resourceName=<node name>} More specific verb/resource is set for the following request patterns:

/stats/*   => verb=<api verb from request>, resource=nodes/stats
/metrics/* => verb=<api verb from request>, resource=nodes/metrics
/logs/*    => verb=<api verb from request>, resource=nodes/log

type NodeConfig

type NodeConfig struct {
	// BindAddress is the address to bind to
	BindAddress string
	// VolumeDir is the directory that volumes will be stored under
	VolumeDir string
	// AllowDisabledDocker if true, will make the Kubelet ignore errors from Docker
	AllowDisabledDocker bool
	// Client to connect to the master.
	Client *client.Client
	// DockerClient is a client to connect to Docker
	DockerClient dockertools.DockerInterface
	// KubeletServer contains the KubeletServer configuration
	KubeletServer *kapp.KubeletServer
	// KubeletConfig is the configuration for the kubelet, fully initialized
	KubeletConfig *kapp.KubeletConfig
	// IPTablesSyncPeriod is how often iptable rules are refreshed
	IPTablesSyncPeriod string
}

NodeConfig represents the required parameters to start the OpenShift node through Kubernetes. All fields are required.

func BuildKubernetesNodeConfig

func BuildKubernetesNodeConfig(options configapi.NodeConfig) (*NodeConfig, error)

func (*NodeConfig) EnsureDocker

func (c *NodeConfig) EnsureDocker(docker *dockerutil.Helper)

EnsureDocker attempts to connect to the Docker daemon defined by the helper, and if it is unable to it will print a warning.

func (*NodeConfig) EnsureVolumeDir

func (c *NodeConfig) EnsureVolumeDir()

EnsureVolumeDir attempts to convert the provided volume directory argument to an absolute path and create the directory if it does not exist. Will exit if an error is encountered.

func (*NodeConfig) HandleDockerError

func (c *NodeConfig) HandleDockerError(message string)

HandleDockerError handles an an error from the docker daemon

func (*NodeConfig) RunKubelet

func (c *NodeConfig) RunKubelet()

RunKubelet starts the Kubelet.

func (*NodeConfig) RunProxy

func (c *NodeConfig) RunProxy(endpointsFilterer FilteringEndpointsConfigHandler)

RunProxy starts the proxy

type ProxyConfig

type ProxyConfig struct {
	ClientConfig *kclient.Config
}

func (*ProxyConfig) InstallAPI

func (c *ProxyConfig) InstallAPI(container *restful.Container) []string