constants

Documentation

Index

• Constants
• Variables
• func BinDir() string
• func EnsureBaseDirectoriesExist() error
• func GetAdminHelperExecutable() string
• func GetAdminHelperExecutableForOs(os string) string
• func GetAdminHelperURL() string
• func GetAdminHelperURLForOs(os string) string
• func GetCRCMacTrayDownloadURL() string
• func GetCRCWindowsTrayDownloadURL() string
• func GetDefaultBundle(preset crcpreset.Preset) string
• func GetDefaultBundlePath(preset crcpreset.Preset) string
• func GetDefaultCPUs(preset crcpreset.Preset) int
• func GetDefaultMemory(preset crcpreset.Preset) int
• func GetHomeDir() string
• func GetHostDockerSocketPath() string
• func GetKubeAdminPasswordPath() string
• func GetPrivateKeyPath() string
• func GetPublicKeyPath() string
• func GetRsaPrivateKeyPath() string
• func IsRelease() bool

Constants

const (
	DefaultName     = "crc"
	DefaultDiskSize = 31

	DefaultSSHUser = "core"
	DefaultSSHPort = 22

	CrcEnvPrefix = "CRC"

	ConfigFile                = "crc.json"
	LogFile                   = "crc.log"
	DaemonLogFile             = "crcd.log"
	CrcLandingPageURL         = "https://cloud.redhat.com/openshift/create/local" // #nosec G101
	DefaultPodmanURLBase      = "https://storage.googleapis.com/libpod-master-releases"
	DefaultAdminHelperCliBase = "https://github.com/code-ready/admin-helper/releases/download/v0.0.8"
	CRCMacTrayDownloadURL     = "https://github.com/code-ready/tray-electron/releases/download/%s/crc-tray-macos.tar.gz"
	CRCWindowsTrayDownloadURL = "https://github.com/code-ready/tray-electron/releases/download/%s/crc-tray-windows.zip"
	DefaultContext            = "admin"
	DaemonHTTPEndpoint        = "http://unix/api"
	DefaultPodmanNamedPipe    = `\\.\pipe\crc-podman`

	VSockGateway = "192.168.127.1"
	VsockSSHPort = 2222

	OkdPullSecret = `{"auths":{"fake":{"auth": "Zm9vOmJhcgo="}}}` // #nosec G101

	ClusterDomain = ".crc.testing"
	AppsDomain    = ".apps-crc.testing"
)

const (
	OcExecutableName           = "oc"
	PodmanRemoteExecutableName = "podman-remote"
	TapSocketPath              = ""
)

Variables

var (
	CrcBaseDir = filepath.Join(GetHomeDir(), ".crc")

	CrcOcBinDir        = filepath.Join(crcBinDir, "oc")
	CrcSymlinkPath     = filepath.Join(crcBinDir, "crc")
	ConfigPath         = filepath.Join(CrcBaseDir, ConfigFile)
	LogFilePath        = filepath.Join(CrcBaseDir, LogFile)
	DaemonLogFilePath  = filepath.Join(CrcBaseDir, DaemonLogFile)
	MachineBaseDir     = CrcBaseDir
	MachineCacheDir    = filepath.Join(MachineBaseDir, "cache")
	MachineInstanceDir = filepath.Join(MachineBaseDir, "machines")
	DaemonSocketPath   = filepath.Join(CrcBaseDir, "crc.sock")
	KubeconfigFilePath = filepath.Join(MachineInstanceDir, DefaultName, "kubeconfig")
)

var DaemonHTTPSocketPath = filepath.Join(CrcBaseDir, "crc-http.sock")

Functions

func BinDir

func BinDir() string

func EnsureBaseDirectoriesExist

func EnsureBaseDirectoriesExist() error

EnsureBaseDirectoryExists create the ~/.crc directory if it is not present

func GetAdminHelperExecutable

func GetAdminHelperExecutable() string

func GetAdminHelperExecutableForOs

func GetAdminHelperExecutableForOs(os string) string

func GetAdminHelperURL

func GetAdminHelperURL() string

func GetAdminHelperURLForOs

func GetAdminHelperURLForOs(os string) string

func GetCRCMacTrayDownloadURL

func GetCRCMacTrayDownloadURL() string

TODO: follow the same pattern as oc and podman above

func GetCRCWindowsTrayDownloadURL

func GetCRCWindowsTrayDownloadURL() string

func GetDefaultBundle

func GetDefaultBundle(preset crcpreset.Preset) string

func GetDefaultBundlePath

func GetDefaultBundlePath(preset crcpreset.Preset) string

func GetDefaultCPUs

func GetDefaultCPUs(preset crcpreset.Preset) int

func GetDefaultMemory

func GetDefaultMemory(preset crcpreset.Preset) int

func GetHomeDir

func GetHomeDir() string

GetHomeDir returns the home directory for the current user

func GetHostDockerSocketPath

func GetHostDockerSocketPath() string

func GetKubeAdminPasswordPath

func GetKubeAdminPasswordPath() string

func GetPrivateKeyPath

func GetPrivateKeyPath() string

func GetPublicKeyPath

func GetPublicKeyPath() string

func GetRsaPrivateKeyPath

func GetRsaPrivateKeyPath() string

For backward compatibility to v 1.20.0

func IsRelease

func IsRelease() bool