From 9dac7eb2a9a7dacf6bbac20175535e4a975b9b6b Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Thu, 23 Jul 2026 14:49:34 +0530 Subject: [PATCH 1/5] Add macOS ARM64 native installer documentation - Add macOS ARM64 (Apple Silicon) to supported platforms - Document macOS DMG installation steps with curl/wget download options - Add macOS disk space requirements (/opt/hab) - Document macOS uninstall process using uninstall.sh script - Document macOS upgrade process with DMG installation - Update all platform lists to include macOS Signed-off-by: nikhil2611 --- content/install.md | 56 ++++++++++++++++++++++++++++++++++++++++++-- content/uninstall.md | 20 +++++++++++++++- content/upgrade.md | 44 +++++++++++++++++++++++++++++++++- 3 files changed, 116 insertions(+), 4 deletions(-) diff --git a/content/install.md b/content/install.md index bd3350b..ec7b2e2 100644 --- a/content/install.md +++ b/content/install.md @@ -11,8 +11,8 @@ draft = false {{< readfile file="/content/reusable/md/workstation_modularize.md" >}} -The Chef Workstation native installers provide an efficient way to install Chef Workstation on Windows, Debian, or RPM-based Linux distributions. -You can download and install the pre-built `.msi`, `.deb`, or `.rpm` packages using your existing package management tools, simplifying the deployment process for managing system configurations. +The Chef Workstation native installers provide an efficient way to install Chef Workstation on Windows, Debian, RPM-based Linux distributions, and macOS. +You can download and install the pre-built `.msi`, `.deb`, `.rpm`, or `.dmg` packages using your existing package management tools, simplifying the deployment process for managing system configurations. ## Supported platforms @@ -20,6 +20,7 @@ Chef Workstation is supported on: - Currently supported Linux distributions and versions running Linux kernel 2.6.32 and later on x86-64 (amd64) - Currently supported Windows versions greater than or equal to Windows 10 and Windows Server 2016 +- macOS 14 (Sonoma) and later on Apple Silicon (ARM64/aarch64) ## Chef Workstation requirements @@ -27,6 +28,7 @@ Chef Workstation is supported on: - **Disk space for binaries**: - Linux: The Chef Workstation binaries are stored in `/hab` and require a minimum of 2.8 GB of disk space. - Windows: The Chef Workstation binaries are stored in `C:\hab` and require a minimum of 3.3 GB of disk space. + - macOS: The Chef Workstation binaries are stored in `/opt/hab` and require a minimum of 2.8 GB of disk space. ## Prerequisites @@ -131,6 +133,56 @@ To install Chef Workstation on Windows, follow these steps: Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1_x86_64.msi`. +### Install Chef Workstation on macOS + +To install Chef Workstation on macOS (Apple Silicon), follow these steps: + +1. Download the macOS installer using one of the following methods: + + - Download using `curl`: + + ```shell + curl -o "chef-workstation-enterprise--darwin.dmg" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=aarch64&p=mac_os_x&pm=dmg&v=" + ``` + + - Download using `wget`: + + ```shell + wget -O "chef-workstation-enterprise--darwin.dmg" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=aarch64&p=mac_os_x&pm=dmg&v=" + ``` + + Replace: + - `` with the version number to install. + - `` with your Chef license ID. + +1. Mount the DMG: + + ```shell + hdiutil attach chef-workstation-enterprise--darwin.dmg + ``` + +1. Install Chef Workstation: + + ```shell + sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + ``` + + Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1`. + +1. Unmount the DMG: + + ```shell + hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + ``` + +1. Reload your shell to update PATH: + + ```shell + exec zsh + ``` + + Or open a new terminal window. + ## Verify the installation After installation, verify that Chef Workstation is installed correctly by running one of the following commands: diff --git a/content/uninstall.md b/content/uninstall.md index 633060e..4a3d6fb 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -7,7 +7,7 @@ draft = false identifier = "uninstall" +++ -Use these steps to remove Chef Workstation from Debian-based, RPM-based, or Windows systems. +Use these steps to remove Chef Workstation from Debian-based, RPM-based, Windows, or macOS systems. ## Uninstall Chef Workstation on Debian-based distributions @@ -61,6 +61,24 @@ msiexec /x chef-workstation-enterprise-_x86_64.msi Replace `` with the version number of the currently installed package. +## Uninstall Chef Workstation on macOS + +To uninstall Chef Workstation on macOS, run the uninstaller script: + +```shell +sudo /opt/hab/chef-workstation/uninstall.sh +``` + +This script will: + +- Remove all Chef Workstation binaries from `/usr/local/bin/` +- Remove the installation directory `/opt/hab/` +- Remove the PATH configuration from `/etc/paths.d/chef-workstation-enterprise` +- Remove the installation metadata from `/Library/Application Support/chef-workstation-enterprise/` +- Forget the package receipt using `pkgutil` + +After uninstalling, restart your terminal or run `exec zsh` to update your environment. + ## See also - [Install Chef Workstation](install) diff --git a/content/upgrade.md b/content/upgrade.md index ef58e41..9fccf7d 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -6,7 +6,7 @@ title = "Upgrade" identifier = "upgrade" +++ -Chef Workstation 26.1 and later uses native installers for Debian, RPM, and Windows. +Chef Workstation 26.1 and later uses native installers for Debian, RPM, Windows, and macOS. To upgrade, install the latest version for your operating system. ## Upgrade on Debian-based systems @@ -97,6 +97,48 @@ To upgrade Chef Workstation on Windows, follow these steps: Replace `` with the version number of the downloaded package. +## Upgrade on macOS + +To upgrade Chef Workstation on macOS, follow these steps: + +1. Download the latest macOS installer: + + ```shell + curl -o "chef-workstation-enterprise--darwin.dmg" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=aarch64&p=mac_os_x&pm=dmg&v=" + ``` + + Replace: + - `` with the version number to upgrade to. + - `` with your Chef license ID. + +1. Mount the DMG: + + ```shell + hdiutil attach chef-workstation-enterprise--darwin.dmg + ``` + +1. Install the new version: + + ```shell + sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + ``` + + The installer will automatically detect and upgrade your existing installation. + + Replace `` with the version number of the downloaded package. + +1. Unmount the DMG: + + ```shell + hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + ``` + +1. Reload your shell to update binaries: + + ```shell + exec zsh + ``` + ## Next steps - [Set up Workstation](/set_up/) From 86678667236ed756e6ad40d8748b9d85fc0d282d Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Thu, 23 Jul 2026 15:04:48 +0530 Subject: [PATCH 2/5] Simplify macOS documentation based on feedback - Specify macOS 14 only (remove 'and later') - Add double-click installation option like Windows - Remove shell reload instructions (exec zsh) - Simplify installation and upgrade steps Signed-off-by: nikhil2611 --- content/install.md | 34 ++++++++++------------------------ content/uninstall.md | 2 -- content/upgrade.md | 30 +++++++++--------------------- 3 files changed, 19 insertions(+), 47 deletions(-) diff --git a/content/install.md b/content/install.md index ec7b2e2..ec9b334 100644 --- a/content/install.md +++ b/content/install.md @@ -20,7 +20,7 @@ Chef Workstation is supported on: - Currently supported Linux distributions and versions running Linux kernel 2.6.32 and later on x86-64 (amd64) - Currently supported Windows versions greater than or equal to Windows 10 and Windows Server 2016 -- macOS 14 (Sonoma) and later on Apple Silicon (ARM64/aarch64) +- macOS 14 (Sonoma) on Apple Silicon (ARM64/aarch64) ## Chef Workstation requirements @@ -137,7 +137,7 @@ To install Chef Workstation on Windows, follow these steps: To install Chef Workstation on macOS (Apple Silicon), follow these steps: -1. Download the macOS installer using one of the following methods: +1. Download the installer using one of the following methods: - Download using `curl`: @@ -155,34 +155,20 @@ To install Chef Workstation on macOS (Apple Silicon), follow these steps: - `` with the version number to install. - `` with your Chef license ID. -1. Mount the DMG: +1. Install Chef Workstation using one of the following methods: - ```shell - hdiutil attach chef-workstation-enterprise--darwin.dmg - ``` + - Double-click the `.dmg` file, then double-click the `.pkg` file inside and follow the on-screen installation wizard. -1. Install Chef Workstation: + - Run the following commands: - ```shell - sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / - ``` + ```shell + hdiutil attach chef-workstation-enterprise--darwin.dmg + sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + ``` Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1`. -1. Unmount the DMG: - - ```shell - hdiutil detach /Volumes/Chef\ Workstation\ Enterprise - ``` - -1. Reload your shell to update PATH: - - ```shell - exec zsh - ``` - - Or open a new terminal window. - ## Verify the installation After installation, verify that Chef Workstation is installed correctly by running one of the following commands: diff --git a/content/uninstall.md b/content/uninstall.md index 4a3d6fb..51f876a 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -77,8 +77,6 @@ This script will: - Remove the installation metadata from `/Library/Application Support/chef-workstation-enterprise/` - Forget the package receipt using `pkgutil` -After uninstalling, restart your terminal or run `exec zsh` to update your environment. - ## See also - [Install Chef Workstation](install) diff --git a/content/upgrade.md b/content/upgrade.md index 9fccf7d..d2035a9 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -101,7 +101,7 @@ To upgrade Chef Workstation on Windows, follow these steps: To upgrade Chef Workstation on macOS, follow these steps: -1. Download the latest macOS installer: +1. Download the latest installer: ```shell curl -o "chef-workstation-enterprise--darwin.dmg" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=aarch64&p=mac_os_x&pm=dmg&v=" @@ -111,34 +111,22 @@ To upgrade Chef Workstation on macOS, follow these steps: - `` with the version number to upgrade to. - `` with your Chef license ID. -1. Mount the DMG: +1. Install the new version using one of the following methods: - ```shell - hdiutil attach chef-workstation-enterprise--darwin.dmg - ``` + - Double-click the `.dmg` file, then double-click the `.pkg` file inside and follow the on-screen installation wizard. -1. Install the new version: + - Run the following commands: - ```shell - sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / - ``` + ```shell + hdiutil attach chef-workstation-enterprise--darwin.dmg + sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + ``` The installer will automatically detect and upgrade your existing installation. Replace `` with the version number of the downloaded package. -1. Unmount the DMG: - - ```shell - hdiutil detach /Volumes/Chef\ Workstation\ Enterprise - ``` - -1. Reload your shell to update binaries: - - ```shell - exec zsh - ``` - ## Next steps - [Set up Workstation](/set_up/) From 7cddfada0e5a8d59af54a9d42cc3a85a11fa8b5c Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Thu, 23 Jul 2026 15:19:30 +0530 Subject: [PATCH 3/5] upgrading mac pkg size Signed-off-by: nikhil2611 --- content/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/install.md b/content/install.md index ec9b334..35cca28 100644 --- a/content/install.md +++ b/content/install.md @@ -28,7 +28,7 @@ Chef Workstation is supported on: - **Disk space for binaries**: - Linux: The Chef Workstation binaries are stored in `/hab` and require a minimum of 2.8 GB of disk space. - Windows: The Chef Workstation binaries are stored in `C:\hab` and require a minimum of 3.3 GB of disk space. - - macOS: The Chef Workstation binaries are stored in `/opt/hab` and require a minimum of 2.8 GB of disk space. + - macOS: The Chef Workstation binaries are stored in `/opt/hab` and require a minimum of 2.4 GB of disk space. ## Prerequisites From 92ed114b3ebb04d245446c98437fe10e136d4b5b Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Mon, 27 Jul 2026 11:44:21 +0530 Subject: [PATCH 4/5] Update hdiutil detach command to use quoted path and version tag Updated the hdiutil detach command in both install and upgrade documentation for macOS to use a quoted path format with the VERSION tag. This allows the command to work correctly with the DMG volume name that includes the version number. Changes: - install.md: Updated hdiutil detach command to use quoted path with placeholder - upgrade.md: Updated hdiutil detach command to use quoted path with placeholder Signed-off-by: Nikhil Gupta --- content/install.md | 2 +- content/upgrade.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/install.md b/content/install.md index 35cca28..36d4947 100644 --- a/content/install.md +++ b/content/install.md @@ -164,7 +164,7 @@ To install Chef Workstation on macOS (Apple Silicon), follow these steps: ```shell hdiutil attach chef-workstation-enterprise--darwin.dmg sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / - hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + hdiutil detach "/Volumes/Chef Workstation Enterprise " ``` Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1`. diff --git a/content/upgrade.md b/content/upgrade.md index d2035a9..7bc4692 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -120,7 +120,7 @@ To upgrade Chef Workstation on macOS, follow these steps: ```shell hdiutil attach chef-workstation-enterprise--darwin.dmg sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / - hdiutil detach /Volumes/Chef\ Workstation\ Enterprise + hdiutil detach "/Volumes/Chef Workstation Enterprise " ``` The installer will automatically detect and upgrade your existing installation. From 3b56e218aab2f4f0fcff95d0294f58ecfdd77c72 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Mon, 27 Jul 2026 17:02:46 +0530 Subject: [PATCH 5/5] Update sudo installer command to use quoted path and full package name with version tag Updated the sudo installer command in both install and upgrade documentation for macOS to use a quoted path format with the VERSION tag and full package name including the arm64 architecture suffix. This matches the actual DMG volume structure and ensures compatibility across versions. Changes: - install.md: Updated sudo installer command path to include version in volume and full package name - upgrade.md: Updated sudo installer command path to include version in volume and full package name Signed-off-by: Nikhil Gupta --- content/install.md | 2 +- content/upgrade.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/install.md b/content/install.md index 36d4947..c1eccbd 100644 --- a/content/install.md +++ b/content/install.md @@ -163,7 +163,7 @@ To install Chef Workstation on macOS (Apple Silicon), follow these steps: ```shell hdiutil attach chef-workstation-enterprise--darwin.dmg - sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + sudo installer -pkg "/Volumes/Chef Workstation Enterprise /chef-workstation-enterprise--1_arm64.pkg" -target / hdiutil detach "/Volumes/Chef Workstation Enterprise " ``` diff --git a/content/upgrade.md b/content/upgrade.md index 7bc4692..afe93c4 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -119,7 +119,7 @@ To upgrade Chef Workstation on macOS, follow these steps: ```shell hdiutil attach chef-workstation-enterprise--darwin.dmg - sudo installer -pkg /Volumes/Chef\ Workstation\ Enterprise/chef-workstation-enterprise-.pkg -target / + sudo installer -pkg "/Volumes/Chef Workstation Enterprise /chef-workstation-enterprise--1_arm64.pkg" -target / hdiutil detach "/Volumes/Chef Workstation Enterprise " ```