1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
|
package preflight
import (
"errors"
"fmt"
"os"
"strings"
"github.com/crc-org/crc/v2/pkg/crc/constants"
crcErrors "github.com/crc-org/crc/v2/pkg/crc/errors"
"github.com/crc-org/crc/v2/pkg/crc/logging"
"github.com/crc-org/crc/v2/pkg/crc/network"
"github.com/crc-org/crc/v2/pkg/crc/preset"
crcpreset "github.com/crc-org/crc/v2/pkg/crc/preset"
crcos "github.com/crc-org/crc/v2/pkg/os"
"github.com/crc-org/crc/v2/pkg/os/linux"
"golang.org/x/sys/unix"
)
func libvirtPreflightChecks(distro *linux.OsRelease) []Check {
checks := []Check{
{
configKeySuffix: "check-virt-enabled",
checkDescription: "Checking if Virtualization is enabled",
check: checkVirtualizationEnabled,
fixDescription: "Setting up virtualization",
fix: fixVirtualizationEnabled,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-kvm-enabled",
checkDescription: "Checking if KVM is enabled",
check: checkKvmEnabled,
fixDescription: "Setting up KVM",
fix: fixKvmEnabled,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-libvirt-installed",
checkDescription: "Checking if libvirt is installed",
check: checkLibvirtInstalled,
fixDescription: "Installing libvirt service and dependencies",
fix: fixLibvirtInstalled(distro),
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-user-in-libvirt-group",
checkDescription: "Checking if user is part of libvirt group",
check: checkUserPartOfLibvirtGroup,
fixDescription: "Adding user to libvirt group",
fix: fixUserPartOfLibvirtGroup,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-libvirt-group-active",
checkDescription: "Checking if active user/process is currently part of the libvirt group",
check: checkCurrentGroups(distro),
fixDescription: "You need to logout, re-login, and run crc setup again before the user is effectively a member of the 'libvirt' group.",
flags: NoFix,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-libvirt-running",
checkDescription: "Checking if libvirt daemon is running",
check: checkLibvirtServiceRunning,
fixDescription: "Starting libvirt service",
fix: fixLibvirtServiceRunning,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-libvirt-version",
checkDescription: "Checking if a supported libvirt version is installed",
check: checkLibvirtVersion,
fixDescription: fmt.Sprintf("libvirt v%s or newer is required and must be updated manually", minSupportedLibvirtVersion),
flags: NoFix,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-libvirt-driver",
checkDescription: "Checking if crc-driver-libvirt is installed",
check: checkMachineDriverLibvirtInstalled,
fixDescription: "Installing crc-driver-libvirt",
fix: fixMachineDriverLibvirtInstalled,
labels: labels{Os: Linux},
},
{
cleanupDescription: "Removing crc libvirt storage pool",
cleanup: removeLibvirtStoragePool,
flags: CleanUpOnly,
labels: labels{Os: Linux},
},
{
cleanupDescription: "Removing crc's virtual machine",
cleanup: removeCrcVM,
flags: CleanUpOnly,
labels: labels{Os: Linux},
},
{
configKeySuffix: "check-daemon-systemd-unit",
checkDescription: "Checking crc daemon systemd service",
check: checkDaemonSystemdService,
fixDescription: "Setting up crc daemon systemd service",
fix: fixDaemonSystemdService,
cleanupDescription: "Removing crc daemon systemd service",
cleanup: removeDaemonSystemdService,
flags: SetupOnly,
labels: labels{Os: Linux, SystemdUser: Supported},
},
{
configKeySuffix: "check-daemon-systemd-sockets",
checkDescription: "Checking crc daemon systemd socket units",
check: checkDaemonSystemdSockets,
fixDescription: "Setting up crc daemon systemd socket units",
fix: fixDaemonSystemdSockets,
cleanupDescription: "Removing crc daemon systemd socket units",
cleanup: removeDaemonSystemdSockets,
labels: labels{Os: Linux, SystemdUser: Supported},
},
{
checkDescription: "Checking if crc daemon will be autostarted",
check: warnNoDaemonAutostart,
labels: labels{Os: Linux, NetworkMode: User, SystemdUser: Unsupported},
},
}
return checks
}
var libvirtNetworkPreflightChecks = []Check{
{
configKeySuffix: "check-crc-network",
checkDescription: "Checking if libvirt 'crc' network is available",
check: checkLibvirtCrcNetworkAvailable,
fixDescription: "Setting up libvirt 'crc' network",
fix: fixLibvirtCrcNetworkAvailable,
cleanupDescription: "Removing 'crc' network from libvirt",
cleanup: removeLibvirtCrcNetwork,
labels: labels{Os: Linux, NetworkMode: System},
},
{
configKeySuffix: "check-crc-network-active",
checkDescription: "Checking if libvirt 'crc' network is active",
check: checkLibvirtCrcNetworkActive,
fixDescription: "Starting libvirt 'crc' network",
fix: fixLibvirtCrcNetworkActive,
labels: labels{Os: Linux, NetworkMode: System},
},
}
var vsockPreflightCheck = Check{
configKeySuffix: "check-vsock",
checkDescription: "Checking if vsock is correctly configured",
check: checkVsock,
fixDescription: "Setting up vsock support",
fix: fixVsock,
cleanupDescription: "Removing vsock configuration",
cleanup: removeVsockCrcSettings,
labels: labels{Os: Linux, NetworkMode: User},
}
var wsl2PreflightCheck = Check{
configKeySuffix: "check-wsl2",
checkDescription: "Checking if running inside WSL2",
check: checkRunningInsideWSL2,
fixDescription: "CRC is unsupported using WSL2",
flags: NoFix,
labels: labels{Os: Linux},
}
const (
vsockUdevSystemRulesPath = "/usr/lib/udev/rules.d/99-crc-vsock.rules"
vsockUdevLocalAdminRulesPath = "/etc/udev/rules.d/99-crc-vsock.rules"
vsockModuleAutoLoadConfPath = "/etc/modules-load.d/vhost_vsock.conf"
)
func checkVsock() error {
executable, err := os.Executable()
if err != nil {
return err
}
getcap, _, err := crcos.RunWithDefaultLocale("getcap", executable)
if err != nil {
return err
}
if !strings.Contains(getcap, "cap_net_bind_service+eip") &&
!strings.Contains(getcap, "cap_net_bind_service=eip") {
return fmt.Errorf("capabilities are not correct for %s", executable)
}
// This test is needed in order to trigger the move of the udev rule to its new location.
// The old location was used in the 1.21 release.
if !crcos.FileExists(vsockUdevLocalAdminRulesPath) {
return errors.New("vsock udev rule does not exist")
}
err = unix.Access("/dev/vsock", unix.R_OK|unix.W_OK)
if err != nil {
return errors.New("/dev/vsock is not readable by the current user")
}
return nil
}
func fixVsock() error {
executable, err := os.Executable()
if err != nil {
return err
}
_, _, err = crcos.RunPrivileged(fmt.Sprintf("Setting CAP_NET_BIND_SERVICE capability for %s executable", executable), "setcap", "cap_net_bind_service=+eip", executable)
if err != nil {
return err
}
// Remove udev rule which was used in crc 1.21 - it's been moved to a new location
err = crcos.RemoveFileAsRoot(
fmt.Sprintf("Removing udev rule in %s", vsockUdevSystemRulesPath),
vsockUdevSystemRulesPath,
)
if err != nil {
return err
}
udevRule := `KERNEL=="vsock", MODE="0660", OWNER="root", GROUP="libvirt"`
if crcos.FileContentMatches(vsockUdevLocalAdminRulesPath, []byte(udevRule)) != nil {
err = crcos.WriteToFileAsRoot("Creating udev rule for /dev/vsock", udevRule, vsockUdevLocalAdminRulesPath, 0644)
if err != nil {
return err
}
_, _, err = crcos.RunPrivileged("Reloading udev rules database", "udevadm", "control", "--reload")
if err != nil {
return err
}
}
if crcos.FileExists("/dev/vsock") && unix.Access("/dev/vsock", unix.R_OK|unix.W_OK) != nil {
_, _, err = crcos.RunPrivileged("Applying udev rule to /dev/vsock", "udevadm", "trigger", "/dev/vsock")
if err != nil {
return err
}
} else {
_, _, err = crcos.RunPrivileged("Loading vhost_vsock kernel module", "modprobe", "vhost_vsock")
if err != nil {
return err
}
}
if crcos.FileContentMatches(vsockModuleAutoLoadConfPath, []byte("vhost_vsock")) != nil {
err = crcos.WriteToFileAsRoot(fmt.Sprintf("Creating file %s", vsockModuleAutoLoadConfPath), "vhost_vsock", vsockModuleAutoLoadConfPath, 0644)
if err != nil {
return err
}
}
return nil
}
func removeVsockCrcSettings() error {
var mErr crcErrors.MultiError
err := crcos.RemoveFileAsRoot(fmt.Sprintf("Removing udev rule in %s", vsockUdevSystemRulesPath), vsockUdevSystemRulesPath)
if err != nil {
mErr.Collect(err)
}
err = crcos.RemoveFileAsRoot(fmt.Sprintf("Removing udev rule in %s", vsockUdevLocalAdminRulesPath), vsockUdevLocalAdminRulesPath)
if err != nil {
mErr.Collect(err)
}
err = crcos.RemoveFileAsRoot(fmt.Sprintf("Removing vsock module autoload file %s", vsockModuleAutoLoadConfPath), vsockModuleAutoLoadConfPath)
if err != nil {
mErr.Collect(err)
}
if len(mErr.Errors) == 0 {
return nil
}
return mErr
}
const (
Distro LabelName = iota + lastLabelName
DNS
SystemdUser
)
const (
// distro
UbuntuLike LabelValue = iota + lastLabelValue
Other
// dns
Dnsmasq
SystemdResolved
// systemd user session
Supported
Unsupported
)
func (filter preflightFilter) SetSystemdResolved(usingSystemdResolved bool) {
if usingSystemdResolved {
filter[DNS] = SystemdResolved
} else {
filter[DNS] = Dnsmasq
}
}
func (filter preflightFilter) SetDistro(distro *linux.OsRelease) {
if distroIsLike(distro, linux.Ubuntu) {
filter[Distro] = UbuntuLike
} else {
filter[Distro] = Other
}
}
func (filter preflightFilter) SetSystemdUser(distro *linux.OsRelease) {
switch {
case distroIsLike(distro, linux.RHEL) && (distro.VersionID == "7" || strings.HasPrefix(distro.VersionID, "7.")):
filter[SystemdUser] = Unsupported
default:
filter[SystemdUser] = Supported
}
}
// We want all preflight checks
// - matching the current distro
// - matching the networking daemon in use (NetworkManager or systemd-resolved) regardless of user/system networking
// - and we also want the user networking checks
func getAllPreflightChecks() []Check {
usingSystemdResolved := checkSystemdResolvedIsRunning()
filter := newFilter()
filter.SetSystemdResolved(usingSystemdResolved == nil)
filter.SetDistro(distro())
filter.SetSystemdUser(distro())
return filter.Apply(getChecks(distro(), constants.GetDefaultBundlePath(preset.OpenShift), preset.OpenShift, false))
}
func getPreflightChecks(_ bool, networkMode network.Mode, bundlePath string, preset crcpreset.Preset, enableBundleQuayFallback bool) []Check {
usingSystemdResolved := checkSystemdResolvedIsRunning()
return getPreflightChecksForDistro(distro(), networkMode, usingSystemdResolved == nil, bundlePath, preset, enableBundleQuayFallback)
}
func getPreflightChecksForDistro(distro *linux.OsRelease, networkMode network.Mode, usingSystemdResolved bool, bundlePath string, preset crcpreset.Preset, enableBundleQuayFallback bool) []Check {
filter := newFilter()
filter.SetDistro(distro)
filter.SetSystemdUser(distro)
filter.SetNetworkMode(networkMode)
filter.SetSystemdResolved(usingSystemdResolved)
return filter.Apply(getChecks(distro, bundlePath, preset, enableBundleQuayFallback))
}
func getChecks(distro *linux.OsRelease, bundlePath string, preset crcpreset.Preset, enableBundleQuayFallback bool) []Check {
var checks []Check
checks = append(checks, nonWinPreflightChecks...)
checks = append(checks, wsl2PreflightCheck)
checks = append(checks, genericPreflightChecks(preset)...)
checks = append(checks, memoryCheck(preset))
checks = append(checks, removePodmanFromOcBinDirCheck())
checks = append(checks, genericCleanupChecks...)
checks = append(checks, libvirtPreflightChecks(distro)...)
checks = append(checks, ubuntuPreflightChecks...)
checks = append(checks, nmPreflightChecks...)
checks = append(checks, systemdResolvedPreflightChecks...)
checks = append(checks, dnsmasqPreflightChecks...)
checks = append(checks, libvirtNetworkPreflightChecks...)
checks = append(checks, vsockPreflightCheck)
checks = append(checks, bundleCheck(bundlePath, preset, enableBundleQuayFallback))
return checks
}
func distroIsLike(osRelease *linux.OsRelease, osType linux.OsType) bool {
if osRelease == nil {
return false
}
if osRelease.ID == osType {
return true
}
for _, id := range osRelease.GetIDLike() {
if id == osType {
return true
}
}
return false
}
func distro() *linux.OsRelease {
distro, err := linux.GetOsRelease()
if err != nil {
logging.Errorf("cannot get distribution name: %v", err)
return &linux.OsRelease{
ID: "unknown",
}
}
return distro
}
|