Skip to content
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

Jump to bottom

Minor cleanup of the config.rb page #1605

Merged
merged 5 commits into from
Dec 22, 2020
Merged

Minor cleanup of the config.rb page #1605

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
20516f8
Remove an old version reference
tas50 Dec 22, 2020
e502b62
Remove a path reference that doesn't make sense
tas50 Dec 22, 2020
774b178
Remove a reference to Chef 12
tas50 Dec 22, 2020
7efaf69
Add a bit of clarification that this is the old way
tas50 Dec 22, 2020
d66922c
Fix formatting
tas50 Dec 22, 2020
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
31 changes: 8 additions & 23 deletions docs-chef-io/content/workstation/config_rb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@ aliases = ["/config_rb.html", "/config_rb_knife.html", "/config_rb/"]

{{< warning >}}

The `config.rb` file is a replacement for the knife.rb file, starting
with the Chef Client 12.0 release. The `config.rb` file has identical
settings and behavior to the knife.rb file. Chef Infra Client looks
first for the presence of the `config.rb` file and if it is not found,
then looks for the `knife.rb` file.
The `config.rb` file is a replacement for the knife.rb file. The `config.rb` file has identical settings and behavior to the knife.rb file. Chef Infra Client looks first for the presence of the `config.rb` file and if it is not found, then looks for the `knife.rb` file.
tas50 marked this conversation as resolved.
Show resolved Hide resolved

{{< /warning >}}

Expand All @@ -30,19 +26,12 @@ A `config.rb` file:

- Is loaded every time the knife executable is run
- Is not created by default
- Is located by default at `~/.chef/config.rb` (macOS and Linux
platforms) or `c:\Users\username\.chef\config.rb` (Microsoft Windows
platform), use the `--config` option from the command line to change
this location
- Will override the default configuration when a `config.rb` file
exists at the default path or the path specified by the `--config`
option
- Is located by default at `~/.chef/config.rb` (macOS and Linux platforms) or `c:\Users\username\.chef\config.rb` (Microsoft Windows platform), use the `--config` option from the command line to change this location
- Will override the default configuration when a `config.rb` file exists at the default path or the path specified by the `--config` option

{{< note >}}

When running Microsoft Windows, the `config.rb` file is located at
`%HOMEDRIVE%:%HOMEPATH%\.chef` (e.g. `c:\Users\<username>\.chef`). If
this path needs to be scripted, use `%USERPROFILE%\chef-repo\.chef`.
When running Microsoft Windows, the `config.rb` file is located at `%HOMEDRIVE%:%HOMEPATH%\.chef` (e.g. `c:\Users\<username>\.chef`).

{{< /note >}}

Expand Down Expand Up @@ -112,7 +101,7 @@ This configuration file has the following settings:

`fips`
: Allows OpenSSL to enforce FIPS-validated security during a Chef Infra Client run. Set to `true` to enable FIPS-validated security.
FIPS support is available in Chef Infra Client versions 12.8 and above.

The following operating systems are supported:

- Red Hat Enterprise Linux
Expand Down Expand Up @@ -163,13 +152,9 @@ The following operating systems are supported:
: Set the verify mode for HTTPS requests.

- Use `:verify_none` to do no validation of SSL certificates.
- Use `:verify_peer` to do validation of all SSL certificates,
including the Chef Infra Server connections, S3 connections, and
any HTTPS **remote_file** resource URLs used in a Chef Infra
Client run. This is the recommended setting.
- Use `:verify_peer` to do validation of all SSL certificates, including the Chef Infra Server connections, S3 connections, and any HTTPS **remote_file** resource URLs used in a Chef Infra Client run. This is the recommended setting.

Depending on how OpenSSL is configured, the `ssl_ca_path` may need
to be specified. Default value: `:verify_peer`.
Depending on how OpenSSL is configured, the `ssl_ca_path` may need to be specified. Default value: `:verify_peer`.

`syntax_check_cache_path`

Expand All @@ -181,7 +166,7 @@ The following operating systems are supported:

`validation_client_name`

: The name of the chef-validator key that is used by Chef Infra Client to access the Chef Infra Server during the initial Chef Infra Client run. For example:
: The name of the chef-validator key that is used by Chef Infra Client to access the Chef Infra Server during the initial Chef Infra Client run when not using validatorless bootstrapping. For example:

``` ruby
validation_client_name 'chef-validator'
Expand Down