Fix flaky Vagrant boots on macOS by disabling vboxsf shared folders

kubeadm-clusters/virtualbox/Vagrantfile

@@ -1,24 +1,21 @@
 # -*- mode: ruby -*-
 # vi:set ft=ruby sw=2 ts=2 sts=2:
 
-# Set the build mode
-# "BRIDGE" - Places VMs on your local network so cluster can be accessed from browser.
-#            You must have enough spare IPs on your network for the cluster nodes.
-# "NAT"    - Places VMs in a private virtual network. Cluster cannot be accessed
-#            without setting up a port forwarding rule for every NodePort exposed.
-#            Use this mode if for some reason BRIDGE doesn't work for you.
-BUILD_MODE = "BRIDGE"
-
-# Define the number of worker nodes
-# If this number is changed, remember to update setup-hosts.sh script with the new hosts IP details in /etc/hosts of each VM.
+############################################
+# Build configuration
+############################################
+
+BUILD_MODE = "BRIDGE"   # BRIDGE or NAT
 NUM_WORKER_NODES = 2
 
-# Network parameters for NAT mode
 IP_NW = "192.168.56"
 MASTER_IP_START = 11
 NODE_IP_START = 20
 
-# Host operating sysem detection
+############################################
+# Host OS detection
+############################################
+
 module OS
   def OS.windows?
     (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
@@ -28,180 +25,187 @@ module OS
     (/darwin/ =~ RUBY_PLATFORM) != nil
   end
 
-  def OS.unix?
-    !OS.windows?
-  end
-
   def OS.linux?
-    OS.unix? and not OS.mac?
-  end
-
-  def OS.jruby?
-    RUBY_ENGINE == "jruby"
+    !OS.windows? && !OS.mac?
   end
 end
 
-# Determine host adpater for bridging in BRIDGE mode
-def get_bridge_adapter()
+############################################
+# Helper methods
+############################################
+
+def get_bridge_adapter
   if OS.windows?
-    return %x{powershell -Command "Get-NetRoute -DestinationPrefix 0.0.0.0/0 | Get-NetAdapter | Select-Object -ExpandProperty InterfaceDescription"}.chomp
+    %x{powershell -Command "Get-NetRoute -DestinationPrefix 0.0.0.0/0 | Get-NetAdapter | Select-Object -ExpandProperty InterfaceDescription"}.chomp
   elsif OS.linux?
-    return %x{ip route | grep default | awk '{ print $5 }'}.chomp
+    %x{ip route | grep default | awk '{ print $5 }'}.chomp
   elsif OS.mac?
-    return %x{mac/mac-bridge.sh}.chomp
+    %x{mac/mac-bridge.sh}.chomp
   end
 end
 
-# Helper method to get the machine ID of a node.
-# This will only be present if the node has been
-# created in VirtualBox.
 def get_machine_id(vm_name)
-  machine_id_filepath = ".vagrant/machines/#{vm_name}/virtualbox/id"
-  if not File.exist? machine_id_filepath
-    return nil
-  else
-    return File.read(machine_id_filepath)
-  end
+  id_path = ".vagrant/machines/#{vm_name}/virtualbox/id"
+  File.exist?(id_path) ? File.read(id_path) : nil
 end
 
-# Helper method to determine whether all nodes are up
-def all_nodes_up()
-  if get_machine_id("controlplane").nil?
-    return false
-  end
-
+def all_nodes_up
+  return false if get_machine_id("controlplane").nil?
   (1..NUM_WORKER_NODES).each do |i|
-    if get_machine_id("node0#{i}").nil?
-      return false
-    end
+    return false if get_machine_id("node0#{i}").nil?
   end
-  return true
+  true
 end
 
-# Sets up hosts file and DNS
+############################################
+# Provisioning helpers
+############################################
+
 def setup_dns(node)
-  # Set up /etc/hosts
-  node.vm.provision "setup-hosts", :type => "shell", :path => "ubuntu/vagrant/setup-hosts.sh" do |s|
-    s.args = [IP_NW, BUILD_MODE, NUM_WORKER_NODES, MASTER_IP_START, NODE_IP_START]
-  end
-  # Set up DNS resolution
-  node.vm.provision "setup-dns", type: "shell", :path => "ubuntu/update-dns.sh"
+  node.vm.provision "setup-hosts", type: "shell",
+    path: "ubuntu/vagrant/setup-hosts.sh",
+    args: [IP_NW, BUILD_MODE, NUM_WORKER_NODES, MASTER_IP_START, NODE_IP_START]
+
+  node.vm.provision "setup-dns", type: "shell",
+    path: "ubuntu/update-dns.sh"
 end
 
-# Runs provisioning steps that are required by masters and workers
 def provision_kubernetes_node(node)
-  # Set up DNS
   setup_dns node
-  # Set up ssh
-  node.vm.provision "setup-ssh", :type => "shell", :path => "ubuntu/ssh.sh"
+  node.vm.provision "setup-ssh", type: "shell", path: "ubuntu/ssh.sh"
 end
 
-# All Vagrant configuration is done below. The "2" in Vagrant.configure
-# configures the configuration version (we support older styles for
-# backwards compatibility). Please don't change it unless you know what
-# you're doing.
+############################################
+# Vagrant configuration
+############################################
+
 Vagrant.configure("2") do |config|
-  # The most common configuration options are documented and commented below.
-  # For a complete reference, please see the online documentation at
-  # https://docs.vagrantup.com.
 
-  # Every Vagrant development environment requires a box. You can search for
-  # boxes at https://vagrantcloud.com/search.
-  # config.vm.box = "base"
+  # 🔴 CRITICAL FIX: Disable VirtualBox shared folders
+  # Prevents vboxsf race condition on macOS
+  config.vm.synced_folder ".", "/vagrant", disabled: true
 
-  config.vm.box = "ubuntu/jammy64"
+  config.vm.box_check_update = false
   config.vm.boot_timeout = 900
 
-  # Disable automatic box update checking. If you disable this, then
-  # boxes will only be checked for updates when the user runs
-  # `vagrant box outdated`. This is not recommended.
-  config.vm.box_check_update = false
+  ##########################################
+  # Host architecture detection
+  ##########################################
+
+  host_arch = `uname -m`.chomp
+
+  if host_arch == "arm64" || host_arch == "aarch64"
+    has_parallels = Vagrant.has_plugin?("vagrant-parallels")
+    has_vmware    = Vagrant.has_plugin?("vagrant-vmware-desktop")
+
+    if has_parallels
+      config.vm.box = "bento/ubuntu-22.04"
+      config.vm.provider :parallels do |p|
+        p.memory = 2048
+        p.cpus  = 2
+      end
+      puts "Using Parallels on Apple Silicon"
+
+    elsif has_vmware
+      config.vm.box = "bento/ubuntu-22.04"
+      config.vm.provider :vmware_desktop do |v|
+        v.vmx["memsize"]  = "2048"
+        v.vmx["numvcpus"] = "2"
+      end
+      puts "Using VMware on Apple Silicon"
+
+    else
+      config.vm.box = "bento/ubuntu-22.04"
+      puts <<~WARN
+        WARNING:
+        Apple Silicon detected but no Parallels/VMware plugin found.
+        VirtualBox support on ARM is limited and may be unstable.
+      WARN
+    end
+  else
+    config.vm.box = "ubuntu/jammy64"
+  end
+
+  ##########################################
+  # Control Plane
+  ##########################################
 
-  # Provision Master Nodes
   config.vm.define "controlplane" do |node|
-    # Name shown in the GUI
-    node.vm.provider "virtualbox" do |vb|
-      vb.name = "controlplane"
+    node.vm.hostname = "controlplane"
+
+    node.vm.provider :virtualbox do |vb|
+      vb.name   = "controlplane"
       vb.memory = 2048
-      vb.cpus = 2
+      vb.cpus  = 2
     end
-    node.vm.hostname = "controlplane"
+
     if BUILD_MODE == "BRIDGE"
-      adapter = ""
-      node.vm.network :public_network, bridge: get_bridge_adapter()
+      node.vm.network :public_network, bridge: get_bridge_adapter
     else
-      node.vm.network :private_network, ip: IP_NW + ".#{MASTER_IP_START}"
-      node.vm.network "forwarded_port", guest: 22, host: "#{2710}"
+      node.vm.network :private_network, ip: "#{IP_NW}.#{MASTER_IP_START}"
+      node.vm.network :forwarded_port, guest: 22, host: 2710
     end
+
     provision_kubernetes_node node
-    # Install (opinionated) configs for vim and tmux on master-1. These used by the author for CKA exam.
+
     node.vm.provision "file", source: "./ubuntu/tmux.conf", destination: "$HOME/.tmux.conf"
-    node.vm.provision "file", source: "./ubuntu/vimrc", destination: "$HOME/.vimrc"
+    node.vm.provision "file", source: "./ubuntu/vimrc",     destination: "$HOME/.vimrc"
   end
 
-  # Provision Worker Nodes
+  ##########################################
+  # Worker Nodes
+  ##########################################
+
   (1..NUM_WORKER_NODES).each do |i|
     config.vm.define "node0#{i}" do |node|
-      node.vm.provider "virtualbox" do |vb|
-        vb.name = "node0#{i}"
+      node.vm.hostname = "node0#{i}"
+
+      node.vm.provider :virtualbox do |vb|
+        vb.name   = "node0#{i}"
         vb.memory = 1024
-        vb.cpus = 1
+        vb.cpus  = 1
       end
-      node.vm.hostname = "node0#{i}"
+
       if BUILD_MODE == "BRIDGE"
-        node.vm.network :public_network, bridge: get_bridge_adapter()
+        node.vm.network :public_network, bridge: get_bridge_adapter
       else
-        node.vm.network :private_network, ip: IP_NW + ".#{NODE_IP_START + i}"
-        node.vm.network "forwarded_port", guest: 22, host: "#{2720 + i}"
+        node.vm.network :private_network, ip: "#{IP_NW}.#{NODE_IP_START + i}"
+        node.vm.network :forwarded_port, guest: 22, host: 2720 + i
       end
+
       provision_kubernetes_node node
     end
   end
 
+  ##########################################
+  # Post-start trigger (BRIDGE only)
+  ##########################################
+
   if BUILD_MODE == "BRIDGE"
-    # Trigger that fires after each VM starts.
-    # Does nothing until all the VMs have started, at which point it
-    # gathers the IP addresses assigned to the bridge interfaces by DHCP
-    # and pushes a hosts file to each node with these IPs.
     config.trigger.after :up do |trigger|
-      trigger.name = "Post provisioner"
       trigger.ignore = [:destroy, :halt]
-      trigger.ruby do |env, machine|
-        if all_nodes_up()
-          puts "    Gathering IP addresses of nodes..."
-          nodes = ["controlplane"]
-          ips = []
-          (1..NUM_WORKER_NODES).each do |i|
-            nodes.push("node0#{i}")
+
+      trigger.ruby do
+        if all_nodes_up
+          puts "Gathering node IPs..."
+
+          nodes = ["controlplane"] + (1..NUM_WORKER_NODES).map { |i| "node0#{i}" }
+          ips   = nodes.map { |n| `vagrant ssh #{n} -c 'public-ip'`.chomp }
+
+          File.open("hosts.tmp", "w") do |f|
+            ips.each_with_index { |ip, i| f.puts "#{ip} #{nodes[i]}" }
           end
+
           nodes.each do |n|
-            ips.push(%x{vagrant ssh #{n} -c 'public-ip'}.chomp)
+            system("vagrant upload hosts.tmp /tmp/hosts.tmp #{n}")
+            system("vagrant ssh #{n} -c 'sudo tee -a /etc/hosts < /tmp/hosts.tmp'")
           end
-          hosts = ""
-          ips.each_with_index do |ip, i|
-            hosts << ip << "  " << nodes[i] << "\n"
-          end
-          puts "    Setting /etc/hosts on nodes..."
-          File.open("hosts.tmp", "w") { |file| file.write(hosts) }
-          nodes.each do |node|
-            system("vagrant upload hosts.tmp /tmp/hosts.tmp #{node}")
-            system("vagrant ssh #{node} -c 'cat /tmp/hosts.tmp | sudo tee -a /etc/hosts'")
-          end
-          File.delete("hosts.tmp")
-          puts <<~EOF
 
-                 VM build complete!
-
-                 Use either of the following to access any NodePort services you create from your browser
-                 replacing "port_number" with the number of your NodePort.
+          File.delete("hosts.tmp")
 
-               EOF
-          (1..NUM_WORKER_NODES).each do |i|
-            puts "  http://#{ips[i]}:port_number"
-          end
-          puts ""
-        else
-          puts "    Nothing to do here"
+          puts "\nVM build complete!\n"
+          ips.drop(1).each { |ip| puts "  http://#{ip}:<NodePort>" }
+          puts
         end
       end
     end