[WIP] Initial PR for consuming gvproxy/macadam/cloud-init for crc-ng

.cursorrules

@@ -0,0 +1,67 @@
+# Cursor Commit Rules for crc-org/crc
+
+When generating git commit messages:
+- Follow the Conventional Commits specification format:
+    <type>[optional scope]: <subject>
+    [blank line]
+    [optional body explaining what changed and why]
+    [optional footer with references, breaking changes]
+- Use **imperative** and **present tense** in the subject line.
+- Limit the **subject line to ≈50–72 characters**; wrap body at ≈72.
+- Use meaningful scopes when it clarifies affected modules (e.g., `pkg`, `cmd`, `docs`, `test`, `tools`).
+- Prefer concise yet descriptive wording of **what changed** and **why**, not just **how**.
+- When applicable, reference related issues or pull request numbers in footer.
+
+# Allowed Commit Types
+feat:      add user-visible functionality or significant enhancements
+fix:       bug fix
+docs:      documentation only (e.g., README, docs/)
+style:     formatting, whitespace, linting (no code logic change)
+refactor:  code change that neither fixes a bug nor adds a feature
+perf:      performance improvement
+test:      adding or fixing tests
+ci:        continuous integration/config change (e.g., GitHub Actions)
+build:     build system or external dependency changes
+chore:     routine tasks without code change (scripts, config)
+
+# Type Rules
+feat:
+- New CLI subcommands or flags
+- New OpenShift, MicroShift, or podman integration options
+
+fix:
+- Correct unintended behaviors in cluster start/stop logic
+- Resolve crashes, error cases, CLI UX bugs
+
+docs:
+- Add or update CRC documentation pages
+- Fix README typos or incorrect instructions
+
+style:
+- Adjust formatting (go fmt), remove unused imports
+- Linters fixes; no functional impact
+
+refactor:
+- Extract utils, reorganize package structure
+- Rename internal functions for clarity
+
+perf:
+- Optimize CPU/memory usage in cluster operations
+
+test:
+- Add or improve unit/integration tests
+- Update CI test matrix
+
+ci:
+- CI workflow fixes or adjustments (e.g., GitHub workflows)
+
+build:
+- Update Go module versions
+- Changes to build scripts (Makefile, tooling)
+
+chore:
+- Non-code housekeeping (dependency cleanup, templating)
+
+# Footer Conventions
+- Close issues with “Closes #<number>.”
+- Denote breaking changes via `BREAKING CHANGE:` in body/footer.

Makefile

@@ -29,7 +29,7 @@ ORG := github.com/crc-org
 MODULEPATH = $(ORG)/crc/v2
 PACKAGE_DIR := packaging/$(GOOS)
 
-SOURCES := $(shell git ls-files '*.go' ":^vendor")
+SOURCES := $(shell find . -name '*.go' -not -path './vendor/*' -not -path './tools/vendor/*')
 SOURCES := $(SOURCES) go.mod go.sum Makefile
 
 RELEASE_INFO := release-info.json

cmd/crc-embedder/cmd/embed.go

@@ -13,7 +13,6 @@ import (
 	"github.com/crc-org/crc/v2/pkg/crc/logging"
 	"github.com/crc-org/crc/v2/pkg/download"
 
-	"github.com/crc-org/crc/v2/pkg/crc/machine/libvirt"
 	"github.com/crc-org/crc/v2/pkg/crc/machine/vfkit"
 
 	"github.com/YourFin/binappend"
@@ -30,7 +29,6 @@ var (
 const (
 	vfkitDriver        = "vfkit-driver"
 	vfkitEntitlement   = "vfkit-entitlement"
-	libvirtDriver      = "libvirt-driver"
 	adminHelper        = "admin-helper"
 	backgroundLauncher = "background-launcher"
 )
@@ -114,8 +112,7 @@ var (
 			adminHelper:      {constants.GetAdminHelperURLForOs("darwin"), 0755},
 		},
 		"linux": {
-			libvirtDriver: {libvirt.MachineDriverDownloadURL, 0755},
-			adminHelper:   {constants.GetAdminHelperURLForOs("linux"), 0755},
+			adminHelper: {constants.GetAdminHelperURLForOs("linux"), 0755},
 		},
 		"windows": {
 			adminHelper:        {constants.GetAdminHelperURLForOs("windows"), 0755},

cmd/crc/cmd/start.go

@@ -16,12 +16,10 @@ import (
 	"github.com/crc-org/crc/v2/pkg/crc/cluster"
 	crcConfig "github.com/crc-org/crc/v2/pkg/crc/config"
 	"github.com/crc-org/crc/v2/pkg/crc/constants"
-	"github.com/crc-org/crc/v2/pkg/crc/daemonclient"
 	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/machine/bundle"
 	"github.com/crc-org/crc/v2/pkg/crc/machine/types"
-	"github.com/crc-org/crc/v2/pkg/crc/network"
 	"github.com/crc-org/crc/v2/pkg/crc/preflight"
 	"github.com/crc-org/crc/v2/pkg/crc/preset"
 	"github.com/crc-org/crc/v2/pkg/crc/validation"
@@ -94,9 +92,10 @@ func runStart(ctx context.Context) (*types.StartResult, error) {
 	isRunning, _ := client.IsRunning()
 
 	if !isRunning {
-		if err := checkDaemonStarted(); err != nil {
+		// TODO: Uncomment this when we need it only for admin-helper
+		/*if err := checkDaemonStarted(); err != nil {
 			return nil, err
-		}
+		}*/
 
 		if err := preflight.StartPreflightChecks(config); err != nil {
 			return nil, crcos.CodeExitError{
@@ -328,6 +327,8 @@ func commandLinePrefix(shell string) string {
 	return "$"
 }
 
+// TODO: Uncomment this when we need it only for admin-helper
+/*
 func checkDaemonStarted() error {
 	if crcConfig.GetNetworkMode(config) == network.SystemNetworkingMode {
 		return nil
@@ -338,6 +339,7 @@ func checkDaemonStarted() error {
 	}
 	return daemonclient.CheckVersionMismatch(v)
 }
+*/
 
 func portFallbackWarning() string {
 	var fallbackPortWarning string

go.mod

@@ -67,7 +67,6 @@ require (
 	k8s.io/api v0.32.3
 	k8s.io/apimachinery v0.32.3
 	k8s.io/client-go v0.32.1
-	libvirt.org/go/libvirtxml v1.11010.0
 )
 
 require (

go.sum

@@ -619,8 +619,6 @@ k8s.io/kube-openapi v0.0.0-20241105132330-32ad38e42d3f h1:GA7//TjRY9yWGy1poLzYYJ
 k8s.io/kube-openapi v0.0.0-20241105132330-32ad38e42d3f/go.mod h1:R/HEjbvWI0qdfb8viZUeVZm0X6IZnxAydC7YU42CMw4=
 k8s.io/utils v0.0.0-20241210054802-24370beab758 h1:sdbE21q2nlQtFh65saZY+rRM6x6aJJI8IUa1AmH/qa0=
 k8s.io/utils v0.0.0-20241210054802-24370beab758/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
-libvirt.org/go/libvirtxml v1.11010.0 h1:lGUv6OQ4gz5Hm7F40G+swxmK/kcrMZGQ3M8/S+UyhME=
-libvirt.org/go/libvirtxml v1.11010.0/go.mod h1:7Oq2BLDstLr/XtoQD8Fr3mfDNrzlI3utYKySXF2xkng=
 sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 h1:gBQPwqORJ8d8/YNZWEjoZs7npUVDpVXUUOFfW6CgAqE=
 sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8/go.mod h1:mdzfpAEoE6DHQEN0uh9ZbOCuHbLK5wOm7dK4ctXE9Tg=
 sigs.k8s.io/randfill v0.0.0-20250304075658-069ef1bbf016/go.mod h1:XeLlZ/jmk4i1HRopwe7/aU3H5n1zNUcX6TM94b3QxOY=

pkg/crc/cache/cache.go

@@ -23,6 +23,7 @@ type Cache struct {
 	version            string
 	ignoreNameMismatch bool
 	getVersion         func(string) (string, error)
+	targetName         string // Optional: if set, rename the executable to this name
 }
 
 type VersionMismatchError struct {
@@ -84,6 +85,44 @@ func NewAdminHelperCache() *Cache {
 	)
 }
 
+func NewGvproxyCache() *Cache {
+	url := constants.GetGvproxyURL()
+	version := version.GetGvproxyVersion()
+	cache := newCache(constants.GvproxyPath(),
+		url,
+		version,
+		func(executable string) (string, error) {
+			out, _, err := crcos.RunWithDefaultLocale(executable, "--version")
+			if err != nil {
+				return "", err
+			}
+			// gvproxy --version output format: "gvproxy version v0.8.7"
+			split := strings.Split(out, " ")
+			return strings.TrimSpace(split[len(split)-1]), nil
+		},
+	)
+	cache.targetName = constants.GetGvproxyExecutableName()
+	return cache
+}
+
+func NewMacadamCache() *Cache {
+	url := constants.GetMacadamURL()
+	version := version.GetMacadamVersion()
+	return newCache(constants.MacadamPath(),
+		url,
+		version,
+		func(executable string) (string, error) {
+			out, _, err := crcos.RunWithDefaultLocale(executable, "--version")
+			if err != nil {
+				return "", err
+			}
+			// macadam version output format: "macadam version v0.2.0"
+			split := strings.Split(out, " ")
+			return strings.TrimSpace(split[len(split)-1]), nil
+		},
+	)
+}
+
 func (c *Cache) IsCached() bool {
 	if _, err := os.Stat(c.GetExecutablePath()); os.IsNotExist(err) {
 		return false
@@ -136,7 +175,12 @@ func (c *Cache) cacheExecutable() error {
 
 	// Copy the requested asset into its final destination
 	for _, extractedFilePath := range extractedFiles {
-		finalExecutablePath := filepath.Join(constants.CrcBinDir, c.GetExecutableName())
+		// Use targetName if set, otherwise use the original executable name
+		finalName := c.GetExecutableName()
+		if c.targetName != "" {
+			finalName = c.targetName
+		}
+		finalExecutablePath := filepath.Join(constants.CrcBinDir, finalName)
 		// If the file exists then remove it (ignore error) first before copy because with `0500` permission
 		// it is not possible to overwrite the file.
 		os.Remove(finalExecutablePath)

pkg/crc/cloudinit/cloudinit.go

@@ -0,0 +1,106 @@
+package cloudinit
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/crc-org/crc/v2/pkg/crc/constants"
+)
+
+// UserDataOptions contains all the options needed to generate cloud-init user-data
+type UserDataOptions struct {
+	PublicKey         string
+	PullSecret        string
+	KubeAdminPassword string
+	DeveloperPassword string
+}
+
+const userDataTemplate = `#cloud-config
+runcmd:
+  - systemctl enable --now kubelet
+write_files:
+- path: /home/core/.ssh/authorized_keys
+  content: '%s'
+  owner: core
+  permissions: '0600'
+- path: /opt/crc/id_rsa.pub
+  content: '%s'
+  owner: root:root
+  permissions: '0644'
+- path: /etc/sysconfig/crc-env
+  content: |
+    CRC_SELF_SUFFICIENT=1
+    CRC_NETWORK_MODE_USER=1
+  owner: root:root
+  permissions: '0644'
+- path: /opt/crc/pull-secret
+  content: |
+    %s
+  permissions: '0644'
+- path: /opt/crc/pass_kubeadmin
+  content: '%s'
+  permissions: '0644'
+- path: /opt/crc/pass_developer
+  content: '%s'
+  permissions: '0644'
+- path: /opt/crc/ocp-custom-domain.service.done
+  permissions: '0644'
+`
+
+// compactJSON compacts a JSON string by removing whitespace and newlines
+func compactJSON(jsonStr string) (string, error) {
+	var buf bytes.Buffer
+	if err := json.Compact(&buf, []byte(jsonStr)); err != nil {
+		return "", fmt.Errorf("failed to compact JSON: %w", err)
+	}
+	return buf.String(), nil
+}
+
+// GenerateUserData generates a cloud-init user-data file and returns the path
+func GenerateUserData(machineName string, opts UserDataOptions) (string, error) {
+	// Create the machine directory if it doesn't exist
+	machineDir := filepath.Dir(getUserDataPath(machineName))
+	if err := os.MkdirAll(machineDir, 0o750); err != nil {
+		return "", fmt.Errorf("failed to create machine directory: %w", err)
+	}
+
+	// Compact the pull secret JSON
+	compactPullSecret, err := compactJSON(opts.PullSecret)
+	if err != nil {
+		return "", fmt.Errorf("failed to compact pull secret: %w", err)
+	}
+
+	// Generate the cloud-init user-data content
+	userData := fmt.Sprintf(userDataTemplate,
+		opts.PublicKey,         // /home/core/.ssh/authorized_keys
+		opts.PublicKey,         // /opt/crc/id_rsa.pub
+		compactPullSecret,      // /opt/crc/pull-secret (compacted)
+		opts.KubeAdminPassword, // /opt/crc/pass_kubeadmin
+		opts.DeveloperPassword, // /opt/crc/pass_developer
+	)
+
+	userDataPath := getUserDataPath(machineName)
+	// Write the user-data file
+	if err := os.WriteFile(userDataPath, []byte(userData), 0o600); err != nil {
+		return "", fmt.Errorf("failed to write user-data file: %w", err)
+	}
+
+	return userDataPath, nil
+}
+
+// RemoveUserData removes the cloud-init user-data file for a machine
+func RemoveUserData(machineName string) error {
+	userDataPath := filepath.Join(constants.MachineInstanceDir, machineName, "user-data")
+	if err := os.Remove(userDataPath); err != nil && !os.IsNotExist(err) {
+		return fmt.Errorf("failed to remove user-data file: %w", err)
+	}
+	return nil
+}
+
+// getUserDataPath returns the path to the user-data file for a machine
+func getUserDataPath(machineName string) string {
+	return filepath.Join(constants.MachineInstanceDir, machineName, "user-data")
+}