server

Documentation

Overview

Package server contains the main command for launching an OpenShift server. Subpackages contain the specific components that the server may need.

Index

• type Config
  • func NewCommandStartServer(name string) (*cobra.Command, *Config)
  • func NewDefaultConfig() *Config
  • func (cfg Config) BuildAuthConfig() (*origin.AuthConfig, error)
  • func (cfg Config) BuildKubernetesMasterConfig(requestContextMapper kapi.RequestContextMapper, kubeClient *kclient.Client) (*kubernetes.MasterConfig, error)
  • func (cfg Config) BuildKubernetesNodeConfig() (*kubernetes.NodeConfig, error)
  • func (cfg Config) BuildOriginMasterConfig() (*origin.MasterConfig, error)
  • func (cfg *Config) Complete(args []string)
  • func (cfg Config) GetAssetBindAddress() string
  • func (cfg Config) GetAssetCert() (certFile string, keyFile string, err error)
  • func (cfg Config) GetAssetPublicAddress() (*url.URL, error)
  • func (cfg Config) GetClientCAs() (*x509.CertPool, error)
  • func (cfg Config) GetEtcdAddress() (*url.URL, error)
  • func (cfg Config) GetEtcdBindAddress() string
  • func (cfg Config) GetEtcdPeerBindAddress() string
  • func (cfg Config) GetExternalKubernetesClientConfig() (*client.Config, bool, error)
  • func (cfg Config) GetKubeClient() (*kclient.Client, *kclient.Config, error)
  • func (cfg Config) GetKubernetesAddress() (*url.URL, error)
  • func (cfg Config) GetKubernetesPublicAddress() (*url.URL, error)
  • func (cfg Config) GetMasterAddress() (*url.URL, error)
  • func (cfg Config) GetMasterCert() (certFile string, keyFile string, err error)
  • func (cfg Config) GetMasterPublicAddress() (*url.URL, error)
  • func (cfg Config) GetNodeList() []string
  • func (cfg Config) GetOpenshiftClient() (*osclient.Client, *kclient.Config, error)
  • func (cfg Config) GetOpenshiftDeployerClientConfig() (*kclient.Config, error)
  • func (cfg Config) GetServerCertHostnames() ([]string, error)
  • func (cfg Config) MintNodeCerts() error
  • func (cfg Config) MintSystemClientCert(username string, groups ...string) (*kclient.Config, error)
  • func (cfg Config) RunEtcd() error
  • func (cfg Config) Start(args []string) error
  • func (cfg Config) Validate(args []string) error

Types

type Config

type Config struct {
	Docker *docker.Helper

	WriteConfigOnly bool

	StartNode   bool
	StartMaster bool
	StartKube   bool
	StartEtcd   bool

	MasterAddr     flagtypes.Addr
	BindAddr       flagtypes.Addr
	EtcdAddr       flagtypes.Addr
	KubernetesAddr flagtypes.Addr
	PortalNet      flagtypes.IPNet
	// addresses for external clients
	MasterPublicAddr     flagtypes.Addr
	KubernetesPublicAddr flagtypes.Addr

	ImageFormat         string
	LatestReleaseImages bool

	ImageTemplate variable.ImageTemplate

	Hostname  string
	VolumeDir string

	EtcdDir string

	CertDir string

	StorageVersion string

	NodeList flagtypes.StringList

	// ClientConfig is used when connecting to Kubernetes from the master, or
	// when connecting to the master from a detached node. If StartKube is true,
	// this value is not used.
	ClientConfig clientcmd.ClientConfig
	// ClientConfigLoadingRules is the ruleset used to load the client config.
	// Only the CommandLinePath is expected to be used.
	ClientConfigLoadingRules clientcmd.ClientConfigLoadingRules

	CORSAllowedOrigins flagtypes.StringList
}

Config is a struct that the command stores flag values into.

func NewCommandStartServer

func NewCommandStartServer(name string) (*cobra.Command, *Config)

NewCommandStartServer provides a CLI handler for 'start' command

func NewDefaultConfig

func NewDefaultConfig() *Config

func (Config) BuildAuthConfig

func (cfg Config) BuildAuthConfig() (*origin.AuthConfig, error)

func (Config) BuildKubernetesMasterConfig

func (cfg Config) BuildKubernetesMasterConfig(requestContextMapper kapi.RequestContextMapper, kubeClient *kclient.Client) (*kubernetes.MasterConfig, error)

func (Config) BuildKubernetesNodeConfig

func (cfg Config) BuildKubernetesNodeConfig() (*kubernetes.NodeConfig, error)

func (Config) BuildOriginMasterConfig

func (cfg Config) BuildOriginMasterConfig() (*origin.MasterConfig, error)

func (*Config) Complete

func (cfg *Config) Complete(args []string)

Complete takes the args and fills in information for the start config

func (Config) GetAssetBindAddress

func (cfg Config) GetAssetBindAddress() string

func (Config) GetAssetCert

func (cfg Config) GetAssetCert() (certFile string, keyFile string, err error)

func (Config) GetAssetPublicAddress

func (cfg Config) GetAssetPublicAddress() (*url.URL, error)

func (Config) GetClientCAs

func (cfg Config) GetClientCAs() (*x509.CertPool, error)

func (Config) GetEtcdAddress

func (cfg Config) GetEtcdAddress() (*url.URL, error)

func (Config) GetEtcdBindAddress

func (cfg Config) GetEtcdBindAddress() string

func (Config) GetEtcdPeerBindAddress

func (cfg Config) GetEtcdPeerBindAddress() string

func (Config) GetExternalKubernetesClientConfig

func (cfg Config) GetExternalKubernetesClientConfig() (*client.Config, bool, error)

func (Config) GetKubeClient

func (cfg Config) GetKubeClient() (*kclient.Client, *kclient.Config, error)

func (Config) GetKubernetesAddress

func (cfg Config) GetKubernetesAddress() (*url.URL, error)

func (Config) GetKubernetesPublicAddress

func (cfg Config) GetKubernetesPublicAddress() (*url.URL, error)

func (Config) GetMasterAddress

func (cfg Config) GetMasterAddress() (*url.URL, error)

GetMasterAddress checks for an unset master address and then attempts to use the first public IPv4 non-loopback address registered on this host. TODO: make me IPv6 safe

func (Config) GetMasterCert

func (cfg Config) GetMasterCert() (certFile string, keyFile string, err error)

func (Config) GetMasterPublicAddress

func (cfg Config) GetMasterPublicAddress() (*url.URL, error)

func (Config) GetNodeList

func (cfg Config) GetNodeList() []string

func (Config) GetOpenshiftClient

func (cfg Config) GetOpenshiftClient() (*osclient.Client, *kclient.Config, error)

func (Config) GetOpenshiftDeployerClientConfig

func (cfg Config) GetOpenshiftDeployerClientConfig() (*kclient.Config, error)

func (Config) GetServerCertHostnames

func (cfg Config) GetServerCertHostnames() ([]string, error)

func (Config) MintNodeCerts

func (cfg Config) MintNodeCerts() error

func (Config) MintSystemClientCert

func (cfg Config) MintSystemClientCert(username string, groups ...string) (*kclient.Config, error)

known certs: openshiftClientUser := &user.DefaultInfo{Name: "system:openshift-client"} openshiftDeployerUser := &user.DefaultInfo{Name: "system:openshift-deployer", Groups: []string{"system:deployers"}} adminUser := &user.DefaultInfo{Name: "system:admin", Groups: []string{"system:cluster-admins"}} kubeClientUser := &user.DefaultInfo{Name: "system:kube-client"} // One for each node in cfg.GetNodeList()

func (Config) RunEtcd

func (cfg Config) RunEtcd() error

func (Config) Start

func (cfg Config) Start(args []string) error

run launches the appropriate startup modes or returns an error.

func (Config) Validate

func (cfg Config) Validate(args []string) error