Skip to content

Commit 6ae0566

Browse files
committed
Minor edits
Signed-off-by: Ian Maddaus <[email protected]>
1 parent 40461f0 commit 6ae0566

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

content/target_mode.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,12 @@ Target Mode has the following requirements:
3535

3636
The credentials file defines the connection settings for each node in TOML format.
3737

38-
The credentials file is located in `~/.chef/credentials` on Linux and Mac systems, or `c:\Users\<USERNAME>\.chef\credentials` on Windows.
38+
Create a credentials file on the computer running Chef Workstation in the following location:
3939

40-
### Examples
40+
- on Linux and macOS: `~/.chef/credentials`
41+
- on Windows: `c:\Users\<USERNAME>\.chef\credentials`
42+
43+
### Define node connection settings
4144

4245
Define the list of nodes in the credentials file using the TOML format.
4346
The connection settings for each node are defined using a [TOML Inline Table](https://toml.io/en/v1.0.0#inline-table).
@@ -107,7 +110,7 @@ host = '<IP_ADDRESS OR FQDN>'
107110
transport_protocol = 'ssh'
108111
```
109112

110-
### SSH parameters
113+
### Node connection parameters
111114

112115
<!-- markdownlint-disable MD007 MD006 -->
113116

@@ -155,12 +158,12 @@ Additional parameters:
155158
Default value: `"root"`
156159

157160
`forward_agent`
158-
: Whether the connection to the authentication agent (if any) will be forwarded to the remote machine.
161+
: Whether the connection to the authentication agent (if any) is forwarded to the remote machine.
159162

160163
Default value: `false`
161164

162165
`verify_host_key`
163-
: Whether to verify the host key.
166+
: Whether to verify the host key.
164167

165168
Allowed values: `true`, `false`. Default value: `false`
166169

@@ -198,7 +201,7 @@ Run the `chef-client` executable using `-t` or `--target` to target a specific n
198201
chef-client -t <TARGET_NAME>
199202
```
200203

201-
Replace `<TARGET_NAME>` with the name of the host as defined in the credentials file. For example, `HOST-1` in the [credential file example](#examples).
204+
Replace `<TARGET_NAME>` with the name of the host as defined in the credentials file. For example, `HOST-1` in the [credential file example](#define-node-connection-settings).
202205

203206
To execute a specific Cookbook in Target Mode, run:
204207

@@ -222,7 +225,7 @@ Use `-z` and `-t` to run Target Mode in Local Mode:
222225
chef-client -z -t <TARGET_NAME>
223226
```
224227

225-
Replace `<TARGET_NAME>` with the name of the host as defined in the credentials file. For example, `HOST-1` in the [credential file example](#examples).
228+
Replace `<TARGET_NAME>` with the name of the host as defined in the credentials file. For example, `HOST-1` in the [credential file example](#define-node-connection-settings).
226229

227230
## Run Target Mode with Chef Automate or Chef Infra Server
228231

0 commit comments

Comments
 (0)