Skip to content

Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater occurrence. #4447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −7
Open

Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater occurrence. #4447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .../license-service/docs-chef-io/content/licensing/local_license_service/_index.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 11 additions & 2 deletions content/chef_install_script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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" >}}
Expand Down
79 changes: 77 additions & 2 deletions content/download/commercial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -111,6 +113,12 @@ The `metadata` endpoint returns data about a particular package of a Chef produc
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<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/<CHANNEL>/<PRODUCT>/metadata?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
```

### download

The `download` endpoint downloads a particular package of a Chef product.
Expand All @@ -119,6 +127,34 @@ The `download` endpoint downloads a particular package of a Chef product.
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<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/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
```

### fileName

The `fileName` endpoint returns the file name.

```plain
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<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/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.

Expand All @@ -210,16 +258,43 @@ url "https://chefdownload-commercial.chef.io/stable/chef/download?license_id=<LI
version "18.2.7"
```

To get the latest supported build of Chef Infra Client Enterprise for Linux 18.04, enter the following:

```sh
https://chefdownload-commercial.chef.io/stable/chef-ice/metadata?pv=18.04&m=x86_64&p=linux&pm=deb&license_id=<LICENSE_ID>
```

which returns something like:

```json
sha1 "dcf75b37bb80128af4657501bfd41eac52820191"
sha256 "2c501d02b16d67e9d5a28578b95f8d3155bed940ee4946229213f41a2e8b798e"
url "https://chefdownload-commercial.chef.io/stable/chef-ice/download?license_id=<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/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<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/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&license_id=<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/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<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/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>
```
9 changes: 9 additions & 0 deletions content/download/community.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -111,6 +112,14 @@ The `download` endpoint downloads a particular package of a Chef product.
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
```

### fileName

The `fileName` endpoint returns the file name.

```plain
https://chefdownload-community.chef.io/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
```

## Parameters

The API accepts the following parameters in a query string.
Expand Down
2 changes: 1 addition & 1 deletion content/licensing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion content/licensing/license_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down