Skip to content

Commit 613868c

Browse files
Swathivviveksharma
authored andcommitted
Added chef-ice and migrate-ice support in doc and removed Inspec 6 or greater
Signed-off-by: Swathi <[email protected]>
1 parent 0f41c9f commit 613868c

File tree

4 files changed

+109
-16
lines changed

4 files changed

+109
-16
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
@@ -165,8 +165,7 @@ In addition to the default install behavior, the Chef Software install script su
165165
`-P` (`-project` on Windows)
166166

167167
: The product name to install. Supported versions of Chef products are
168-
`chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage` and
169-
`supermarket`. Default value: `chef`.
168+
`chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage`,`supermarket` and `chef-ice` . Default value: `chef`.
170169

171170
`-s` (`-install_strategy` on Windows)
172171

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

192+
`-i` (`-package_manager` on Windows)
193+
194+
: 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.
195+
196+
Supported values include:
197+
198+
- `deb`: For Debian-based systems (for example: Ubuntu).
199+
- `rpm`: For Red Hat-based systems (for example: CentOS, Fedora).
200+
- `msi`: For Windows systems.
201+
193202
## Release channels
194203

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

content/download/commercial.md

Lines changed: 88 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The Chef Commercial Download API has the following endpoints:
3636
- `/versions/latest`
3737
- `/metadata`
3838
- `/download`
39+
- `/fileName`
40+
- `/package-managers`
3941

4042
For details about query strings, see the [parameters section](#parameters).
4143

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

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

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

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

122158
The API accepts the following parameters in a query string.
@@ -166,22 +202,34 @@ The API accepts the following parameters in a query string.
166202

167203
Default value: `latest`.
168204

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

171217
Use the following product keys to download packages or retrieve data for different Chef products.
172218
You can also use the [products endpoint](#products)
173219

174-
| Product | Product key |
175-
|--------------------|------------------|
176-
| Chef Automate | automate |
177-
| Chef Infra Client | chef |
178-
| Chef Backend | chef-backend |
179-
| Chef Infra Server | chef-server |
180-
| Chef Workstation | chef-workstation |
181-
| Chef Habitat | habitat |
182-
| Chef InSpec | inspec |
183-
| Management Console | manage |
184-
| Supermarket | supermarket |
220+
| Product | Product key |
221+
| ------- | ------------ |
222+
| Chef Automate | automate |
223+
| Chef Infra Client | chef |
224+
| Chef Backend | chef-backend |
225+
| Chef Infra Server | chef-server |
226+
| Chef Workstation | chef-workstation |
227+
| Chef Habitat | habitat |
228+
| Chef InSpec | inspec |
229+
| Management Console | manage |
230+
| Supermarket | supermarket |
231+
| Chef Infra Client Enterprise | chef-ice |
232+
| Chef Infra Client Legacy Migration | migrate-ice |
185233

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

@@ -208,16 +256,43 @@ url "https://chefdownload-commercial.chef.io/stable/chef/download?license_id=<LI
208256
version "18.2.7"
209257
```
210258

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

213-
To use cURL to download a package directly, enter the following:
276+
To use cURL to download a package directly of Chef Products, enter the following:
214277

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

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

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

content/download/community.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The Chef Community Download API has the following endpoints:
3232
- `/versions/latest`
3333
- `/metadata`
3434
- `/download`
35+
- `/fileName`
3536

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

@@ -114,6 +115,14 @@ The `download` endpoint downloads a particular package of a Chef product.
114115
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
115116
```
116117

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

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

0 commit comments

Comments
 (0)