From e8dfa874a042cdd0b71aa29498ee382ed1d1a537 Mon Sep 17 00:00:00 2001 From: Swathi Date: Thu, 17 Jul 2025 10:43:26 +0530 Subject: [PATCH] Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater Signed-off-by: Swathi --- .../licensing/local_license_service/_index.md | 2 +- content/chef_install_script.md | 13 ++- content/download/commercial.md | 79 ++++++++++++++++++- content/download/community.md | 9 +++ content/licensing/_index.md | 2 +- content/licensing/license_key.md | 2 +- 6 files changed, 100 insertions(+), 7 deletions(-) diff --git a/_vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md b/_vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md index 7c7f292fb5..de0bf05617 100644 --- a/_vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md +++ b/_vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md @@ -33,7 +33,7 @@ Local License Service can automatically synchronize commercial licenses from Che The Chef Local License Service can provide licenses to following Chef products: -- Chef InSpec 6 and greater +- Chef InSpec 6 ## Get Chef Local License Service diff --git a/content/chef_install_script.md b/content/chef_install_script.md index e9c73092b3..331bc8ee23 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -153,8 +153,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) @@ -178,6 +177,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 19edbcd217..102113d723 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -37,6 +37,8 @@ The Chef Commercial Download API has the following endpoints: - `/versions/latest` - `/metadata` - `/download` +- `/fileName` +- `/package-managers` See the [parameters section](#parameters) below to understand the query strings used in the following endpoint descriptions. @@ -111,6 +113,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. @@ -119,6 +127,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. @@ -168,6 +204,16 @@ 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. @@ -184,6 +230,8 @@ You can also use the [products endpoint](#products) | 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. @@ -210,16 +258,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 090a001843..b0ff427353 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -29,6 +29,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. @@ -111,6 +112,14 @@ The `download` endpoint downloads a particular package of a Chef product. https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&v= ``` +### fileName + +The `fileName` endpoint returns the file name. + +```plain +https://chefdownload-community.chef.io///fileName?p=&pv=&m=&v= +``` + ## Parameters The API accepts the following parameters in a query string. diff --git a/content/licensing/_index.md b/content/licensing/_index.md index e4df00004f..082206bb0e 100644 --- a/content/licensing/_index.md +++ b/content/licensing/_index.md @@ -21,7 +21,7 @@ Before you can use distributions of Chef products, you must [accept the Chef End The following products also require a [license key](license_key): -- Chef InSpec 6 or greater +- Chef InSpec 6 Licensing is available for non-profit, research, and academic organizations through a special, free, or highly discounted commercial license in [Progress Chef's Non-Profit Entitlement Program](https://www.chef.io/nonprofit-entitlement-program). diff --git a/content/licensing/license_key.md b/content/licensing/license_key.md index 4b5d440d8e..e5b53f0c94 100644 --- a/content/licensing/license_key.md +++ b/content/licensing/license_key.md @@ -19,7 +19,7 @@ You can find your license key on the [customer support portal](https://community The following products require a Chef License key to run: -- [Chef InSpec 6 or greater](/inspec/license/) +- [Chef InSpec 6](/inspec/license/) ## Add license key