Skip to content

Commit e8dfa87

Browse files
author
Swathi
committed
Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater
Signed-off-by: Swathi <[email protected]>
1 parent fffe686 commit e8dfa87

File tree

6 files changed

+100
-7
lines changed

6 files changed

+100
-7
lines changed

_vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

content/chef_install_script.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,7 @@ In addition to the default install behavior, the Chef Software install script su
153153
`-P` (`-project` on Windows)
154154

155155
: The product name to install. Supported versions of Chef products are
156-
`chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage` and
157-
`supermarket`. Default value: `chef`.
156+
`chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage`,`supermarket` and `chef-ice` . Default value: `chef`.
158157

159158
`-s` (`-install_strategy` on Windows)
160159

@@ -178,6 +177,16 @@ In addition to the default install behavior, the Chef Software install script su
178177
two-part version (x.y) is also allowed. For more information about
179178
application versioning, see [semver.org](https://semver.org/).
180179

180+
`-i` (`-package_manager` on Windows)
181+
182+
: 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.
183+
184+
Supported values include:
185+
186+
- `deb`: For Debian-based systems (for example: Ubuntu).
187+
- `rpm`: For Red Hat-based systems (for example: CentOS, Fedora).
188+
- `msi`: For Windows systems.
189+
181190
## Release channels
182191

183192
{{< readfile file="content/reusable/md/release_channels.md" >}}

content/download/commercial.md

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ The Chef Commercial Download API has the following endpoints:
3737
- `/versions/latest`
3838
- `/metadata`
3939
- `/download`
40+
- `/fileName`
41+
- `/package-managers`
4042

4143
See the [parameters section](#parameters) below to understand the query strings used in the following endpoint descriptions.
4244

@@ -111,6 +113,12 @@ The `metadata` endpoint returns data about a particular package of a Chef produc
111113
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
112114
```
113115

116+
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.
117+
118+
```plain
119+
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
120+
```
121+
114122
### download
115123

116124
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.
119127
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
120128
```
121129

130+
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.
131+
132+
```plain
133+
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
134+
```
135+
136+
### fileName
137+
138+
The `fileName` endpoint returns the file name.
139+
140+
```plain
141+
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
142+
```
143+
144+
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.
145+
146+
```plain
147+
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
148+
```
149+
150+
### package-managers
151+
152+
The `package-managers` endpoint lists the available package managers.
153+
154+
```plain
155+
https://chefdownload-commercial.chef.io/package-managers
156+
```
157+
122158
## Parameters
123159

124160
The API accepts the following parameters in a query string.
@@ -168,6 +204,16 @@ The API accepts the following parameters in a query string.
168204

169205
Default value: `latest`.
170206

207+
`pm`
208+
: The package manager.
209+
210+
This parameter is only used for the Chef Infra Client Enterprise and Chef Infra Client Legacy Migration products. For example:
211+
212+
- `deb` for Debian-based systems (for example: Ubuntu)
213+
- `rpm` for Red Hat-based systems (for example: CentOS, Fedora)
214+
- `tar` for generic Unix-like systems
215+
- `msi` for Windows systems
216+
171217
## Chef product names
172218

173219
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)
184230
| Chef InSpec | inspec |
185231
| Management Console | manage |
186232
| Supermarket | supermarket |
233+
| Chef Infra Client Enterprise | chef-ice |
234+
| Chef Infra Client Legacy Migration | migrate-ice |
187235

188236
See the [supported versions]({{< relref "versions" >}}) documentation for information about the support status of individual products.
189237

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

261+
To get the latest supported build of Chef Infra Client Enterprise for Linux 18.04, enter the following:
262+
263+
```sh
264+
https://chefdownload-commercial.chef.io/stable/chef-ice/metadata?pv=18.04&m=x86_64&p=linux&pm=deb&license_id=<LICENSE_ID>
265+
```
266+
267+
which returns something like:
268+
269+
```json
270+
sha1 "dcf75b37bb80128af4657501bfd41eac52820191"
271+
sha256 "2c501d02b16d67e9d5a28578b95f8d3155bed940ee4946229213f41a2e8b798e"
272+
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"
273+
version "19.1.8"
274+
```
275+
213276
### Download directly
214277

215-
To use cURL to download a package directly, enter the following:
278+
To use cURL to download a package directly of Chef Products, enter the following:
216279

217280
```bash
218281
curl -LOJ 'https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>'
219282
```
220283

221-
To use GNU Wget to download a package directly, enter the following:
284+
To use cURL to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following:
285+
286+
```bash
287+
curl -LOJ 'https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>'
288+
```
289+
290+
To use GNU Wget to download a package directly of Chef Products, enter the following:
222291

223292
```bash
224293
wget --content-disposition https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>
225294
```
295+
296+
To use GNU Wget to download a package directly of Chef Infra Client Enterprise or Chef Infra Client Legacy Migration, enter the following:
297+
298+
```bash
299+
wget --content-disposition https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/download?p=<PLATFORM>&pm=<PACKAGE_MANAGER>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>
300+
```

content/download/community.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The Chef Community Download API has the following endpoints:
2929
- `/versions/latest`
3030
- `/metadata`
3131
- `/download`
32+
- `/fileName`
3233

3334
See the [parameters section](#parameters) below to understand the query strings used in the following endpoint descriptions.
3435

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

115+
### fileName
116+
117+
The `fileName` endpoint returns the file name.
118+
119+
```plain
120+
https://chefdownload-community.chef.io/<CHANNEL>/<PRODUCT>/fileName?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
121+
```
122+
114123
## Parameters
115124

116125
The API accepts the following parameters in a query string.

content/licensing/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Before you can use distributions of Chef products, you must [accept the Chef End
2121

2222
The following products also require a [license key](license_key):
2323

24-
- Chef InSpec 6 or greater
24+
- Chef InSpec 6
2525

2626
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).
2727

content/licensing/license_key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can find your license key on the [customer support portal](https://community
1919

2020
The following products require a Chef License key to run:
2121

22-
- [Chef InSpec 6 or greater](/inspec/license/)
22+
- [Chef InSpec 6](/inspec/license/)
2323

2424
## Add license key
2525

0 commit comments

Comments
 (0)