vcpkg/scripts/azure-pipelines/osx/README.md

vcpkg-eg-mac VMs

This is the checklist for what the vcpkg team does when updating the macOS machines in the pool.

Creating new base images

Prerequisites

• A Parallels license for amd64 or macosvm allow-listed by macOS for arm64. Note that the directory 'Parallels' is still used when using macosvm just so that scripts know where to find the VM and friends.
• An Xcode installer - you can get this from Apple's developer website, although you'll need to sign in first: https://developer.apple.com/downloads
  If you are doing this from a local macos box, you can skip to the "update the macos host" step.

Instructions (AMD64)

• Go to https://dev.azure.com/vcpkg/public/_settings/agentqueues , pick the current osx queue, and delete one of the agents that are idle.
• Go to that machine in the KVM. (Passwords are stored as secrets in the CPP_GITHUB\vcpkg\vcpkgmm-passwords key vault)
• Open the Parallels Control Center, and delete the active VM.
• Update the macos host
• Update or install parallels
• Download the macOS installer from the app store. See https://support.apple.com/en-us/102662
  Note: This portion of the instructions is that which breaks most often depending on what Parallels and macOS are doing. You might need to use softwareupdate --fetch-full-installer --full-installer-version 14.5 and point Parallels at that resulting installer in 'Applications' instead.
• Run parallels, and select that installer you just downloaded. Name the VM "vcpkg-osx--amd64", for example "vcpkg-osx-2024-07-12-amd64".
• When creating the VM, customize the hardware to the following:
  • 12 processors
  • 24000 MB of memory
  • 350 GB disk
  • Do not share mac camera
• Install MacOS like you would on real hardware.
  • Apple ID: 'Set Up Later' / Skip
  • Account name: vcpkg
  • A very similar password :)
  • Don't enable Ask Siri
• Install Parallels Tools
• Restart the VM
• Change the desktop background to a solid color
• Enable remote login in System Settings -> General -> Sharing -> Remote Login
• Update the Azure Agent URI in setup-box.sh to the current version. You can find this by going to the agent pool, selecting "New agent", picking macOS, and copying the link. For example https://vstsagentpackage.azureedge.net/agent/3.241.0/vsts-agent-osx-x64-3.241.0.tar.gz
• Start the VM. Change the screen resolution to not be teeny weeny eyestrain o vision.
• In the guest, set the vcpkg user to be able to use sudo without a password:

  printf 'vcpkg\tALL=(ALL)\tNOPASSWD:\tALL\n' | sudo tee -a '/etc/sudoers.d/vcpkg'
  sudo chmod 0440 '/etc/sudoers.d/vcpkg'
  

• Copy setup-guest, setup-box.sh, and the xcode installer renamed to 'clt.dmg' to the host, and run setup-guest.sh. For example:

  scp ./setup-guest.sh vcpkg@MACHINE:/Users/vcpkg
  scp ./setup-box.sh vcpkg@MACHINE:/Users/vcpkg
  scp path/to/console/tools.dmg vcpkg@MACHINE:/Users/vcpkg/clt.dmg
  ssh vcpkg@MACHINE
  rm ~/.ssh/known_hosts
  chmod +x setup-guest.sh
  ./setup-guest.sh
  rm setup-guest.sh
  rm setup-box.sh
  rm clt.dmg
  

• In the guest, check that 'm4' works in the terminal. If it tries to reinstall the command line tools, let it do that. You might need to manually run this workaround from https://developer.apple.com/documentation/xcode-release-notes/xcode-15-release-notes#Known-Issues

  sudo mkdir -p /Library/Developer/CommandLineTools
  sudo touch /Library/Developer/CommandLineTools/.beta
  

• Shut down the VM cleanly
• Set the VM 'Isolated'
• In Parallels control center, right click the VM and select "Prepare for Transfer"
• In Parallels control center, right click the VM and remove it, but "Keep Files"
• Copy the packaged VM to Azure Storage, with something like:

  ssh vcpkg@MACHINE
  brew install azcopy
  azcopy copy ~/Parallels/vcpkg-osx-2024-07-12-amd64.pvmp "https://vcpkgimageminting...../pvms?<SAS>"
  azcopy copy ~/Parallels/vcpkg-osx-2024-07-12-amd64.sha256.txt "https://vcpkgimageminting...../pvms?<SAS>"
  

• Go to https://dev.azure.com/vcpkg/public/_settings/agentqueues and create a new self hosted Agent pool named PrOsx-YYYY-MM-DD based on the current date. Check 'Grant access permission to all pipelines.'
• Remove the macOS installer from Applications
• Follow the "Deploying images" steps below for each machine in the fleet.

Instructions (ARM64)

• Go to https://dev.azure.com/vcpkg/public/_settings/agentqueues , pick the current osx queue, and delete one of the agents that are idle.
• Go to that machine in the KVM. (Passwords are stored as secrets in the CPP_GITHUB\vcpkg\vcpkgmm-passwords key vault)
• Update the macos host
• (Once only) install macosvm to ~ (this tarball is also backed up in our vcpkg-image-minting storage account):

  curl -L -o macosvm-0.2-1-arm64-darwin21.tar.gz https://github.com/s-u/macosvm/releases/download/0.2-1/macosvm-0.2-1-arm64-darwin21.tar.gz
  tar xvf macosvm-0.2-1-arm64-darwin21.tar.gz
  rm macosvm-0.2-1-arm64-darwin21.tar.gz
  

• Download the matching .ipsw for the macOS copy to install. See https://mrmacintosh.com/apple-silicon-m1-full-macos-restore-ipsw-firmware-files-database/ ; links there to find the .ipsw. Example: https://updates.cdn-apple.com/2024SpringFCS/fullrestores/062-01897/C874907B-9F82-4109-87EB-6B3C9BF1507D/UniversalMac_14.5_23F79_Restore.ipsw
• Determine the VM name using the form "vcpkg-osx--arm64", for example "vcpkg-osx-2024-07-12-arm64".
• Open a terminal and run the following commands to create the VM with vcpkg-osx-2024-07-12-arm64 and UniversalMac_14.5_23F79_Restore.ipsw replaced as appropriate.

  mkdir -p ~/Parallels/vcpkg-osx-2024-07-12-arm64
  cd ~/Parallels/vcpkg-osx-2024-07-12-arm64
  ~/macosvm --disk disk.img,size=500g --aux aux.img -c 8 -r 12g --restore ~/UniversalMac_14.5_23F79_Restore.ipsw ./vm.json
  ~/macosvm -g ./vm.json
  

• Follow prompts as you would on real hardware.
  • Apple ID: 'Set Up Later' / Skip
  • Account name: vcpkg
  • A very similar password
  • No location services
  • Yes send crash reports
• Set the desktop wallpaper to a fixed color from Settings -> Wallpaper . (This makes the KVM a lot easier to use :) )
• Enable remote login in the VM: Settings -> General -> Sharing -> Remote Login
• Set the vcpkg user to be able to use sudo without a password:

  ssh vcpkg@vcpkgs-Virtual-Machine.local
  printf 'vcpkg\tALL=(ALL)\tNOPASSWD:\tALL\n' | sudo tee -a '/etc/sudoers.d/vcpkg'
  sudo chmod 0440 '/etc/sudoers.d/vcpkg'
  exit
  

• Update the Azure Agent URI in setup-box.sh to the current version. You can find this by going to the agent pool, selecting "New agent", picking macOS, and copying the link. For example https://vstsagentpackage.azureedge.net/agent/3.241.0/vsts-agent-osx-arm64-3.241.0.tar.gz
• Copy setup-box.sh and the xcode installer renamed to 'clt.dmg' to the host. For example from a dev workstation:

  scp ./setup-guest.sh vcpkg@MACHINE:/Users/vcpkg
  scp ./setup-box.sh vcpkg@MACHINE:/Users/vcpkg
  scp path/to/console/tools.dmg vcpkg@MACHINE:/Users/vcpkg/clt.dmg
  ssh vcpkg@MACHINE
  chmod +x setup-guest.sh
  rm ~/.ssh/known_hosts
  ./setup-guest.sh
  rm setup-guest.sh
  rm setup-box.sh
  rm clt.dmg
  

• In the guest, check that 'm4' works in the terminal. If it tries to reinstall the command line tools, let it do that. You might need to manually run this workaround from https://developer.apple.com/documentation/xcode-release-notes/xcode-15-release-notes#Known-Issues

  sudo mkdir -p /Library/Developer/CommandLineTools
  sudo touch /Library/Developer/CommandLineTools/.beta
  

• Shut down the VM cleanly.
• Mint a SAS token to vcpkgimageminting/pvms with read, add, create, write, and list permissions.
• Open a terminal on the host and package the VM into a tarball:

  cd ~/Parallels
  aa archive -d vcpkg-osx-<date>-arm64 -o vcpkg-osx-<date>-arm64.aar -enable-holes
  brew install azcopy
  azcopy copy vcpkg-osx-<date>-arm64.aar "https://vcpkgimageminting.blob.core.windows.net/pvms?<SAS>"
  rm *.aar
  

• Go to https://dev.azure.com/vcpkg/public/_settings/agentqueues and create a new self hosted Agent pool named PrOsx-YYYY-MM-DD-arm64 based on the current date. Check 'Grant access permission to all pipelines.'
• Follow the "Deploying images" steps below for each machine in the fleet.

Deploying images

Running the VM (AMD64)

Run these steps on each machine to add to the fleet. Skip steps that were done implicitly above if this machine was used to build a box.

• If this machine was used before, delete it from the pool of which it is a member from https://dev.azure.com/vcpkg/public/_settings/agentqueues
• Log in to the machine using the KVM.
• Check for software updates in macOS system settings
• Check for software updates in Parallels' UI
• Mint a SAS token URI to the box to use from the Azure portal if you don't already have one, and download the VM. (Recommend running this via SSH from domain joined machine due to containing SAS tokens)

  brew install azcopy
  cd ~/Parallels
  azcopy copy "https://vcpkgimageminting.blob.core.windows.net/pvms/vcpkg-osx-<DATE>-amd64.pvmp?<SAS>" .
  azcopy copy "https://vcpkgimageminting.blob.core.windows.net/pvms/vcpkg-osx-<DATE>-amd64.sha256.txt?<SAS>" .
  

• Open the .pvmp in Parallels, and unpack it.
• Start the VM
• grab a PAT if you don't already have one
• Copy the guest deploy script to the host, and run it with a first parameter of your PAT

  scp ./register-guest.sh vcpkg@MACHINE:/Users/vcpkg
  ssh vcpkg@MACHINE
  rm ~/.ssh/known_hosts
  chmod +x /Users/vcpkg/register-guest.sh
  /Users/vcpkg/register-guest.sh <PAT>
  

• Open a terminal window on the host and run the agent

  ssh -i ~/Parallels/*/id_guest vcpkg@`prlctl list --full | sed -nr 's/^.*running *([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}).*/\1/p'`
  ~/myagent/run.sh
  

• Check that the machine shows up in the pool, and lock the vcpkg user on the host.
• Lock the screen on the host.
• Update the "vcpkg Macs" spreadsheet line for the machine with the new pool.

Running the VM (ARM64)

Run these steps on each machine to add to the fleet. Skip steps that were done implicitly above if this machine was used to build a box.

• If this machine was used before, delete it from the pool of which it is a member from https://dev.azure.com/vcpkg/public/_settings/agentqueues
• Log in to the machine using the KVM.
• Check for software updates in macOS system settings
• (Once only) install macosvm to ~ (this tarball is also backed up in our vcpkg-image-minting storage account):

  curl -L -o macosvm-0.2-1-arm64-darwin21.tar.gz https://github.com/s-u/macosvm/releases/download/0.2-1/macosvm-0.2-1-arm64-darwin21.tar.gz
  tar xvf macosvm-0.2-1-arm64-darwin21.tar.gz
  rm macosvm-0.2-1-arm64-darwin21.tar.gz
  

• Skip if this is the image building machine. Mint a SAS token URI to the box to use from the Azure portal if you don't already have one, and download the VM. (Recommend running this via SSH from domain joined machine due to containing SAS tokens)

  mkdir -p ~/Parallels
  cd ~/Parallels
  azcopy copy "https://vcpkgimageminting.blob.core.windows.net/pvms/vcpkg-osx-<DATE>-arm64.aar?<SAS>" vcpkg-osx-<DATE>-arm64.aar
  aa extract -d vcpkg-osx-<DATE>-arm64 -i ./vcpkg-osx-<DATE>-arm64.aar -enable-holes
  

• Open a separate terminal window on the host and start the VM by running:

  cd ~/Parallels/vcpkg-osx-<DATE>-arm64
  ~/macosvm ./vm.json
  

• grab a PAT if you don't already have one
• Copy the guest deploy script to the host, and run it with a first parameter of your PAT. From a developer machine:

  scp ./register-guest.sh vcpkg@MACHINE:/Users/vcpkg
  ssh vcpkg@MACHINE
  rm ~/.ssh/known_hosts
  chmod +x register-guest.sh
  ./register-guest.sh <PAT>
  rm register-guest.sh
  exit
  

• In the KVM's terminal, relaunch the VM in ephemeral mode with:

  ~/macosvm --ephemeral ./vm.json
  

• Open a terminal window on the host and run the agent

  ssh -i ~/Parallels/*/id_guest vcpkg@vcpkgs-Virtual-Machine.local
  ~/myagent/run.sh
  

• Check that the machine shows up in the pool, and lock the vcpkg user on the host.
• Lock the screen on the host.
• Update the "vcpkg Macs" spreadsheet line for the machine with the new pool.

Getting an Azure Pipelines PAT

Personal Access Tokens are an important part of this process, and they are fairly easy to generate. On ADO, under the correct project (in vcpkg's case, "vcpkg"), click on the "User Settings" icon, then go to "Personal access tokens". It is the icon to the left of your user icon, in the top right corner.

Then, create a new token, give it a name, make sure it expires quickly, and give it a custom defined scope that includes the "Agent pools: Read & manage" permission (you'll need to "Show all scopes" to access this). You can now copy this token and use it to allow machines to join.