You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
authored
Update Chef download endpoints to new commercial and community URLs (#23) (#28)
* Update Chef download endpoints to new commercial and community URLs
* Fix markdown linting errors
* Remove bullets from definition list
* Text review and editing
* Additional editing
* Markdownlint error fixes
---------
Signed-off-by: Kashish varma <kashish.varma@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: kashish-varma <kashish.varma@chef.io>
Co-authored-by: Kashish varma <kashish.varma@progress.com>
Copy file name to clipboardExpand all lines: content/tools/kitchen/config_yml_kitchen.md
+34-27Lines changed: 34 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,8 @@ about Test Kitchen.
38
38
39
39
## Provisioner settings
40
40
41
+
<!-- markdownlint-disable MD006 MD007 -->
42
+
41
43
Test Kitchen can configure the chef-zero provisioner with the following
42
44
Chef-specific settings:
43
45
@@ -62,7 +64,12 @@ Chef-specific settings:
62
64
: Default value: `/etc/opt` for UNIX and Linux, `$env:systemdrive\\opscode\\chef` on Windows.
63
65
64
66
`chef_omnibus_url`
65
-
: The URL of an `install.sh` script that will install Chef Infra Client on the machine under test. Default value: `https://omnitruck.chef.io/install.sh`. **This will be deprecated in a future version.**
67
+
: The URL of an `install.sh` script that will install Chef Infra Client on the machine under test.
- Community downloads install script: `https://chefdownload-community.chef.io/install.sh`
71
+
72
+
For the commercial endpoint, replace `<LICENSE_ID>` with your Progress Chef License ID. You can find your license ID on [Chef Downloads](https://www.chef.io/downloads). For more information, see this [support article](https://community.progress.com/s/article/How-Do-I-Find-My-License-Key-Needed-For-Chef-Product-Downloads).
66
73
67
74
`chef_solo_path`
68
75
: chef-solo provisioner only.
@@ -154,14 +161,16 @@ Chef-specific settings:
154
161
: Takes an array of exit codes to indicate that kitchen should retry the converge command. Default value: `[35, 213]`.
155
162
156
163
`max_retries`
157
-
: Number of times to retry the converge before passing along the failed status. Defaults value: 1.
164
+
: Number of times to retry the converge before passing along the failed status. Default value: 1.
158
165
159
166
`wait_for_retry`
160
167
: Number of seconds to wait between converge attempts. Default value: 30.
161
168
162
169
These settings may be added to the `provisioner` section of the
163
170
`kitchen.yml`file when the provisioner is chef-zero or chef-solo.
164
171
172
+
<!-- markdownlint-enable MD006 MD007 -->
173
+
165
174
### New provisioner settings
166
175
167
176
`product_name`
@@ -204,7 +213,7 @@ These settings may be added to the `provisioner` section of the
204
213
Default value: auto detected
205
214
206
215
`platform_version`
207
-
: Override platform platform.
216
+
: Override platform version.
208
217
209
218
Default value: auto detected
210
219
@@ -224,40 +233,40 @@ Kitchen can configure a transport with the following settings for either
224
233
`ssh` or `winrm` transports:
225
234
226
235
`connection_retries`
227
-
: Maximum number of times to retry after a failed attempt to open a connection. The default is 5.
236
+
: Maximum number of times to retry after a failed connection attempt. Default value:5.
228
237
229
238
`connection_retry_sleep`
230
-
: Number of seconds to wait until attempting to make another connection after a failure.
239
+
: Number of seconds to wait before attempting to reconnect after a failed connection.
231
240
232
241
`max_wait_until_ready`
233
-
: Maximum number of attempts to determine if the test instance is ready to accept commands. This defaults to 600.
242
+
: Maximum number of attempts to determine if the test instance is ready to accept commands. Default value:600.
234
243
235
244
`password`
236
245
: The password used for authenticating to the test instance.
237
246
238
247
`port`
239
-
: The port used to connect to the test instance. This defaults to `22` for the `ssh` transport and `5985` or `5986` for `winrm` using `http` or `https` respectively.
248
+
: Port used to connect to the test instance. Default value: `22`for `ssh` transport, `5985` for `winrm` with `http`, and `5986` for `winrm` with `https`.
240
249
241
250
`username`
242
-
: The username used for authenticating to the test instance. This defaults to `administrator` for the `winrm` transport and `root` for the `ssh` transport. Some drivers may change this default.
251
+
: Username used to authenticate to the test instance. Default value: `administrator`for `winrm` transport and `root` for `ssh` transport. Some drivers may override this default.
243
252
244
253
These settings may be added to the `transport` section of the
245
254
`kitchen.yml` file when the transport is SSH:
246
255
247
256
`compression`
248
-
: Whether or not to use compression. The default is `false`.
257
+
: Whether to use compression. Default value:`false`.
249
258
250
259
`compression_level`
251
-
: The default is 6 if `compression` is `true`.
260
+
: Default value: 6 when `compression` is `true`.
252
261
253
262
`connection_timeout`
254
-
: Defaults to 15.
263
+
: Default value:15.
255
264
256
265
`keepalive`
257
-
: Defaults to `true`.
266
+
: Default value:`true`.
258
267
259
268
`keepalive_interval`
260
-
: Defaults to 60.
269
+
: Default value:60.
261
270
262
271
`max_ssh_sessions`
263
272
: Maximum number of parallel ssh sessions.
@@ -269,19 +278,19 @@ These settings may be added to the `transport` section of the
269
278
`kitchen.yml` file when the transport is WinRM:
270
279
271
280
`elevated`
272
-
: When `true`, all commands are executed with a scheduled task. This may eliminate access denied errors related to double hop authentication, interacting with Windows updates and installing some MSIs such as sql server and .net runtimes. Defaults to `false`.
281
+
: When `true`, all commands execute with a scheduled task. This may eliminate access denied errors related to double hop authentication, Windows updates, and MSI installations. Default value:`false`.
273
282
274
283
`elevated_password`
275
-
: The password used by the identity running the scheduled task. This may be `null` in the case of service accounts. Defaults to `password`.
284
+
: Password for the identity running the scheduled task. Can be `null` for service accounts. Default value:`password`.
276
285
277
286
`elevated_username`
278
-
: The identity that the task runs under. This may also be set to service accounts such as `System`. This defaults to `username`.
287
+
: Identity that the task runs under. Can be set to service accounts such as `System`. Default value:`username`.
279
288
280
289
`rdp_port`
281
-
: Port used making `rdp` connections for `kitchen login` commands. Defaults to 3389.
290
+
: Port for `rdp` connections with `kitchen login` commands. Default value:3389.
282
291
283
292
`winrm_transport`
284
-
: The transport type used by [WinRM](https://github.com/WinRb/WinRM). The default is `negotiate`. `ssl` and `plaintext` are also acceptable values.
293
+
: Transport type for [WinRM](https://github.com/WinRb/WinRM). Default value: `negotiate`. Acceptable values: `ssl` and `plaintext`.
285
294
286
295
### Work with proxies
287
296
@@ -323,9 +332,9 @@ suites:
323
332
324
333
where:
325
334
326
-
- `require_chef_omnibus`is used to ensure that the Chef installer will be used to install Chef Infra Client to all platform instances; `require_chef_omnibus` may also be set to `latest`, which means the newest version of Chef Infra Client for that platform will be used for cookbook testing
327
-
- `chef_omnibus_url`is used to specify the URL from which Chef Infra Client is downloaded
328
-
- the `attributes` for the `config` test suite contain specific client.rb settings for use with this test suite
335
+
- `require_chef_omnibus`ensures that the Chef installer installs Chef Infra Client on all platform instances. You can also set it to `latest` to use the newest version of Chef Infra Client for that platform when testing cookbooks.
336
+
- `chef_omnibus_url`specifies the URL from which Chef Infra Client is downloaded.
337
+
- The `attributes` for the `config` test suite contain specific `client.rb` settings for this test suite.
329
338
330
339
## Driver settings
331
340
@@ -400,10 +409,9 @@ platforms:
400
409
elevated: true
401
410
```
402
411
403
-
If `name` begins with `win` then the `os_type` defaults to `windows`.
404
-
The `winrm` transport is the default on Windows operating systems. Here
405
-
`elevated`is true which runs windows commands with a scheduled task to
406
-
imitate a local user.
412
+
If `name` begins with `win`, the `os_type` defaults to `windows`.
413
+
The `winrm` transport is the default on Windows operating systems.
414
+
When `elevated` is `true`, Windows commands run with a scheduled task to emulate a local user.
407
415
408
416
### Chef Infra Client cookbook
409
417
@@ -464,8 +472,7 @@ suites:
464
472
### chef-splunk cookbook
465
473
466
474
The following `kitchen.yml` file is part of the `chef-splunk` cookbook and
467
-
is used to help ensure the installation of the Splunk client and server
468
-
is done correctly.
475
+
helps ensure that Splunk client and server installations are correct.
0 commit comments