From 454c8f39b9345e628d437116c12a237c920031e8 Mon Sep 17 00:00:00 2001 From: Swathi Date: Thu, 17 Jul 2025 10:43:26 +0530 Subject: [PATCH 1/4] Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater Signed-off-by: Swathi --- content/chef_install_script.md | 13 ++++- content/download/commercial.md | 101 ++++++++++++++++++++++++++++----- content/download/community.md | 11 +++- 3 files changed, 109 insertions(+), 16 deletions(-) diff --git a/content/chef_install_script.md b/content/chef_install_script.md index f5dba0428..1f5a7c93a 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -165,8 +165,7 @@ In addition to the default install behavior, the Chef Software install script su `-P` (`-project` on Windows) : The product name to install. Supported versions of Chef products are - `chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage` and - `supermarket`. Default value: `chef`. + `chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage`,`supermarket` and `chef-ice` . Default value: `chef`. `-s` (`-install_strategy` on Windows) @@ -190,6 +189,16 @@ In addition to the default install behavior, the Chef Software install script su two-part version (x.y) is also allowed. For more information about application versioning, see [semver.org](https://semver.org/). +`-i` (`-package_manager` on Windows) + +: Specifies the package manager to use for downloading and installing the Chef Infra Client Enterprise. If not provided, the script will auto detect the package manager based on the platform. + +Supported values include: + +- `deb`: For Debian-based systems (for example: Ubuntu). +- `rpm`: For Red Hat-based systems (for example: CentOS, Fedora). +- `msi`: For Windows systems. + ## Release channels {{< readfile file="content/reusable/md/release_channels.md" >}} diff --git a/content/download/commercial.md b/content/download/commercial.md index 089ae7bfe..f87cd4aaa 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -36,6 +36,8 @@ The Chef Commercial Download API has the following endpoints: - `/versions/latest` - `/metadata` - `/download` +- `/fileName` +- `/package-managers` For details about query strings, see the [parameters section](#parameters). @@ -109,6 +111,12 @@ The `metadata` endpoint returns data about a particular package of a Chef produc https://chefdownload-commercial.chef.io///metadata?p=&pv=&m=&v=&license_id= ``` +For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. + +```plain +https://chefdownload-commercial.chef.io///metadata?p=&pm=&m=&v=&license_id= +``` + ### download The `download` endpoint downloads a particular package of a Chef product. @@ -117,6 +125,34 @@ The `download` endpoint downloads a particular package of a Chef product. https://chefdownload-commercial.chef.io///download?p=&pv=&m=&v=&license_id= ``` +For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. + +```plain +https://chefdownload-commercial.chef.io///download?p=&pm=&m=&v=&license_id= +``` + +### fileName + +The `fileName` endpoint returns the file name. + +```plain +https://chefdownload-commercial.chef.io///fileName?p=&pv=&m=&v=&license_id= +``` + +For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. + +```plain +https://chefdownload-commercial.chef.io///fileName?p=&pm=&m=&v=&license_id= +``` + +### package-managers + +The `package-managers` endpoint lists the available package managers. + +```plain +https://chefdownload-commercial.chef.io/package-managers +``` + ## Parameters The API accepts the following parameters in a query string. @@ -166,22 +202,34 @@ The API accepts the following parameters in a query string. Default value: `latest`. +`pm` +: The package manager. + +This parameter is only used for the Chef Infra Client Enterprise and Chef Infra Client Legacy Migration products. For example: + +- `deb` for Debian-based systems (for example: Ubuntu) +- `rpm` for Red Hat-based systems (for example: CentOS, Fedora) +- `tar` for generic Unix-like systems +- `msi` for Windows systems + ## Chef product names Use the following product keys to download packages or retrieve data for different Chef products. You can also use the [products endpoint](#products) -| Product | Product key | -|--------------------|------------------| -| Chef Automate | automate | -| Chef Infra Client | chef | -| Chef Backend | chef-backend | -| Chef Infra Server | chef-server | -| Chef Workstation | chef-workstation | -| Chef Habitat | habitat | -| Chef InSpec | inspec | -| Management Console | manage | -| Supermarket | supermarket | +| Product | Product key | +| ---------------------------------- | ------------------ | +| Chef Automate | `automate` | +| Chef Infra Client | `chef` | +| Chef Backend | `chef-backend` | +| Chef Infra Server | `chef-server` | +| Chef Workstation | `chef-workstation` | +| Chef Habitat | `habitat` | +| Chef InSpec | `inspec` | +| Management Console | `manage` | +| Supermarket | `supermarket` | +| Chef Infra Client Enterprise | `chef-ice` | +| Chef Infra Client Legacy Migration | `migrate-ice` | See the [supported versions]({{< relref "versions" >}}) documentation for information about the support status of individual products. @@ -208,16 +256,43 @@ url "https://chefdownload-commercial.chef.io/stable/chef/download?license_id=
  • +``` + +which returns something like: + +```json +sha1 "dcf75b37bb80128af4657501bfd41eac52820191" +sha256 "2c501d02b16d67e9d5a28578b95f8d3155bed940ee4946229213f41a2e8b798e" +url "https://chefdownload-commercial.chef.io/stable/chef-ice/download?license_id=&eol=false&m=x86_64&p=linux&pm=deb&v=19.1.8" +version "19.1.8" +``` + ### Download directly -To use cURL to download a package directly, enter the following: +To use curl to download a package directly of Chef Products, enter the following: ```bash curl -LOJ 'https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id=' ``` -To use GNU Wget to download a package directly, enter the following: +To use curl to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following: + +```bash +curl -LOJ 'https://chefdownload-commercial.chef.io///download?p=&pm=&m=&license_id=' +``` + +To use GNU Wget to download a package directly of Chef Products, enter the following: ```bash wget --content-disposition https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id= ``` + +To use GNU Wget to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following: + +```bash +wget --content-disposition https://chefdownload-commercial.chef.io///download?p=&pm=&m=&license_id= +``` diff --git a/content/download/community.md b/content/download/community.md index 4e4774e86..60c68b31a 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -32,6 +32,7 @@ The Chef Community Download API has the following endpoints: - `/versions/latest` - `/metadata` - `/download` +- `/fileName` See the [parameters section](#parameters) below to understand the query strings used in the following endpoint descriptions. @@ -114,6 +115,14 @@ The `download` endpoint downloads a particular package of a Chef product. https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&v=&license_id= ``` +### fileName + +The `fileName` endpoint returns the file name. + +```plain +https://chefdownload-community.chef.io///fileName?p=&pv=&m=&v=&license_id= +``` + ## Parameters The API accepts the following parameters in a query string. @@ -196,7 +205,7 @@ version "14.15.6" ### Download directly -To use cURL to download a package directly, enter the following: +To use curl to download a package directly, enter the following: ```bash curl -LOJ 'https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&license_id=' From fc89cc22e4e073496d0bf5ad97e5d15a449923a3 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Wed, 14 Jan 2026 12:15:42 -0500 Subject: [PATCH 2/4] Docs editing Signed-off-by: Ian Maddaus --- content/chef_install_script.md | 12 ++++++------ content/download/commercial.md | 20 ++++++++++++-------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/content/chef_install_script.md b/content/chef_install_script.md index 1f5a7c93a..8d3d86484 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -165,7 +165,7 @@ In addition to the default install behavior, the Chef Software install script su `-P` (`-project` on Windows) : The product name to install. Supported versions of Chef products are - `chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage`,`supermarket` and `chef-ice` . Default value: `chef`. + `chef`, `chef-backend`, `chef-server`, `inspec`, `chef-workstation`, `manage`, `supermarket`, and `chef-ice` . Default value: `chef`. `-s` (`-install_strategy` on Windows) @@ -191,13 +191,13 @@ In addition to the default install behavior, the Chef Software install script su `-i` (`-package_manager` on Windows) -: Specifies the package manager to use for downloading and installing the Chef Infra Client Enterprise. If not provided, the script will auto detect the package manager based on the platform. +: Specifies the package manager to use for downloading and installing the Chef Infra Client Enterprise. If not provided, the script auto detects the package manager based on the platform. -Supported values include: + Supported values include: -- `deb`: For Debian-based systems (for example: Ubuntu). -- `rpm`: For Red Hat-based systems (for example: CentOS, Fedora). -- `msi`: For Windows systems. + - `deb` for Debian-based systems, for example, Ubuntu + - `rpm` for Red Hat-based systems, for example, CentOS or Fedora + - `msi` for Windows systems ## Release channels diff --git a/content/download/commercial.md b/content/download/commercial.md index f87cd4aaa..af39f5ec3 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -125,7 +125,8 @@ The `download` endpoint downloads a particular package of a Chef product. https://chefdownload-commercial.chef.io///download?p=&pv=&m=&v=&license_id= ``` -For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. +For Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, you must include the `pm` (package manager) query parameter in your request. +This parameter specifies the package format to download---for example, `deb`, `rpm`, `msi`, or `tar`. ```plain https://chefdownload-commercial.chef.io///download?p=&pm=&m=&v=&license_id= @@ -139,7 +140,8 @@ The `fileName` endpoint returns the file name. https://chefdownload-commercial.chef.io///fileName?p=&pv=&m=&v=&license_id= ``` -For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. +For Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, you must include the `pm` (package manager) query parameter in your request. +This parameter specifies the package format---for example, `deb`, `rpm`, `msi`, or `tar`. ```plain https://chefdownload-commercial.chef.io///fileName?p=&pm=&m=&v=&license_id= @@ -205,12 +207,14 @@ The API accepts the following parameters in a query string. `pm` : The package manager. -This parameter is only used for the Chef Infra Client Enterprise and Chef Infra Client Legacy Migration products. For example: + Use this parameter only for Chef Infra Client Enterprise and Chef Infra Client Legacy Migration products. + + Possible values: -- `deb` for Debian-based systems (for example: Ubuntu) -- `rpm` for Red Hat-based systems (for example: CentOS, Fedora) -- `tar` for generic Unix-like systems -- `msi` for Windows systems + - `deb` for Debian-based systems, for example, Ubuntu + - `rpm` for Red Hat-based systems, for example, CentOS or Fedora + - `tar` for generic Unix-like systems + - `msi` for Windows systems ## Chef product names @@ -268,7 +272,7 @@ which returns something like: sha1 "dcf75b37bb80128af4657501bfd41eac52820191" sha256 "2c501d02b16d67e9d5a28578b95f8d3155bed940ee4946229213f41a2e8b798e" url "https://chefdownload-commercial.chef.io/stable/chef-ice/download?license_id=&eol=false&m=x86_64&p=linux&pm=deb&v=19.1.8" -version "19.1.8" +version "19.1.8" ``` ### Download directly From e558cbd3209da4b37fe6effc8e36bf865c8e6706 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Wed, 14 Jan 2026 12:24:02 -0500 Subject: [PATCH 3/4] Markdownlint fixes Signed-off-by: Ian Maddaus --- content/chef_install_script.md | 2 ++ content/download/commercial.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/content/chef_install_script.md b/content/chef_install_script.md index 8d3d86484..1c4e2200a 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -137,6 +137,8 @@ For additional script install options, see the [script options](#script-options) ## Script options + + In addition to the default install behavior, the Chef Software install script supports the following options: `-c` (`-channel` on Windows) diff --git a/content/download/commercial.md b/content/download/commercial.md index af39f5ec3..baf1f046d 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -157,6 +157,8 @@ https://chefdownload-commercial.chef.io/package-managers ## Parameters + + The API accepts the following parameters in a query string. `` From a5a1abe629bbe4bdb258263eeba0e01d8fa85e05 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Wed, 28 Jan 2026 14:08:05 -0500 Subject: [PATCH 4/4] Editing Signed-off-by: Ian Maddaus --- content/download/commercial.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/content/download/commercial.md b/content/download/commercial.md index baf1f046d..2c3a2884a 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -111,7 +111,7 @@ The `metadata` endpoint returns data about a particular package of a Chef produc https://chefdownload-commercial.chef.io///metadata?p=&pv=&m=&v=&license_id= ``` -For products such as Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, the pm (package manager) query parameter must be explicitly provided in the request. This value determines the type of package to retrieve (for example: deb, rpm, msi, or tar) and is required because these products support multiple packaging formats. +For Chef Infra Client Enterprise and the Chef Infra Client migration tool, include the `pm` (package manager) query parameter. This value determines the type of package to retrieve (for example: `deb`, `rpm`, `msi`, or `tar`) and is required because these products support multiple packaging formats. ```plain https://chefdownload-commercial.chef.io///metadata?p=&pm=&m=&v=&license_id= @@ -125,7 +125,7 @@ The `download` endpoint downloads a particular package of a Chef product. https://chefdownload-commercial.chef.io///download?p=&pv=&m=&v=&license_id= ``` -For Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, you must include the `pm` (package manager) query parameter in your request. +For Chef Infra Client Enterprise or the Chef Infra Client migration tool, include the `pm` (package manager) query parameter in your request. This parameter specifies the package format to download---for example, `deb`, `rpm`, `msi`, or `tar`. ```plain @@ -140,7 +140,7 @@ The `fileName` endpoint returns the file name. https://chefdownload-commercial.chef.io///fileName?p=&pv=&m=&v=&license_id= ``` -For Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, you must include the `pm` (package manager) query parameter in your request. +For Chef Infra Client Enterprise or the Chef Infra Client migration tool, include the `pm` (package manager) query parameter in your request. This parameter specifies the package format---for example, `deb`, `rpm`, `msi`, or `tar`. ```plain @@ -209,7 +209,7 @@ The API accepts the following parameters in a query string. `pm` : The package manager. - Use this parameter only for Chef Infra Client Enterprise and Chef Infra Client Legacy Migration products. + Use this parameter only for Chef Infra Client Enterprise and the Chef Infra Client migration tool. Possible values: @@ -226,16 +226,16 @@ You can also use the [products endpoint](#products) | Product | Product key | | ---------------------------------- | ------------------ | | Chef Automate | `automate` | -| Chef Infra Client | `chef` | | Chef Backend | `chef-backend` | -| Chef Infra Server | `chef-server` | -| Chef Workstation | `chef-workstation` | | Chef Habitat | `habitat` | -| Chef InSpec | `inspec` | -| Management Console | `manage` | -| Supermarket | `supermarket` | +| Chef Infra Client | `chef` | | Chef Infra Client Enterprise | `chef-ice` | -| Chef Infra Client Legacy Migration | `migrate-ice` | +| Chef Infra Client migration tool | `migrate-ice` | +| Chef Infra Server | `chef-server` | +| Chef InSpec | `inspec` | +| Chef Management Console | `manage` | +| Chef Supermarket | `supermarket` | +| Chef Workstation | `chef-workstation` | See the [supported versions]({{< relref "versions" >}}) documentation for information about the support status of individual products. @@ -279,25 +279,25 @@ version "19.1.8" ### Download directly -To use curl to download a package directly of Chef Products, enter the following: +To use curl to download a package, enter the following: ```bash curl -LOJ 'https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id=' ``` -To use curl to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following: +To use curl to download a Chef Infra Client Enterprise or Chef Infra Client migration tool package, include the `pm` (package manager) parameter as shown: ```bash curl -LOJ 'https://chefdownload-commercial.chef.io///download?p=&pm=&m=&license_id=' ``` -To use GNU Wget to download a package directly of Chef Products, enter the following: +To use GNU Wget to download a package, enter the following: ```bash wget --content-disposition https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id= ``` -To use GNU Wget to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following: +To use GNU Wget to download a Chef Infra Client Enterprise or Chef Infra Client migration tool package, enter the following: ```bash wget --content-disposition https://chefdownload-commercial.chef.io///download?p=&pm=&m=&license_id=