cluster

Documentation

Index

• Constants
• Variables
• func CheckIfApiExistsAndLoad(api libmachine.API) (*host.Host, error)
• func CreateSSHShell(api libmachine.API, args []string) error
• func DeleteHost(api libmachine.API) error
• func GenerateCerts(pub, priv string, ip net.IP) error
• func GetAlternateDNS(domain string) []string
• func GetConsoleURL(api libmachine.API) (string, error)
• func GetHostDockerEnv(api libmachine.API) (map[string]string, error)
• func GetHostIP(api libmachine.API) (string, error)
• func GetHostLogs(api libmachine.API, follow bool) (string, error)
• func GetHostStatus(api libmachine.API) (string, error)
• func Register(api libmachine.API) (bool, error)
• func StartHost(api libmachine.API, config MachineConfig) (*host.Host, error)
• func StopHost(api libmachine.API) error
• func UnRegister(api libmachine.API) (bool, error)
• type MachineConfig
  • func (m *MachineConfig) CacheMinikubeISOFromURL() error
  • func (m *MachineConfig) GetISOCacheFilepath() string
  • func (m *MachineConfig) GetISOFileURI() string
  • func (m *MachineConfig) IsMinikubeISOCached() bool
  • func (m *MachineConfig) ShouldCacheMinikubeISO() bool

Constants

const (
	DefaultOpenShiftDirectory = "/var/lib/minishift"
	DefaultCertPath           = DefaultOpenShiftDirectory + "/openshift.local.config/master/"
	DefaultServiceClusterIP   = "10.0.0.1"
	DefaultDNSDomain          = "cluster.local"
	DefaultDNSIP              = "10.0.0.10"
)

These constants are used by both minikube and openshift

Variables

var (
	RegistrationParameters = new(registration.RegistrationParameters)
)

Functions

func CheckIfApiExistsAndLoad

func CheckIfApiExistsAndLoad(api libmachine.API) (*host.Host, error)

func CreateSSHShell

func CreateSSHShell(api libmachine.API, args []string) error

func DeleteHost

func DeleteHost(api libmachine.API) error

DeleteHost deletes the host VM.

func GenerateCerts

func GenerateCerts(pub, priv string, ip net.IP) error

func GetAlternateDNS

func GetAlternateDNS(domain string) []string

func GetConsoleURL

func GetConsoleURL(api libmachine.API) (string, error)

func GetHostDockerEnv

func GetHostDockerEnv(api libmachine.API) (map[string]string, error)

GetHostDockerEnv gets the necessary docker env variables to allow the use of docker through minikube's vm

func GetHostIP

func GetHostIP(api libmachine.API) (string, error)

func GetHostLogs

func GetHostLogs(api libmachine.API, follow bool) (string, error)

GetHostLogs gets the openshift logs of the host VM. If follow is specified, it will tail the logs

func GetHostStatus

func GetHostStatus(api libmachine.API) (string, error)

GetHostStatus gets the status of the host VM.

func Register

func Register(api libmachine.API) (bool, error)

Register host VM

func StartHost

func StartHost(api libmachine.API, config MachineConfig) (*host.Host, error)

StartHost starts a host VM.

func StopHost

func StopHost(api libmachine.API) error

StopHost stops the host VM.

func UnRegister

func UnRegister(api libmachine.API) (bool, error)

Un-register host VM

Types

type MachineConfig

type MachineConfig struct {
	MinikubeISO      string
	Memory           int
	CPUs             int
	DiskSize         int
	VMDriver         string
	DockerEnv        []string // Each entry is formatted as KEY=VALUE.
	DockerEngineOpt  []string
	InsecureRegistry []string
	RegistryMirror   []string
	HostOnlyCIDR     string // Only used by the virtualbox driver
	ShellProxyEnv    string // Only used for proxy purpose
}

MachineConfig contains the parameters used to start a cluster.

func (*MachineConfig) CacheMinikubeISOFromURL

func (m *MachineConfig) CacheMinikubeISOFromURL() error

CacheMinikubeISOFromURL download minishift ISO from a given URI. It also checks sha256sum if present and then put ISO to cached directory.

func (*MachineConfig) GetISOCacheFilepath

func (m *MachineConfig) GetISOCacheFilepath() string

func (*MachineConfig) GetISOFileURI

func (m *MachineConfig) GetISOFileURI() string

func (*MachineConfig) IsMinikubeISOCached

func (m *MachineConfig) IsMinikubeISOCached() bool

func (*MachineConfig) ShouldCacheMinikubeISO

func (m *MachineConfig) ShouldCacheMinikubeISO() bool