diff --git a/content/chef_install_script.md b/content/chef_install_script.md index f5dba0428..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) @@ -165,8 +167,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 +191,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 auto detects 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 or 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..baf1f046d 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,8 +125,40 @@ 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. +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= +``` + +### fileName + +The `fileName` endpoint returns the file name. + +```plain +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. +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= +``` + +### 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 +206,36 @@ The API accepts the following parameters in a query string. Default value: `latest`. +`pm` +: The package manager. + + 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 or 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 +262,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='