Skip to content

Commit 9e23625

Browse files
author
Will Meek
committed
(FM-7819) Detail known Bolt keywords
Detail the keywords currently known from Bolt
1 parent 1dc1a27 commit 9e23625

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,31 @@ Puppet::ResourceAPI.register_transport(
268268
)
269269
```
270270

271-
After this, `puppet device` will be able to use the new provider, and supply it (through the device class) with the URL specified in the [`device.conf`](https://puppet.com/docs/puppet/5.3/config_file_device.html).
271+
##### Transport Schema keywords
272+
273+
Please note that within the transport schema, the following keywords are reserved words:
274+
275+
###### Usable within the schema
276+
277+
The following keywords are encouraged within the Transport schema:
278+
279+
* `host` - Use to specify and IP or address to connect to
280+
* `uri` - Use when you need to specify a specific URL to connect to. Cannot be used alongside host.
281+
* `protocol` - this can be - depending on Bolt execution method:
282+
* `remote`
283+
* `local`
284+
285+
286+
###### Non-Usable within the schema
287+
288+
The following keywords are keywords that must not be used by the transport schema:
289+
290+
* `credentials`
291+
* `name`
292+
* `run-on`
293+
* `remote-*` - Any keywords beginning `remote-`
294+
295+
After the device class, transport class and transport schema have been implemented, `puppet device` will be able to use the new provider, and supply it (through the device class) with the URL specified in the [`device.conf`](https://puppet.com/docs/puppet/5.3/config_file_device.html).
272296

273297
#### Transport/device specific providers
274298

0 commit comments

Comments
 (0)