origin

Documentation

Overview

Package origin provides objects for creating an OpenShift Origin server

Index

• Constants
• func GetTokenAuthenticator(etcdHelper tools.EtcdHelper) (authenticator.Token, error)
• func NewEtcdHelper(version string, client *etcdclient.Client) (helper tools.EtcdHelper, err error)
• type APIInstaller
• type AuthConfig
  • func (c *AuthConfig) InstallAPI(mux cmdutil.Mux) []string
• type MasterConfig
  • func (c *MasterConfig) EnsureCORSAllowedOrigins(origins []string)
  • func (c *MasterConfig) EnsureKubernetesClient()
  • func (c *MasterConfig) EnsureOpenShiftClient()
  • func (c *MasterConfig) RunAPI(installers ...APIInstaller)
  • func (c *MasterConfig) RunAssetServer()
  • func (c *MasterConfig) RunBasicDeploymentController()
  • func (c *MasterConfig) RunBuildController()
  • func (c *MasterConfig) RunCustomPodDeploymentController()
  • func (c *MasterConfig) RunDeploymentConfigChangeController()
  • func (c *MasterConfig) RunDeploymentConfigController()
  • func (c *MasterConfig) RunDeploymentImageChangeTriggerController()

Constants

const (
	OpenShiftOAuthAPIPrefix      = "/oauth"
	OpenShiftLoginPrefix         = "/login"
	OpenShiftOAuthCallbackPrefix = "/oauth2callback"
)

const (
	OpenShiftAPIPrefixV1Beta1 = "/osapi/v1beta1"
)

Functions

func GetTokenAuthenticator

func GetTokenAuthenticator(etcdHelper tools.EtcdHelper) (authenticator.Token, error)

func NewEtcdHelper

func NewEtcdHelper(version string, client *etcdclient.Client) (helper tools.EtcdHelper, err error)

NewEtcdHelper returns an EtcdHelper for the provided arguments or an error if the version is incorrect.

Types

type APIInstaller

type APIInstaller interface {
	// Returns an array of strings describing what was installed
	InstallAPI(cmdutil.Mux) []string
}

APIInstaller installs additional API components into this server

type AuthConfig

type AuthConfig struct {
	MasterAddr     string
	SessionSecrets []string
	EtcdHelper     tools.EtcdHelper
}

func (*AuthConfig) InstallAPI

func (c *AuthConfig) InstallAPI(mux cmdutil.Mux) []string

InstallAPI starts an OAuth2 server 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).

type MasterConfig

type MasterConfig struct {
	BindAddr   string
	MasterAddr string
	AssetAddr  string

	CORSAllowedOrigins    []*regexp.Regexp
	RequireAuthentication bool

	EtcdHelper tools.EtcdHelper

	KubeClient *kclient.Client
	OSClient   *osclient.Client
}

MasterConfig defines the required parameters for starting the OpenShift master

func (*MasterConfig) EnsureCORSAllowedOrigins

func (c *MasterConfig) EnsureCORSAllowedOrigins(origins []string)

EnsureCORSAllowedOrigins takes a string list of origins and attempts to covert them to CORS origin regexes, or exits if it cannot.

func (*MasterConfig) EnsureKubernetesClient

func (c *MasterConfig) EnsureKubernetesClient()

EnsureKubernetesClient creates a Kubernetes client or exits if the client cannot be created.

func (*MasterConfig) EnsureOpenShiftClient

func (c *MasterConfig) EnsureOpenShiftClient()

EnsureOpenShiftClient creates an OpenShift client or exits if the client cannot be created.

func (*MasterConfig) RunAPI

func (c *MasterConfig) RunAPI(installers ...APIInstaller)

RunAPI launches the OpenShift master. It takes an optional API installer that may install additional endpoints into the server.

func (*MasterConfig) RunAssetServer

func (c *MasterConfig) RunAssetServer()

RunAssetServer starts the asset server for the OpenShift UI.

func (*MasterConfig) RunBasicDeploymentController

func (c *MasterConfig) RunBasicDeploymentController()

func (*MasterConfig) RunBuildController

func (c *MasterConfig) RunBuildController()

RunBuildController starts the build sync loop for builds and buildConfig processing.

func (*MasterConfig) RunCustomPodDeploymentController

func (c *MasterConfig) RunCustomPodDeploymentController()

RunDeploymentController starts the deployment controller process.

func (*MasterConfig) RunDeploymentConfigChangeController

func (c *MasterConfig) RunDeploymentConfigChangeController()

func (*MasterConfig) RunDeploymentConfigController

func (c *MasterConfig) RunDeploymentConfigController()

func (*MasterConfig) RunDeploymentImageChangeTriggerController

func (c *MasterConfig) RunDeploymentImageChangeTriggerController()