clusterup

Documentation

Index

• Constants
• Variables
• func NewCmdDown(name, fullName string) *cobra.Command
• func NewCmdUp(name, fullName string, f genericclioptions.RESTClientGetter, ...) *cobra.Command
• func PrintError(err error, out io.Writer)
• type ClientStopConfig
  • func (c *ClientStopConfig) Stop() error
• type ClusterUpConfig
  • func NewClusterUpConfig(streams genericclioptions.IOStreams) *ClusterUpConfig
  • func (c *ClusterUpConfig) Bind(flags *pflag.FlagSet)
  • func (c *ClusterUpConfig) BuildConfig() (*configDirs, error)
  • func (c *ClusterUpConfig) Check() error
  • func (c *ClusterUpConfig) ClusterAdminKubeConfigBytes() ([]byte, error)
  • func (c *ClusterUpConfig) Complete(f genericclioptions.RESTClientGetter, cmd *cobra.Command) error
  • func (c *ClusterUpConfig) Docker() *dockerutil.Helper
  • func (c *ClusterUpConfig) DockerClient() dockerutil.Interface
  • func (c *ClusterUpConfig) GetPublicHostName() string
  • func (c *ClusterUpConfig) Host() *host.HostHelper
  • func (c *ClusterUpConfig) OpenShift() *openshift.Helper
  • func (c *ClusterUpConfig) RESTConfig() (*rest.Config, error)
  • func (c *ClusterUpConfig) Start() error
  • func (c *ClusterUpConfig) StartSelfHosted(out io.Writer) error
  • func (c *ClusterUpConfig) Validate() error
• type Image
  • func (i *Image) ToPullSpec(tpl variable.ImageTemplate) PullSpec
• type Images
  • func (i Images) EnsurePulled(puller *dockerutil.Helper, tpl variable.ImageTemplate, forcePull bool) error
  • func (i Images) Get(name string) *Image
• type PullSpec
  • func (s PullSpec) Pull(puller *dockerutil.Helper, forcePull bool) error
  • func (s PullSpec) String() string

Constants

const CmdDownRecommendedName = "down"

const (
	// CmdUpRecommendedName is the recommended command name
	CmdUpRecommendedName = "up"
)

Variables

var OpenShiftImages = Images{

	{Name: "cluster-kube-apiserver-operator"},
	{Name: "cluster-kube-controller-manager-operator"},
	{Name: "control-plane"},
	{Name: "cli"},
	{Name: "hyperkube"},
	{Name: "hypershift"},
	{Name: "node"},
	{Name: "pod"},

	{Name: "bootkube", PullSpec: "quay.io/coreos/bootkube:v0.13.0"},
	{Name: "etcd", PullSpec: "quay.io/coreos/etcd:v3.2.24"},
}

OpenShiftImages specifies a list of images cluster up require to pull in order to bootstrap a cluster.

Functions

func NewCmdDown

func NewCmdDown(name, fullName string) *cobra.Command

NewCmdDown creates a command that stops OpenShift

func NewCmdUp

func NewCmdUp(name, fullName string, f genericclioptions.RESTClientGetter, streams genericclioptions.IOStreams) *cobra.Command

NewCmdUp creates a command that starts OpenShift on Docker with reasonable defaults

func PrintError

func PrintError(err error, out io.Writer)

Types

type ClientStopConfig

type ClientStopConfig struct {
}

func (*ClientStopConfig) Stop

func (c *ClientStopConfig) Stop() error

Stop stops the currently running origin container and any containers started by the node.

type ClusterUpConfig

type ClusterUpConfig struct {
	ImageTemplate variable.ImageTemplate
	ImageTag      string
	ForcePull     bool

	// BaseTempDir is the directory to use as the root for temp directories
	// This allows us to bundle all of the cluster-up directories in one spot for easier cleanup and ensures we aren't
	// doing crazy thing like dirtying /var on the host (that does weird stuff)
	BaseDir           string
	SpecifiedBaseDir  bool
	HostName          string
	UseExistingConfig bool
	ServerLogLevel    int

	HostVolumesDir           string
	HostConfigDir            string
	HostDataDir              string
	UsePorts                 []int
	DNSPort                  int
	ServerIP                 string
	AdditionalIPs            []string
	PublicHostname           string
	HostPersistentVolumesDir string

	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

func NewClusterUpConfig

func NewClusterUpConfig(streams genericclioptions.IOStreams) *ClusterUpConfig

func (*ClusterUpConfig) Bind

func (c *ClusterUpConfig) Bind(flags *pflag.FlagSet)

func (*ClusterUpConfig) BuildConfig

func (c *ClusterUpConfig) BuildConfig() (*configDirs, error)

func (*ClusterUpConfig) Check

func (c *ClusterUpConfig) Check() error

Check is a spot to do NON-MUTATING, preflight checks. Over time, we should try to move our non-mutating checks out of Complete and into Check.

func (*ClusterUpConfig) ClusterAdminKubeConfigBytes

func (c *ClusterUpConfig) ClusterAdminKubeConfigBytes() ([]byte, error)

func (*ClusterUpConfig) Complete

func (c *ClusterUpConfig) Complete(f genericclioptions.RESTClientGetter, cmd *cobra.Command) error

func (*ClusterUpConfig) Docker

func (c *ClusterUpConfig) Docker() *dockerutil.Helper

Docker returns a helper object to work with the Docker client

func (*ClusterUpConfig) DockerClient

func (c *ClusterUpConfig) DockerClient() dockerutil.Interface

DockerClient obtains a new Docker client from the environment or from a Docker machine, starting it if necessary

func (*ClusterUpConfig) GetPublicHostName

func (c *ClusterUpConfig) GetPublicHostName() string

func (*ClusterUpConfig) Host

func (c *ClusterUpConfig) Host() *host.HostHelper

Host returns a helper object to check Host configuration

func (*ClusterUpConfig) OpenShift

func (c *ClusterUpConfig) OpenShift() *openshift.Helper

OpenShift returns a helper object to work with OpenShift on the server

func (*ClusterUpConfig) RESTConfig

func (c *ClusterUpConfig) RESTConfig() (*rest.Config, error)

func (*ClusterUpConfig) Start

func (c *ClusterUpConfig) Start() error

Start runs the start tasks ensuring that they are executed in sequence

func (*ClusterUpConfig) StartSelfHosted

func (c *ClusterUpConfig) StartSelfHosted(out io.Writer) error

func (*ClusterUpConfig) Validate

func (c *ClusterUpConfig) Validate() error

Validate validates that required fields in StartConfig have been populated

type Image

type Image struct {
	Name string

	// PullSpec if specified is used instead of expanding the name via template. Used for non-openshift images.
	PullSpec string
}

func (*Image) ToPullSpec

func (i *Image) ToPullSpec(tpl variable.ImageTemplate) PullSpec

type Images

type Images []Image

func (Images) EnsurePulled

func (i Images) EnsurePulled(puller *dockerutil.Helper, tpl variable.ImageTemplate, forcePull bool) error

func (Images) Get

func (i Images) Get(name string) *Image

type PullSpec

type PullSpec string

func (PullSpec) Pull

func (s PullSpec) Pull(puller *dockerutil.Helper, forcePull bool) error

func (PullSpec) String

func (s PullSpec) String() string