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.

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

Deindent notes shortcodes #4206

Merged
merged 6 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions content/azure_chef_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This command has the following options:

`-a`, `--auto-update-client`

: Automatically update Chef Infra Client. Set to `true` to automatically update the version of the Azure Chef Extension when the virtual machine is restarted. For example, if this option is enabled, a virtual machine that has version `1205.12.2.0` will be updated automatically to `1205.12.2.1` when it is published. Default value: `false`.
: Automatically update Chef Infra Client. Set to `true` to automatically update the version of the Azure Chef Extension when the virtual machine is restarted. For example, if this option is enabled, a virtual machine that has version `1205.12.2.0` will be updated automatically to `1205.12.2.1` when it's published. Default value: `false`.

`-b`, `--disable`

Expand Down Expand Up @@ -146,17 +146,17 @@ The extension has the following options that can be provided in the

: Tells the extension whether the supplied validation key is `plaintext` or `base64encoded`.

{{< note spaces=4 >}}
{{< note >}}

If using the Chef extension in an ARM template, it is recommended that you base64 encode your validation key and set this option to `base64encoded`
If using the Chef extension in an ARM template, it's recommended that you base64 encode your validation key and set this option to `base64encoded`

{{< /note >}}

`bootstrap_version`

: The version of Chef Infra Client that will be installed on the system. **linux only**
: The version of Chef Infra Client that will be installed on the system. **Linux only**

{{< note spaces=4 >}}
{{< note >}}
Due to constraints in Azure, the `bootstrap_version` option is only available on the `LinuxChefClient` extension.
{{< /note >}}

Expand All @@ -168,7 +168,7 @@ The extension has the following options that can be provided in the

: Specifies a local path to install Chef Infra Client from. This feature is mainly used for cases where there are restrictions on internet access.

{{< note spaces=4 >}}
{{< note >}}
Azure extensions have network access limitations. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/features-linux#network-access) for more information.
{{< /note >}}

Expand All @@ -188,7 +188,7 @@ The extension has the following options that can be provided in the

: A hash of the following options: `chef_node_name`, `chef_server_url`, `environment`, `secret`, and `validation_client_name`.

{{< note spaces=4 >}}
{{< note >}}

Options that are supplied in the bootstrap items will take precedence over any conflicts found in the `client.rb` file.

Expand Down
6 changes: 3 additions & 3 deletions content/config_rb_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This configuration file has the following settings:
knife[:authentication_protocol_version] = '1.3'
```

{{< note spaces=4 >}}
{{< note >}}

Authentication protocol 1.3 is only supported on Chef Server versions 12.4.0 and above.

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

Default value: `true`. Set to `false` to disable running Chef Infra Client in fork node.

{{< note spaces=4 >}}
{{< note >}}

Must be set to `false` up to Chef Infra Client 13.11.3 to gather the standard return code offered by `exit_status true`. Later versions run as expected without changes to the configuration file.

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

Default value: `true`.

{{< warning spaces=4 >}}
{{< warning >}}

Changing this setting to `false` may cause file corruption, data loss, or instability. Use the `atomic_update` property on the **cookbook_file**, **file**, **remote_file**, and **template** resources to tune this behavior at the recipe level.

Expand Down
22 changes: 11 additions & 11 deletions content/config_rb_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ aliases = ["/config_rb_metadata.html"]

## Error Messages

The Chef Infra Server will only try to distribute the cookbooks that are needed to configure an individual node. This is determined by identifying the roles and recipes that are assigned directly to that system, and then to expand the list of dependencies, and then to deliver that entire set to the node. In some cases, if the dependency is not specified in the cookbook's metadata, the Chef Infra Server may not treat that dependency as a requirement, which will result in an error message. If an error message is received from the Chef Infra Server about cookbook distribution, verify the `depends` entries in the `metadata.rb` file, and then try again.
The Chef Infra Server will only try to distribute the cookbooks that are needed to configure an individual node. This is determined by identifying the roles and recipes that are assigned directly to that system, and then to expand the list of dependencies, and then to deliver that entire set to the node. In some cases, if the dependency isn't specified in the cookbook's metadata, the Chef Infra Server may not treat that dependency as a requirement, which will result in an error message. If an error message is received from the Chef Infra Server about cookbook distribution, verify the `depends` entries in the `metadata.rb` file, and then try again.

{{< note >}}

Expand All @@ -35,7 +35,7 @@ A metadata.json file can be edited directly, should temporary changes be require

## Version Constraints

Many fields in a cookbook's metadata allow the user to constrain versions. There are a set of operators common to all fields:
Many fields in a cookbook's metadata allow the user to constrain versions. The following operators are common to all fields:

<!-- markdownlint-disable MD033 -->
<table>
Expand Down Expand Up @@ -106,7 +106,7 @@ This configuration file has the following settings:

`depends`

: This field requires that a cookbook with a matching name and version exists on the Chef Infra Server. When the match exists, the Chef Infra Server includes the dependency as part of the set of cookbooks that are sent to the node during a Chef Infra Client run. It is important that the `depends` field contain accurate data. If a dependency statement is inaccurate, Chef Infra Client may not be able to complete the configuration of the system. All [version constraint operators](#version-constraints) are applicable to this field.
: This field requires that a cookbook with a matching name and version exists on the Chef Infra Server. When the match exists, the Chef Infra Server includes the dependency as part of the set of cookbooks that are sent to the node during a Chef Infra Client run. It's important that the `depends` field contain accurate data. If a dependency statement is inaccurate, Chef Infra Client may not be able to complete the configuration of the system. All [version constraint operators](#version-constraints) are applicable to this field.

For example, to set a dependency a cookbook named `cats`:

Expand Down Expand Up @@ -139,19 +139,19 @@ This configuration file has the following settings:
gem 'chef-sugar'
```

{{< warning spaces=4 >}}
{{< warning >}}

Use the `gem` setting only for making external chef libraries shipped as gems accessible in a Chef Infra Client run for libraries and attribute files. The `gem` setting in `metadata.rb` allows for the early installation of this specific type of gem, with the fundamental limitation that it cannot install native gems.
Use the `gem` setting only for making external chef libraries shipped as gems accessible in a Chef Infra Client run for libraries and attribute files. The `gem` setting in `metadata.rb` allows for the early installation of this specific type of gem, with the fundamental limitation that it can't install native gems.

Do not install native gems with the `gem` setting in `metadata.rb` . The `gem` setting is not a general purpose replacement for the [chef_gem resource](/resources/chef_gem/), and does not internally re-use the `chef_gem` resource. Native gems require C compilation and must not be installed with `metadata.rb` because `metadata.rb` runs before any recipe code runs. Consequently, Chef Infra Client cannot install the C compilers before the gem installation occurs. Instead, install native gems with the `chef_gem` resource called from the recipe code. You'll also need to use the `build_essential` resource in the recipe code to install the prerequisite compilers onto the system.
Don't install native gems with the `gem` setting in `metadata.rb`. The `gem` setting isn't a general purpose replacement for the [chef_gem resource](/resources/chef_gem/), and doesn't internally re-use the `chef_gem` resource. Native gems require C compilation and must not be installed with `metadata.rb` because `metadata.rb` runs before any recipe code runs. Consequently, Chef Infra Client Linux install the C compilers before the gem installation occurs. Instead, install native gems with the `chef_gem` resource called from the recipe code. You'll also need to use the `build_essential` resource in the recipe code to install the prerequisite compilers onto the system.

Pure ruby gems can also be installed with `metadata.rb`.

{{< /warning >}}

`issues_url`

: The URL for the location in which a cookbook's issue tracking is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the "View Issues" link.
: The URL of the location in which a cookbook's issue tracking is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the "View Issues" link.

For example:

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

`maintainer_email`

: The email address for the person responsible for maintaining a cookbook. Only one email can be listed here, so if this needs to be forwarded to multiple people consider using an email address that is already setup for mail forwarding.
: The email address for the person responsible for maintaining a cookbook. Only one email can be listed here, so if this needs to be forwarded to multiple people consider using an email address that's already setup for mail forwarding.

For example:

Expand Down Expand Up @@ -227,9 +227,9 @@ This configuration file has the following settings:
ohai_version '~> 8'
```

{{< note spaces=4 >}}
{{< note >}}

This setting is not visible in Chef Supermarket.
This setting isn't visible in Chef Supermarket.

{{< /note >}}

Expand All @@ -245,7 +245,7 @@ This configuration file has the following settings:

`source_url`

: The URL for the location in which a cookbook's source code is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the "View Source" link.
: The URL of the location in which a cookbook's source code is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the "View Source" link.

For example:

Expand Down
6 changes: 3 additions & 3 deletions content/ctl_chef_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ This command has the following options:

Use this option to set the `chef_environment` value for a node.

{{< note spaces=4 >}}
{{< note >}}

Any environment specified for `chef_environment` by a JSON file will take precedence over an environment specified by the `--environment` option when both options are part of the same command.

Expand All @@ -148,7 +148,7 @@ This command has the following options:

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

{{< note spaces=4 >}}
{{< note >}}

This has set the `normal` attribute
`node['override_attributes']['apptastic']`.
Expand Down Expand Up @@ -707,7 +707,7 @@ threads. To increase the system process limits:
chsec -f /etc/security/limits -s default -a "nofiles=50000"
```

{{< note spaces="4" >}}
{{< note >}}

The previous commands may be run against the root user, instead of
default. For example:
Expand Down
2 changes: 1 addition & 1 deletion content/ctl_chef_solo.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This command has the following options:

{{< readfile file="content/reusable/md/node_ctl_run_list.md" spaces=4 >}}

{{< warning spaces=4 >}}
{{< warning >}}

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

Expand Down
2 changes: 1 addition & 1 deletion content/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ using the following methods:
file, and then using `knife bootstrap -e environment_name` to
bootstrap the changes to the specified environment

{{< note spaces=4 >}}
{{< note >}}

After the environment has been set using bootstrap, the environment is
set in the client.rb file and may not be modified using the `edit` argument of the `knife node`
Expand Down
14 changes: 7 additions & 7 deletions content/server_ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
Availability installation as well as on Chef servers in a standalone
installation.

{{< warning spaces=4 >}}
{{< warning >}}

The following settings **MUST** be in the config file for LDAP
authentication to Active Directory to work:
Expand Down Expand Up @@ -99,7 +99,7 @@
'CN=user,OU=Employees,OU=Domainuser,DC=example,DC=com'
```

{{< note spaces=6 >}}
{{< note >}}

If you need to escape characters in a distinguished name, such as
when using Active Directory, they must be [escaped with a backslash
Expand Down Expand Up @@ -176,13 +176,13 @@
Default value: `false`. Must be `false` when `ldap['tls_enabled']`
is `true`.

{{< note spaces=6 >}}
{{< note >}}

Enable SSL for Active Directory.

{{< /note >}}

{{< note spaces=6 >}}
{{< note >}}

Previous versions of the Chef Infra Server used the
`ldap['ssl_enabled']` setting to first enable SSL, and then the
Expand All @@ -199,7 +199,7 @@
will display strings like "the corporate login server," "corporate
login," or "corporate password." Default value: `AD/LDAP`.

{{< warning spaces=6 >}}
{{< warning >}}

This setting **isn't** used by the Chef Infra Server. It's used only by the Chef management console.

Expand All @@ -213,11 +213,11 @@
`ldap['tls_enabled']`

: Enable TLS. When enabled, communication with the LDAP server is done
using a secure SSL connection on a dedicated port. Synonymous with STARTTLS. This mode is rarely used. When `true`,

Check failure on line 216 in content/server_ldap.md

View workflow job for this annotation

GitHub Actions / cspell-action

Unknown word (STARTTLS)
`ldap['port']` is also set to `636`. Default value: `false`. Must be
`false` when `ldap['ssl_enabled']` is `true`.

{{< note spaces=6 >}}
{{< note >}}

Previous versions of the Chef Infra Server used the
`ldap['ssl_enabled']` setting to first enable SSL, and then the
Expand All @@ -226,7 +226,7 @@

{{< /note >}}

{{< note spaces=4 >}}
{{< note >}}

If the `chef-server.rb` file doesn't exist, create a file called
`chef-server.rb` and put it in the `/etc/opscode/` directory.
Expand Down
Loading
Loading