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
Copy file name to clipboardExpand all lines: content/attribute_arrays.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ override_attributes(
29
29
)
30
30
```
31
31
32
-
But what if all of the web servers are not the same? What if some of the web servers required a single attribute to have a different value? You could store these settings in two locations, once just like the preceding example and once just like the following:
32
+
But what if all of the web servers aren't the same? What if some of the web servers required a single attribute to have a different value? You could store these settings in two locations, once just like the preceding example and once just like the following:
33
33
34
34
```ruby
35
35
override_attributes(
@@ -44,7 +44,7 @@ override_attributes(
44
44
)
45
45
```
46
46
47
-
But that is not efficient, especially because most of them are identical. The deep merge capabilities of Chef Infra Client allows attributes to be layered across cookbooks, recipes, roles, and environments. This allows an attribute to be reused across nodes, making use of default attributes set at the cookbook level, but also providing a way for certain attributes (with a higher attribute precedence) to be applied only when they are supposed to be.
47
+
But that'sn't efficient, especially because most of them are identical. The deep merge capabilities of Chef Infra Client allows attributes to be layered across cookbooks, recipes, roles, and environments. This allows an attribute to be reused across nodes, making use of default attributes set at the cookbook level, but also providing a way for certain attributes (with a higher attribute precedence) to be applied only when they're supposed to be.
48
48
49
49
For example, a role named `baseline.rb`:
50
50
@@ -115,7 +115,7 @@ to produce results like this:
115
115
}
116
116
```
117
117
118
-
Even though the `web.rb` file does not contain attributes and values for `minspareservers`, `maxspareservers`, `serverlimit`, `maxclients`, and `maxrequestsperchild`, the deep merge capabilities pulled them in.
118
+
Even though the `web.rb` file doesn't contain attributes and values for `minspareservers`, `maxspareservers`, `serverlimit`, `maxclients`, and `maxrequestsperchild`, the deep merge capabilities pulled them in.
Copy file name to clipboardExpand all lines: content/attribute_precedence.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ The attribute precedence order for the sources "roles" and "environments" are op
29
29
Applying the role `override` first lets you use the same role in a set of environments.
30
30
Applying the environment `override` on top of the role `override` lets you define a subset of these with environment-specific settings.
31
31
32
-
This is useful if you have an environment that is different within a sub-set of a role. For example, the role for an application server may exist in all environments, but one environment may use a different database server.
32
+
This is useful if you have an environment that's different within a sub-set of a role. For example, the role for an application server may exist in all environments, but one environment may use a different database server.
Copy file name to clipboardExpand all lines: content/azure_powershell.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ on virtual machines in Microsoft Azure.
22
22
### Get-AzureVMChefExtension
23
23
24
24
Use the `Get-AzureVMChefExtension` cmdlet to get the details for the
25
-
Azure Chef Extension that is running on the named virtual machine.
25
+
Azure Chef Extension that's running on the named virtual machine.
26
26
27
27
#### Syntax
28
28
@@ -70,11 +70,11 @@ This cmdlet has the following options:
70
70
71
71
`-AutoUpdateChefClient`
72
72
73
-
: Automatically update . 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.
73
+
: Automatically update . 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.
74
74
75
75
`-BootstrapOptions <string>`
76
76
77
-
: A JSON string that is added to the first run of a Chef Infra Client.
77
+
: A JSON string that's added to the first run of a Chef Infra Client.
A **Test Drive** is a ready-to-go environment that allows you to experience Chef Automate for free, without an Azure subscription (You will need a [Microsoft account](https://signup.live.com/). The Test Drive comes already provisioned---you do not need to download, set up, or configure it---instead, you can spend two hours evaluating the user experience, key features, and benefits of the product.
25
+
A **Test Drive** is a ready-to-go environment that allows you to experience Chef Automate for free, without an Azure subscription (You will need a [Microsoft account](https://signup.live.com/). The Test Drive comes already provisioned---you don't need to download, set up, or configure it---instead, you can spend two hours evaluating the user experience, key features, and benefits of the product.
The following information applies to on-premises Chef Infra Server and does not apply to Hosted Chef.
34
+
The following information applies to on-premises Chef Infra Server and doesn't apply to Hosted Chef.
35
35
36
36
{{< /warning >}}
37
37
@@ -41,7 +41,7 @@ The following information applies to on-premises Chef Infra Server and does not
41
41
42
42
Your organization may use a private Certificate Authority (CA) to generate SSL Certificates or they may create self-signed SSL certificates to use on internal networks or during software development and testing.
43
43
44
-
The `trusted_certs` directory on Chef Workstation and in Chef Infra Client works as a trusted certificate store for all communication in the Chef Infra system. Chef Infra trusts all SSL certificates stored in this directory--including certificates that are not issued by a trusted Certificate Authority (CA).
44
+
The `trusted_certs` directory on Chef Workstation and in Chef Infra Client works as a trusted certificate store for all communication in the Chef Infra system. Chef Infra trusts all SSL certificates stored in this directory--including certificates that aren't issued by a trusted Certificate Authority (CA).
45
45
46
46
Place private and self-signed certificates in the `trusted_certs` directory to use them within Chef Infra Client and Workstation tools.
47
47
@@ -67,7 +67,7 @@ When you bootstrap a node, the Chef Infra Client copies the SSL certificates for
67
67
68
68
Use the `SSL_CERT_FILE` environment variable to specify the location for the SSL certificate authority (CA) bundle for Chef Infra Client.
69
69
70
-
A value for `SSL_CERT_FILE`is not set by default. Unless updated, the locations in which Chef Infra will look for SSL certificates are:
70
+
A value for `SSL_CERT_FILE`isn't set by default. Unless updated, the locations in which Chef Infra will look for SSL certificates are:
71
71
72
72
- Chef Infra Client: `/opt/chef/embedded/ssl/certs/cacert.pem`
73
73
- Chef Workstation: `/opt/chef-workstation/embedded/ssl/certs/cacert.pem`
Copy file name to clipboardExpand all lines: content/chef_compliance_phase.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Chef Infra Client's Compliance Phase lets you automatically execute compliance a
18
18
Existing audit cookbook users can migrate to the new Compliance Phase by removing the audit cookbook from their run_list and setting the `node['audit']['compliance_phase']` attribute to `true`.
19
19
20
20
The Compliance Phase replaces the `audit cookbook` by integrating Chef InSpec compliance checks into the [Chef Infra Client run]({{< relref "chef_client_overview.md" >}})
21
-
The Compliance Phase is designed to run on any node in your system that is set up--or [bootstrapped]({{< relref "install_bootstrap" >}})--for a `chef-client` run.
21
+
The Compliance Phase is designed to run on any node in your system that's set up--or [bootstrapped]({{< relref "install_bootstrap" >}})--for a `chef-client` run.
22
22
23
23
**New in Chef Infra Client 17.8**
24
24
@@ -176,7 +176,7 @@ The following examples:
176
176
177
177
### Reporters
178
178
179
-
Reporters control what is done with the resulting report after the Chef InSpec run. Either a single value or a list of multiple values is supported. The default is the `cli` and `json-file` reporters.
179
+
Reporters control what's done with the resulting report after the Chef InSpec run. Either a single value or a list of multiple values is supported. The default is the `cli` and `json-file` reporters.
180
180
181
181
Reporters can send Compliance Phase results to:
182
182
@@ -303,7 +303,7 @@ There are two primary ways to pass Chef Infra node data to Chef InSpec run durin
303
303
304
304
##### Explicitly pass necessary data (recommended)
305
305
306
-
Any data added to the `node['audit']['attributes']` hash will be passed as individual Chef InSpec attributes. This provides a clean interface between the Chef Infra client run and Chef InSpec profile, allowing for easy assignment of default values in the Chef InSpec profile. This method is especially recommended if the Chef InSpec profile is expected to be used outside of the context of Compliance Phase so it is made explicit to profile consumers what attributes are necessary. Set the attributes in your cookbook attributes file and then use them in your Chef InSpec profile.
306
+
Any data added to the `node['audit']['attributes']` hash will be passed as individual Chef InSpec attributes. This provides a clean interface between the Chef Infra client run and Chef InSpec profile, allowing for easy assignment of default values in the Chef InSpec profile. This method is especially recommended if the Chef InSpec profile is expected to be used outside of the context of Compliance Phase so it's made explicit to profile consumers what attributes are necessary. Set the attributes in your cookbook attributes file and then use them in your Chef InSpec profile.
307
307
308
308
Set the attributes in a cookbook attributes file:
309
309
@@ -322,7 +322,7 @@ environment = attribute('environment', description: 'The Chef Infra environment
322
322
323
323
control 'debug-disabled-in-production'do
324
324
title 'Debug logs disabled in production'
325
-
desc 'Debug logs contain potentially sensitive information and should not be on in production.'
325
+
desc 'Debug logs contain potentially sensitive information and shouldn't be on in production.'
326
326
impact 1.0
327
327
328
328
describe file('/path/to/my/app/config') do
@@ -337,7 +337,7 @@ end
337
337
338
338
Compliance Phase can be configured to pass the Chef Infra node object as a Chef InSpec attribute named `chef_node`.
339
339
340
-
While using the `chef_node` object provides the ability to write more flexible profiles, it is difficult to reuse these profiles outside of the Compliance Phase. To reuse these profiles, you will need to understand how to pass in a single attribute containing Chef Infra-like data. Pass external data explicitly whenever possible.
340
+
While using the `chef_node` object provides the ability to write more flexible profiles, it's difficult to reuse these profiles outside of the CompliancePhase. To reuse these profiles, you will need to understand how to pass in a single attribute containing ChefInfra-like data. Pass external data explicitly whenever possible.
341
341
342
342
To use this option, first set it in a wrapper cookbook:
Controls what is done with the resulting report after the ChefInSpec run. Accepts a single string value or an array of multiple values. The'cli' reporter mimics the ChefInSpec command line output in your terminal, which lets you see your system's compliance status at the end of the Compliance Phase. Accepted values: 'chef-server-automate', 'chef-automate', 'json-file', 'audit-enforcer', 'cli'
485
+
Controls what's done with the resulting report after the ChefInSpec run. Accepts a single string value or an array of multiple values. The'cli' reporter mimics the ChefInSpec command line output in your terminal, which lets you see your system's compliance status at the end of the Compliance Phase. Accepted values: 'chef-server-automate', 'chef-automate', 'json-file', 'audit-enforcer', 'cli'
When a Chef InSpec resource throws an exception, results contain a short error message and a detailed ruby stacktrace of the error. Default: false (does not send backtrace). Example:
503
+
When a Chef InSpec resource throws an exception, results contain a short error message and a detailed ruby stacktrace of the error. Default: false (doesn't send backtrace). Example:
Truncates any control result messages exceeding this character limit. Chef Automate has a 4 MB report size limit and cannot ingest reports exceeding this limitation. Chef InSpec will append this text at the end of any truncated messages: `[Truncated to 10000 characters]` Default: 10000.
512
+
Truncates any control result messages exceeding this character limit. ChefAutomate has a 4MB report size limit andcan't ingest reports exceeding this limitation. Chef InSpec will append this text at the end of any truncated messages: `[Truncated to 10000 characters]` Default: 10000.
513
513
514
514
```ruby
515
515
default['audit']['result_message_limit] =10000
@@ -557,7 +557,7 @@ Depending on your setup, there are some limits you need to be aware of. A common
557
557
558
558
#### 401, 403 Unauthorized - bad clock
559
559
560
-
Occasionally, the system date/time will drift between client and server. If this drift is greater than a couple of minutes, the Chef Infra Server will throw a 401 unauthorized and the request will not be forwarded to the Chef Automate server.
560
+
Occasionally, the system date/time will drift between client and server. If this drift is greater than a couple of minutes, the Chef Infra Server will throw a 401 unauthorized and the request won't be forwarded to the Chef Automate server.
561
561
562
562
On the Chef Infra Server you can see this in the following logs:
563
563
@@ -652,7 +652,7 @@ The 413 "Request Entity Too Large" error appears in both the stacktrace and the
652
652
653
653
## Troubleshooting
654
654
655
-
Chef Automate sets the `logstash` limit to 10% of the system memory automatically as part of the `automate-ctl reconfigure` command execution. You have reached the java heap size(`-Xmx`) limit of `logstash` if a Chef InSpec report does not become available in Chef Automate and this error is in the `logstash` logs:
655
+
Chef Automate sets the `logstash` limit to 10% of the system memory automatically as part of the `automate-ctl reconfigure` command execution. You have reached the java heap size(`-Xmx`) limit of `logstash` if a Chef InSpec report doesn't become available in Chef Automate and this error is in the `logstash` logs:
0 commit comments