From 2dbe6f19722c2f7034d4805ba36823f23ed6de2a Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Tue, 23 Jun 2026 16:53:19 +0530 Subject: [PATCH 1/7] docs: update native installer install and upgrade guidance Signed-off-by: nikhil2611 --- content/install.md | 267 ++++++++++++++----------------------------- content/uninstall.md | 92 +++++++-------- content/upgrade.md | 115 +++++++++++++++---- 3 files changed, 227 insertions(+), 247 deletions(-) diff --git a/content/install.md b/content/install.md index aa9672d..6eacc74 100644 --- a/content/install.md +++ b/content/install.md @@ -1,5 +1,5 @@ +++ -title = "Install Chef Workstation" +title = "Chef Workstation install guide" draft = false @@ -12,241 +12,151 @@ draft = false {{< readfile file="/content/reusable/md/workstation_modularize.md" >}} -## System requirements +Chef Workstation 26.1 installers are available for Windows, Debian, and RPM-based Linux distributions. -Chef Workstation has the following requirements: +You can download and install pre-built `.msi`, `.deb`, or `.rpm` packages using your existing package management tools. -- Linux and Windows x86-64 (64-bit) systems only -- Chef Habitat 1.6.0 or later installed -- Minimum 2GB available disk space for installation -- Internet connectivity for package downloads (or access to internal Habitat Builder) +## Supported platforms -## Prerequisites - -We use Chef Habitat to distribute and install Chef Workstation and its components. +Chef Workstation is supported on the following platforms: -To install and configure Chef Habitat so you can install and manage Chef Workstation, follow these steps: +- Windows x86-64 +- Linux x86-64 -1. [Install Chef Habitat](https://docs.chef.io/habitat/latest/install/) +## Prerequisites -1. [Create a personal access token in Habitat Builder](https://docs.chef.io/habitat/builder/saas/builder_profile/#create-a-personal-access-token) +This installation process has the following prerequisites: -1. Run [`hab cli setup`](https://docs.chef.io/habitat/latest/install/hab_setup/) and follow the instructions in the setup script and add your personal access token so you can authenticate with Habitat Builder. +- Chef Client isn't installed on the target system. +- On Windows systems, tar is installed. +- On Debian-based systems, the `dpkg` package manager is installed. +- On RPM-based systems, `rpm` and either `dnf` or `yum` are installed. For Amazon Linux 2, use `rpm` and `yum`. +- You have a valid Progress Chef license key. +- The target system is connected to the internet. ## Install Chef Workstation -Chef Workstation supports several installation methods to accommodate different deployment scenarios. - -### Install with binary linking (recommended) - -The recommended installation method includes binary linking, which creates symbolic links to the package binaries in your system PATH. This allows you to execute the command directly without the full Habitat exec syntax: - -```shell -hab pkg install chef/chef-workstation --binlink --force -``` - -This command uses the following options to binlink Workstation to your system's PATH: - -- `--binlink` binlinks the package binary to your system PATH. -- `--force` overwrites existing binlinks. - -### Install from the unstable channel - -To install a pre-release version, install from the unstable channel: - -```shell -hab pkg install chef/chef-workstation --channel unstable -``` - -### Install a specific version of Chef Workstation 26 - -If you need to install a particular version of Chef Workstation, specify the version and timestamp in the package identifier: - -```shell -hab pkg install chef/chef-workstation// -``` - -For example, to install version 26.0.15 with timestamp 20260320102857, run the following command: - -```shell -hab pkg install chef/chef-workstation/26.0.15/20260320102857 -``` - -### Install additional versions of Chef Workstation's component tools - -You can install multiple versions of Chef Workstation's component tools side-by-side with the versions included with Chef Workstation, including Chef Infra Client. - -To install an additional version of a Workstation component alongside the default version, run the following command: - -```shell -hab pkg install -``` - -Replace `` with the full package identifier with the version, for example `chef/chef-infra-client/18.10.17`. +### Install Chef Workstation on Debian-based systems -To execute the specific version, run the `hab pkg exec` command, specify the full package identifier including the package version, and the command you want to run: +To install Chef Workstation on a Debian-based system, follow these steps: -```shell -hab pkg exec -``` +1. Download the Debian-based installer using one of the following methods: -For example, to run Chef Infra Client 18.10.17: + - Download using `wget`: -```shell -hab pkg exec chef/chef-infra-client/18.10.17 chef-client -``` + ```sh + wget -O "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" + ``` -To run Chef Infra Client 19.2.12, run: + - Download using `curl`: -```shell -hab pkg exec chef/chef-infra-client/19.2.12 chef-client -``` + ```sh + curl -o "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" + ``` -To run the binlinked version: + Replace: + - `` with the version number to install. + - `` with your Chef license ID. -```shell -chef-client -``` +1. Install Chef Workstation: -### Verify the installation + ```sh + sudo dpkg -i chef-workstation-enterprise-_amd64.deb + ``` -After installation, verify that Chef Workstation is installed correctly: + Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1_amd64.deb`. -```shell -chef-workstation -v -``` +### Install Chef Workstation on RPM-based systems -or +To install Chef Workstation on an RPM-based system, follow these steps: -```shell -chef -v -``` +1. Download the RPM-based installer using one of the following methods: -A successful installation displays the installed version of Chef Workstation and the versions of its component tools. + - Download using `wget`: -### Use the bundled tools + ```sh + wget -O "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" + ``` -Chef Workstation provides two primary methods for executing the bundled tools. + - Download using `curl`: -#### Method 1: Use direct executables with binary linking + ```sh + curl -o "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" + ``` -Binary linking creates symbolic links to package executables in a system-wide location, allowing you to invoke tools directly without the Habitat exec prefix. This method provides a more familiar command-line experience similar to traditional package installations. + Replace: + - `` with the version number to install. + - `` with your Chef license ID. -To enable binary linking during installation, include the `--binlink` flag: +1. Install Chef Workstation using one of the following methods: -```shell -hab pkg install chef/chef-workstation --binlink -``` + - Install using `rpm`: -If you have already installed Chef Workstation without binary linking, you can enable it afterward: + ```sh + sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm + ``` -```shell -hab pkg binlink chef/chef-workstation -``` + - Install using `dnf`: -Once binary linking is enabled, you can invoke tools directly from the command line: + ```sh + sudo dnf install ./chef-workstation-enterprise-.x86_64.rpm + ``` -```shell -kitchen -v -chef-cli -v -chef-client --version -berks -v -inspec version -knife -v -``` + - For Amazon Linux 2 or systems using `yum`: -#### Method 2: Use Habitat exec + ```sh + sudo yum install ./chef-workstation-enterprise-.x86_64.rpm + ``` -The `hab pkg exec` command provides explicit control over which package and version is used to run a command. Use this method when you need to ensure a specific version is used or when binary linking isn't available. + Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1.x86_64.rpm`. -The general syntax is: +### Install Chef Workstation on Windows -```shell -hab pkg exec -``` - -The following table provides examples of common tool invocations using the Habitat exec method: - -| Tool | Command | Version Command | -|-------------------|------------------------------------------------------------|-----------------------| -| Test Kitchen | hab pkg exec chef/chef-test-kitchen-enterprise kitchen | kitchen -v | -| Chef CLI | hab pkg exec chef/chef-cli chef-cli | chef-cli -v | -| Chef Infra Client | hab pkg exec chef/chef-infra-client chef-client | chef-client --version | -| Berkshelf | hab pkg exec chef/berkshelf berks | berks -v | -| Ohai | hab pkg exec chef/ohai ohai | ohai --version | -| Cookstyle | hab pkg exec chef/cookstyle cookstyle | cookstyle -v | -| Chef Vault | hab pkg exec chef/chef-vault chef-vault | chef-vault -v | -| Fauxhai | hab pkg exec chef/fauxhai fauxhai | fauxhai -v | -| Chef InSpec | hab pkg exec chef/inspec inspec | inspec version | -| knife | hab pkg exec chef/knife knife | knife -v | - -## Install Chef Workstation tools - -The following applications are included with Chef Workstation but can also be installed as standalone applications. - -To install a Workstation tool as a standalone application, follow these steps: +To install Chef Workstation on Windows, follow these steps: -1. Install a package using [`hab pkg install`](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-install): +1. Download the installer in an elevated PowerShell session: - ```sh - hab pkg install --binlink --force - ``` + ```powershell + Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise--windows.msi" + ``` - Replace `` with the package identifier: + Replace: + - `` with the version number to install. + - `` with your Chef license ID. - - `chef/berkshelf` - - `chef/chef-cli` - - `chef/chef-infra-client` - - `chef/chef-test-kitchen-enterprise` - - `chef/chef-vault` - - `chef/cookstyle` - - `chef/fauxhai` - - `chef/inspec` - - `chef/knife` - - `chef/ohai` +1. Install Chef Workstation using one of the following methods: - The `--binlink --force` options overwrite any existing package symbolic links in the system's PATH directory with the new version so you can run it directly in the command line. + - Run the following command in an elevated PowerShell or Command Prompt session: -1. Verify that the correct version runs: + ```powershell + msiexec /i chef-workstation-enterprise--x64.msi /qn + ``` - ```sh - berks -v - chef-cli -v - chef-client -v - chef-vault - cookstyle -v - fauxhai -v - knife -v - ohai -v - ``` + - Double-click the `.msi` file and follow the on-screen installation wizard. -## Troubleshooting + Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1_x64.msi`. -### Binlinks not found +## Verify the installation -If commands aren't found after installation, verify that Chef Habitat created the binlinks: +After installation, verify that Chef Workstation is installed correctly by running one of the following commands: ```sh -ls -la /bin | grep chef +chef-workstation -v ``` -If binlinks are missing, recreate them: +or ```sh -hab pkg binlink --force chef/chef-workstation +chef -v ``` -### Permission errors +The output displays the installed Chef Workstation version. -Ensure you're running installation commands with `sudo` for system-wide access. +## Upgrade Chef Workstation -### Habitat channel issues +To upgrade Chef Workstation to a newer version: -If the package can't be found, verify channel availability: - -```sh -hab pkg search chef/chef-workstation --channel unstable -``` +1. Download and install the new version using the steps for your platform on this page. ## Next steps @@ -256,5 +166,4 @@ hab pkg search chef/chef-workstation --channel unstable ## More information -- [Chef Habitat documentation](https://docs.chef.io/habitat/) -- [Upgrade Chef Workstation and its components](upgrade) +- [Chef Download API documentation](https://docs.chef.io/download/) diff --git a/content/uninstall.md b/content/uninstall.md index ec287a5..80409a8 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -1,68 +1,68 @@ +++ -title = "Uninstall Chef Workstation and its tools" +title = "Uninstall Chef Workstation" +draft = false [menu.uninstall] -title = "Uninstall" -identifier = "uninstall" -weight = 50 + title = "Uninstall" + identifier = "uninstall" +++ -The page documents how to uninstall Chef Workstation and its component tools. +## Uninstall Chef Workstation on Debian-based distributions -## Uninstall Chef Workstation +To uninstall Chef Workstation, follow these steps: -To uninstall Chef Workstation, use the [`hab pkg uninstall`](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-uninstall) command: +1. Remove the package: -```sh -hab pkg uninstall chef/chef-workstation -``` + ```sh + sudo apt-get purge chef-workstation-enterprise + ``` -Uninstalling `chef/chef-workstation` removes all bundled component tools: +1. Verify that the package has been removed: -- `chef/berkshelf` -- `chef/chef-cli` -- `chef/chef-infra-client` -- `chef/chef-test-kitchen-enterprise` -- `chef/chef-vault` -- `chef/cookstyle` -- `chef/fauxhai` -- `chef/knife` -- `chef/ohai` -- `chef/inspec` + ```sh + dpkg -l chef-workstation-enterprise + ``` -## Uninstall Chef Workstation Tools + The command returns no output if the package is removed successfully. -If you installed a Workstation tool as a standalone application, you can uninstall it without uninstalling the entire Workstation package. +## Uninstall Chef Workstation on RPM-based distributions -To uninstall a Workstation tool, use the [`hab pkg uninstall`](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-uninstall) command: +To uninstall Chef Workstation, follow these steps: -```sh -hab pkg uninstall -``` +1. Remove the package. -Replace `` with one of the following packages: + - Using `dnf`: -- `chef/berkshelf` -- `chef/chef-cli` -- `chef/chef-infra-client` -- `chef/chef-test-kitchen-enterprise` -- `chef/chef-vault` -- `chef/cookstyle` -- `chef/fauxhai` -- `chef/knife` -- `chef/ohai` + ```sh + sudo dnf remove chef-workstation-enterprise + ``` -## Uninstall a specific package version + - For Amazon Linux 2 or systems using `yum`: -If you installed specific tool versions, you can uninstall a specific version without uninstalling all versions of the package. + ```sh + sudo yum remove chef-workstation-enterprise + ``` -To uninstall a specific package version, run the following command: +1. Verify that the package has been removed: -```sh -hab pkg uninstall -``` + ```sh + rpm -qa chef-workstation-enterprise + ``` + + The command returns no output if the package is removed successfully. + +## Uninstall Chef Workstation on Windows -Replace `` with one of the following: +To uninstall using the Windows UI: + +1. Open **Settings > Apps > Installed apps**. +1. Search for **Chef Workstation**. +1. Select **Uninstall**, then follow the on-screen prompts. + +To uninstall from the command line, run the following command in an elevated PowerShell or Command Prompt session: + +```powershell +msiexec /x chef-workstation-enterprise--x64.msi /qn +``` -- the package and version, for example `chef//`. -- the package version and build, for example `chef///` +Replace `` with the version number of the currently installed package. diff --git a/content/upgrade.md b/content/upgrade.md index 0fd3c9e..d4ae46f 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -6,35 +6,106 @@ title = "Upgrade" identifier = "upgrade" +++ -Use the following command to upgrade Chef Workstation or one of its components: +Chef Workstation 26.1 and later are distributed as installers for Debian, RPM, and Windows. +To upgrade, install the latest version for your operating system. -```sh -hab pkg install --binlink --force -``` +## Upgrade on Debian-based systems -Replace `` with the package identifier. +To upgrade Chef Workstation on a Debian-based system, follow these steps: -To update to the latest version, specify the origin and package: +1. Download the latest Debian-based installer using one of the following methods: -- `chef/chef-workstation` -- `chef/berkshelf` -- `chef/chef-cli` -- `chef/chef-infra-client` -- `chef/chef-test-kitchen-enterprise` -- `chef/chef-vault` -- `chef/cookstyle` -- `chef/fauxhai` -- `chef/knife` -- `chef/ohai` + - Download using `wget`: -To update to a specific package version, include the version. For example: + ```sh + wget -O "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" + ``` -- `chef//` + - Download using `curl`: -To update to specific release build, include the package version and build timestamp. For example: + ```sh + curl -o "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" + ``` -- `chef//` + Replace: + - `` with the version number to upgrade to. + - `` with your Chef license ID. -The `--binlink --force` options overwrite existing package symbolic links in the system's PATH directory with the new version so you can run it directly in the command line. +1. Install the new version: -If you omit `--binlink --force`, Chef Habitat installs the new version alongside existing versions. To execute this version, you'd have to invoke the package's file path, for example `/hab/bin/hab pkg exec chef/ `. + ```sh + sudo dpkg -i chef-workstation-enterprise-_amd64.deb + ``` + + Replace `` with the version number of the downloaded package. + +## Upgrade on RPM-based systems + +To upgrade Chef Workstation on an RPM-based system, follow these steps: + +1. Download the latest RPM-based installer using one of the following methods: + + - Download using `wget`: + + ```sh + wget -O "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" + ``` + + - Download using `curl`: + + ```sh + curl -o "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" + ``` + + Replace: + - `` with the version number to upgrade to. + - `` with your Chef license ID. + +1. Install the new version using one of the following methods: + + - Install using `rpm`: + + ```sh + sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm + ``` + + - Install using `dnf`: + + ```sh + sudo dnf install ./chef-workstation-enterprise-.x86_64.rpm + ``` + + - For Amazon Linux 2 or systems using `yum`: + + ```sh + sudo yum install ./chef-workstation-enterprise-.x86_64.rpm + ``` + + Replace `` with the version number of the downloaded package. + +## Upgrade on Windows + +To upgrade Chef Workstation on Windows, follow these steps: + +1. Download the latest Windows installer: + + ```powershell + Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise--x64.msi" + ``` + + Replace: + - `` with the version number to upgrade to. + - `` with your Chef license ID. + +1. Install the new version: + + ```powershell + msiexec /i chef-workstation-enterprise--x64.msi /qn + ``` + + Replace `` with the version number of the downloaded package. + +## Next steps + +- [Set up Workstation](/set_up/) +- [Add a license](/license/) From 9697b201cc38294194d7f3406ae08073e23d7518 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Fri, 26 Jun 2026 16:12:27 +0530 Subject: [PATCH 2/7] docs: update install page wording and add system requirements - Update intro paragraph to match Chef Infra Client style - Update supported platforms with detailed descriptions - Add Chef Workstation requirements section (RAM, disk, processor) - Update prerequisites to match Infra Client wording Signed-off-by: nikhil2611 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- content/install.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/content/install.md b/content/install.md index 6eacc74..f94adbe 100644 --- a/content/install.md +++ b/content/install.md @@ -12,25 +12,32 @@ draft = false {{< readfile file="/content/reusable/md/workstation_modularize.md" >}} -Chef Workstation 26.1 installers are available for Windows, Debian, and RPM-based Linux distributions. - -You can download and install pre-built `.msi`, `.deb`, or `.rpm` packages using your existing package management tools. +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. ## Supported platforms -Chef Workstation is supported on the following platforms: +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 + +## Chef Workstation requirements -- Windows x86-64 -- Linux x86-64 +- **RAM**: Chef Workstation requires a minimum of 1 GB of RAM. +- **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. +- **Processor**: The processor must be supported. We recommend 1 GHz or faster, but the processor speed should be based on other system loads. ## Prerequisites This installation process has the following prerequisites: - Chef Client isn't installed on the target system. -- On Windows systems, tar is installed. -- On Debian-based systems, the `dpkg` package manager is installed. -- On RPM-based systems, `rpm` and either `dnf` or `yum` are installed. For Amazon Linux 2, use `rpm` and `yum`. +- On Debian-based systems, the `dpkg` package manager is installed on the target system. +- On RPM-based systems, the RPM and either the DNF or Yum package managers are installed on the target system. +- For Amazon Linux 2, use the RPM and Yum package managers. - You have a valid Progress Chef license key. - The target system is connected to the internet. From 731d8c79ff075c584f05de3bc68c7ec22817aecf Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Tue, 30 Jun 2026 00:45:50 +0530 Subject: [PATCH 3/7] docs: address PR review comments - Remove ambiguous Processor requirement line - Remove redundant Upgrade section from install.md - Update RPM install/upgrade to use dnf and rpm pattern - Add rpm -e method to uninstall for consistency - Fix Windows MSI filename to _x86_64.msi across all docs Signed-off-by: nikhil2611 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- content/install.md | 37 +++++++++++-------------------------- content/uninstall.md | 18 ++++++++---------- content/upgrade.md | 28 ++++++++++------------------ 3 files changed, 29 insertions(+), 54 deletions(-) diff --git a/content/install.md b/content/install.md index f94adbe..fb7e7e7 100644 --- a/content/install.md +++ b/content/install.md @@ -28,7 +28,6 @@ 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. -- **Processor**: The processor must be supported. We recommend 1 GHz or faster, but the processor speed should be based on other system loads. ## Prerequisites @@ -95,25 +94,17 @@ To install Chef Workstation on an RPM-based system, follow these steps: - `` with the version number to install. - `` with your Chef license ID. -1. Install Chef Workstation using one of the following methods: - - - Install using `rpm`: - - ```sh - sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm - ``` - - - Install using `dnf`: +1. Install Chef Workstation: - ```sh - sudo dnf install ./chef-workstation-enterprise-.x86_64.rpm - ``` + ```sh + sudo dnf install chef-workstation-enterprise-.x86_64.rpm + ``` - - For Amazon Linux 2 or systems using `yum`: + or: - ```sh - sudo yum install ./chef-workstation-enterprise-.x86_64.rpm - ``` + ```sh + sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm + ``` Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1.x86_64.rpm`. @@ -124,7 +115,7 @@ To install Chef Workstation on Windows, follow these steps: 1. Download the installer in an elevated PowerShell session: ```powershell - Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise--windows.msi" + Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise-_x86_64.msi" ``` Replace: @@ -136,12 +127,12 @@ To install Chef Workstation on Windows, follow these steps: - Run the following command in an elevated PowerShell or Command Prompt session: ```powershell - msiexec /i chef-workstation-enterprise--x64.msi /qn + msiexec /i chef-workstation-enterprise-_x86_64.msi /qn ``` - Double-click the `.msi` file and follow the on-screen installation wizard. - Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1_x64.msi`. + Replace `` with the version number of the downloaded package, for example `chef-workstation-enterprise-26.1.0-1_x86_64.msi`. ## Verify the installation @@ -159,12 +150,6 @@ chef -v The output displays the installed Chef Workstation version. -## Upgrade Chef Workstation - -To upgrade Chef Workstation to a newer version: - -1. Download and install the new version using the steps for your platform on this page. - ## Next steps - [Set up Workstation](set_up) diff --git a/content/uninstall.md b/content/uninstall.md index 80409a8..787912d 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -31,17 +31,15 @@ To uninstall Chef Workstation, follow these steps: 1. Remove the package. - - Using `dnf`: - - ```sh - sudo dnf remove chef-workstation-enterprise - ``` + ```sh + sudo dnf remove chef-workstation-enterprise + ``` - - For Amazon Linux 2 or systems using `yum`: + or: - ```sh - sudo yum remove chef-workstation-enterprise - ``` + ```sh + sudo rpm -e chef-workstation-enterprise + ``` 1. Verify that the package has been removed: @@ -62,7 +60,7 @@ To uninstall using the Windows UI: To uninstall from the command line, run the following command in an elevated PowerShell or Command Prompt session: ```powershell -msiexec /x chef-workstation-enterprise--x64.msi /qn +msiexec /x chef-workstation-enterprise-_x86_64.msi /qn ``` Replace `` with the version number of the currently installed package. diff --git a/content/upgrade.md b/content/upgrade.md index d4ae46f..89cbf93 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -61,25 +61,17 @@ To upgrade Chef Workstation on an RPM-based system, follow these steps: - `` with the version number to upgrade to. - `` with your Chef license ID. -1. Install the new version using one of the following methods: - - - Install using `rpm`: - - ```sh - sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm - ``` - - - Install using `dnf`: +1. Install the new version: - ```sh - sudo dnf install ./chef-workstation-enterprise-.x86_64.rpm - ``` + ```sh + sudo dnf install chef-workstation-enterprise-.x86_64.rpm + ``` - - For Amazon Linux 2 or systems using `yum`: + or: - ```sh - sudo yum install ./chef-workstation-enterprise-.x86_64.rpm - ``` + ```sh + sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm + ``` Replace `` with the version number of the downloaded package. @@ -90,7 +82,7 @@ To upgrade Chef Workstation on Windows, follow these steps: 1. Download the latest Windows installer: ```powershell - Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise--x64.msi" + Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=windows&pm=msi&v=" -OutFile "chef-workstation-enterprise-_x86_64.msi" ``` Replace: @@ -100,7 +92,7 @@ To upgrade Chef Workstation on Windows, follow these steps: 1. Install the new version: ```powershell - msiexec /i chef-workstation-enterprise--x64.msi /qn + msiexec /i chef-workstation-enterprise-_x86_64.msi /qn ``` Replace `` with the version number of the downloaded package. From ae3e13914d11faec3d23a10be856006e80b4198b Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Tue, 30 Jun 2026 12:01:39 +0530 Subject: [PATCH 4/7] docs: address clintoncwolfe review comments - Revert title to 'Install Chef Workstation' - Add back individual components section as a la carte alternative - Remove hab pkg install URL link Signed-off-by: nikhil2611 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- content/install.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/content/install.md b/content/install.md index fb7e7e7..44415a0 100644 --- a/content/install.md +++ b/content/install.md @@ -1,5 +1,5 @@ +++ -title = "Chef Workstation install guide" +title = "Install Chef Workstation" draft = false @@ -150,6 +150,30 @@ chef -v The output displays the installed Chef Workstation version. +## Install individual components + +The following tools are included with Chef Workstation but can also be installed individually using Chef Habitat. +If you only need specific tools rather than the full Workstation package, install them as standalone applications: + +1. Install a package using [`hab pkg install`](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-install): + + ```sh + hab pkg install --binlink --force + ``` + + Replace `` with the package identifier: + + - `chef/berkshelf` + - `chef/chef-cli` + - `chef/chef-infra-client` + - `chef/chef-test-kitchen-enterprise` + - `chef/chef-vault` + - `chef/cookstyle` + - `chef/fauxhai` + - `chef/inspec` + - `chef/knife` + - `chef/ohai` + ## Next steps - [Set up Workstation](set_up) From 45ec1605ae1973895c69b40cad82932537327fc0 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Wed, 1 Jul 2026 16:00:01 +0530 Subject: [PATCH 5/7] Remove rpm -e uninstall command Keep RPM uninstall instructions focused on dnf remove by removing the redundant rpm -e command. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> (cherry picked from commit 6058dfdc51abd00427ffb1a8958845c7735cd1cd) Signed-off-by: nikhil2611 --- content/uninstall.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/content/uninstall.md b/content/uninstall.md index 787912d..40cacd7 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -35,12 +35,6 @@ To uninstall Chef Workstation, follow these steps: sudo dnf remove chef-workstation-enterprise ``` - or: - - ```sh - sudo rpm -e chef-workstation-enterprise - ``` - 1. Verify that the package has been removed: ```sh From 296eb684f345e953fa0f847fc40827ecc60ff8cd Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Thu, 2 Jul 2026 14:04:49 +0530 Subject: [PATCH 6/7] Remove /qn flag from Windows MSI commands Remove the silent install flag /qn from msiexec commands in install, upgrade, and uninstall docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 --- content/install.md | 2 +- content/uninstall.md | 2 +- content/upgrade.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/install.md b/content/install.md index 44415a0..65c24b9 100644 --- a/content/install.md +++ b/content/install.md @@ -127,7 +127,7 @@ To install Chef Workstation on Windows, follow these steps: - Run the following command in an elevated PowerShell or Command Prompt session: ```powershell - msiexec /i chef-workstation-enterprise-_x86_64.msi /qn + msiexec /i chef-workstation-enterprise-_x86_64.msi ``` - Double-click the `.msi` file and follow the on-screen installation wizard. diff --git a/content/uninstall.md b/content/uninstall.md index 40cacd7..43404f9 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -54,7 +54,7 @@ To uninstall using the Windows UI: To uninstall from the command line, run the following command in an elevated PowerShell or Command Prompt session: ```powershell -msiexec /x chef-workstation-enterprise-_x86_64.msi /qn +msiexec /x chef-workstation-enterprise-_x86_64.msi ``` Replace `` with the version number of the currently installed package. diff --git a/content/upgrade.md b/content/upgrade.md index 89cbf93..c1fd7d8 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -92,7 +92,7 @@ To upgrade Chef Workstation on Windows, follow these steps: 1. Install the new version: ```powershell - msiexec /i chef-workstation-enterprise-_x86_64.msi /qn + msiexec /i chef-workstation-enterprise-_x86_64.msi ``` Replace `` with the version number of the downloaded package. From 172e5aaeee85ec2806d308d374acc7207ad3ea1a Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Tue, 7 Jul 2026 13:44:02 -0400 Subject: [PATCH 7/7] Editing Signed-off-by: Ian Maddaus --- content/install.md | 44 +++++++++++++++++------------------ content/tools/berkshelf.md | 3 ++- content/tools/knife/_index.md | 2 ++ content/uninstall.md | 17 ++++++++++---- content/upgrade.md | 23 +++++++++++------- 5 files changed, 52 insertions(+), 37 deletions(-) diff --git a/content/install.md b/content/install.md index 65c24b9..bd3350b 100644 --- a/content/install.md +++ b/content/install.md @@ -1,12 +1,11 @@ +++ -title = "Install Chef Workstation" +title = "Chef Workstation install guide" draft = false - [menu] [menu.install] title = "Install" - identifier = "install.md Install Chef Workstation" + identifier = "install.md Chef Workstation install guide" weight = 10 +++ @@ -31,14 +30,12 @@ Chef Workstation is supported on: ## Prerequisites -This installation process has the following prerequisites: - -- Chef Client isn't installed on the target system. -- On Debian-based systems, the `dpkg` package manager is installed on the target system. -- On RPM-based systems, the RPM and either the DNF or Yum package managers are installed on the target system. +- Chef Infra Client isn't installed on your target system. +- On Debian-based systems, the `dpkg` package manager is installed on your target system. +- On RPM-based systems, the RPM and either the DNF or Yum package managers are installed on your target system. - For Amazon Linux 2, use the RPM and Yum package managers. - You have a valid Progress Chef license key. -- The target system is connected to the internet. +- Your target system is connected to the internet. ## Install Chef Workstation @@ -50,13 +47,13 @@ To install Chef Workstation on a Debian-based system, follow these steps: - Download using `wget`: - ```sh + ```shell wget -O "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" ``` - Download using `curl`: - ```sh + ```shell curl -o "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" ``` @@ -66,7 +63,7 @@ To install Chef Workstation on a Debian-based system, follow these steps: 1. Install Chef Workstation: - ```sh + ```shell sudo dpkg -i chef-workstation-enterprise-_amd64.deb ``` @@ -80,13 +77,13 @@ To install Chef Workstation on an RPM-based system, follow these steps: - Download using `wget`: - ```sh + ```shell wget -O "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" ``` - Download using `curl`: - ```sh + ```shell curl -o "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" ``` @@ -96,13 +93,13 @@ To install Chef Workstation on an RPM-based system, follow these steps: 1. Install Chef Workstation: - ```sh + ```shell sudo dnf install chef-workstation-enterprise-.x86_64.rpm ``` - or: + Alternatively: - ```sh + ```shell sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm ``` @@ -138,13 +135,13 @@ To install Chef Workstation on Windows, follow these steps: After installation, verify that Chef Workstation is installed correctly by running one of the following commands: -```sh +```shell chef-workstation -v ``` -or +Alternatively: -```sh +```shell chef -v ``` @@ -157,7 +154,7 @@ If you only need specific tools rather than the full Workstation package, instal 1. Install a package using [`hab pkg install`](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-install): - ```sh + ```shell hab pkg install --binlink --force ``` @@ -180,6 +177,9 @@ If you only need specific tools rather than the full Workstation package, instal - [Add a license](license) - Optional: [Get started with Chef Workstation](get_started) -## More information +## See also - [Chef Download API documentation](https://docs.chef.io/download/) +- [Upgrade Chef Workstation](upgrade) +- [Uninstall Chef Workstation](uninstall) +- [Chef Workstation tools](tools) diff --git a/content/tools/berkshelf.md b/content/tools/berkshelf.md index f2e1cf0..9900aa5 100644 --- a/content/tools/berkshelf.md +++ b/content/tools/berkshelf.md @@ -2,7 +2,8 @@ title = "About Berkshelf" draft = false - +linkTitle = "Berkshelf" +summary = "Berkshelf is a dependency manager for Chef cookbooks." [menu] [menu.tools] diff --git a/content/tools/knife/_index.md b/content/tools/knife/_index.md index 8591608..595c9a8 100644 --- a/content/tools/knife/_index.md +++ b/content/tools/knife/_index.md @@ -2,6 +2,8 @@ title = "About knife" draft = false +linkTitle = "knife" + [menu] [menu.tools] title = "About knife" diff --git a/content/uninstall.md b/content/uninstall.md index 43404f9..633060e 100644 --- a/content/uninstall.md +++ b/content/uninstall.md @@ -7,19 +7,21 @@ draft = false identifier = "uninstall" +++ +Use these steps to remove Chef Workstation from Debian-based, RPM-based, or Windows systems. + ## Uninstall Chef Workstation on Debian-based distributions To uninstall Chef Workstation, follow these steps: 1. Remove the package: - ```sh + ```shell sudo apt-get purge chef-workstation-enterprise ``` 1. Verify that the package has been removed: - ```sh + ```shell dpkg -l chef-workstation-enterprise ``` @@ -29,15 +31,15 @@ To uninstall Chef Workstation, follow these steps: To uninstall Chef Workstation, follow these steps: -1. Remove the package. +1. Remove the package: - ```sh + ```shell sudo dnf remove chef-workstation-enterprise ``` 1. Verify that the package has been removed: - ```sh + ```shell rpm -qa chef-workstation-enterprise ``` @@ -58,3 +60,8 @@ msiexec /x chef-workstation-enterprise-_x86_64.msi ``` Replace `` with the version number of the currently installed package. + +## See also + +- [Install Chef Workstation](install) +- [Upgrade Chef Workstation](upgrade) diff --git a/content/upgrade.md b/content/upgrade.md index c1fd7d8..ef58e41 100644 --- a/content/upgrade.md +++ b/content/upgrade.md @@ -6,7 +6,7 @@ title = "Upgrade" identifier = "upgrade" +++ -Chef Workstation 26.1 and later are distributed as installers for Debian, RPM, and Windows. +Chef Workstation 26.1 and later uses native installers for Debian, RPM, and Windows. To upgrade, install the latest version for your operating system. ## Upgrade on Debian-based systems @@ -17,13 +17,13 @@ To upgrade Chef Workstation on a Debian-based system, follow these steps: - Download using `wget`: - ```sh + ```shell wget -O "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" ``` - Download using `curl`: - ```sh + ```shell curl -o "chef-workstation-enterprise--linux.deb" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=deb&v=" ``` @@ -33,7 +33,7 @@ To upgrade Chef Workstation on a Debian-based system, follow these steps: 1. Install the new version: - ```sh + ```shell sudo dpkg -i chef-workstation-enterprise-_amd64.deb ``` @@ -47,13 +47,13 @@ To upgrade Chef Workstation on an RPM-based system, follow these steps: - Download using `wget`: - ```sh + ```shell wget -O "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" ``` - Download using `curl`: - ```sh + ```shell curl -o "chef-workstation-enterprise--linux.rpm" "https://chefdownload-commercial.chef.io/stable/chef-workstation-enterprise/download?eol=false&license_id=&m=x86_64&p=linux&pm=rpm&v=" ``` @@ -63,13 +63,13 @@ To upgrade Chef Workstation on an RPM-based system, follow these steps: 1. Install the new version: - ```sh + ```shell sudo dnf install chef-workstation-enterprise-.x86_64.rpm ``` - or: + Alternatively: - ```sh + ```shell sudo rpm -Uvh chef-workstation-enterprise-.x86_64.rpm ``` @@ -101,3 +101,8 @@ To upgrade Chef Workstation on Windows, follow these steps: - [Set up Workstation](/set_up/) - [Add a license](/license/) + +## See also + +- [Install Chef Workstation](install) +- [Uninstall Chef Workstation](uninstall)