constants

Documentation

Index

• Constants
• Variables
• func AdminHelperPath() string
• func BundleForPreset(preset crcpreset.Preset, version string) string
• func EnsureBaseDirectoriesExist() error
• func GetAdminHelperExecutableForOs(os string) string
• func GetAdminHelperURL() string
• func GetAdminHelperURLForOs(os string) string
• func GetDefaultBundle(preset crcpreset.Preset) string
• func GetDefaultBundleDownloadURL(preset crcpreset.Preset) string
• func GetDefaultBundleImageRegistry(preset crcpreset.Preset) string
• func GetDefaultBundlePath(preset crcpreset.Preset) string
• func GetDefaultBundleSignedHashURL(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 GetWin32BackgroundLauncherDownloadURL() string
• func ResolveHelperPath(executableName string) string
• func Win32BackgroundLauncherPath() string

Constants

const (
	DefaultName     = "crc"
	DefaultDiskSize = 31

	DefaultPersistentVolumeSize = 15

	DefaultSSHUser = "core"
	DefaultSSHPort = 22

	CrcEnvPrefix = "CRC"

	ConfigFile                = "crc.json"
	LogFile                   = "crc.log"
	DaemonLogFile             = "crcd.log"
	CrcLandingPageURL         = "https://console.redhat.com/openshift/create/local" // #nosec G101
	DefaultAdminHelperURLBase = "https://github.com/crc-org/admin-helper/releases/download/v%s/%s"
	BackgroundLauncherURL     = "https://github.com/crc-org/win32-background-launcher/releases/download/v%s/win32-background-launcher.exe"
	DefaultBundleURLBase      = "https://mirror.openshift.com/pub/openshift-v4/clients/crc/bundles/%s/%s/%s"
	DefaultContext            = "admin"
	DaemonHTTPEndpoint        = "http://unix/api"
	DaemonVsockPort           = 1024
	DefaultPodmanNamedPipe    = `\\.\pipe\crc-podman`
	RootlessPodmanSocket      = "/run/user/1000/podman/podman.sock"
	RootfulPodmanSocket       = "/run/podman/podman.sock"

	VSockGateway = "192.168.127.1"
	VsockSSHPort = 2222
	LocalIP      = "127.0.0.1"

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

	RegistryURI         = "quay.io/crcont"
	ClusterDomain       = ".crc.testing"
	AppsDomain          = ".apps-crc.testing"
	MicroShiftAppDomain = ".apps.crc.testing"

	OpenShiftIngressHTTPPort  = 80
	OpenShiftIngressHTTPSPort = 443

	BackgroundLauncherExecutable = "crc-background-launcher.exe"
)

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

const (
	// This public key is owned by the CRC team (crc@crc.dev), and is used
	// to sign bundles uploaded to an image registry.
	// It can be fetched with: `gpg --recv-key DC7EAC400A1BFDFB`
	CrcOrgPublicKey = `` /* 684-byte string literal not displayed */

	RedHatReleaseKey = `` /* 1638-byte string literal not displayed */

)

Variables

var (
	CrcBaseDir         = filepath.Join(GetHomeDir(), ".crc")
	CrcBinDir          = filepath.Join(CrcBaseDir, "bin")
	CrcOcBinDir        = filepath.Join(CrcBinDir, "oc")
	CrcPodmanBinDir    = filepath.Join(CrcBinDir, "podman")
	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")
	PasswdFilePath     = filepath.Join(MachineInstanceDir, DefaultName, "passwd")
)

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

Functions

func AdminHelperPath

func AdminHelperPath() string

func BundleForPreset

func BundleForPreset(preset crcpreset.Preset, version string) string

func EnsureBaseDirectoriesExist

func EnsureBaseDirectoriesExist() error

EnsureBaseDirectoriesExist creates ~/.crc, ~/.crc/bin and ~/.crc/cache directories if it is not present

func GetAdminHelperExecutableForOs

func GetAdminHelperExecutableForOs(os string) string

func GetAdminHelperURL

func GetAdminHelperURL() string

func GetAdminHelperURLForOs

func GetAdminHelperURLForOs(os string) string

func GetDefaultBundle

func GetDefaultBundle(preset crcpreset.Preset) string

func GetDefaultBundleDownloadURL

func GetDefaultBundleDownloadURL(preset crcpreset.Preset) string

func GetDefaultBundleImageRegistry

func GetDefaultBundleImageRegistry(preset crcpreset.Preset) string

func GetDefaultBundlePath

func GetDefaultBundlePath(preset crcpreset.Preset) string

func GetDefaultBundleSignedHashURL

func GetDefaultBundleSignedHashURL(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 GetWin32BackgroundLauncherDownloadURL

func GetWin32BackgroundLauncherDownloadURL() string

func ResolveHelperPath

func ResolveHelperPath(executableName string) string

func Win32BackgroundLauncherPath

func Win32BackgroundLauncherPath() string