Skip to content

Commit 2397008

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

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,28 @@ 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 by [`Bolt`](https://puppet.com/docs/bolt/latest/bolt.html).
274+
275+
###### Usable within the schema
276+
277+
The following keywords are Bolt keywords that can be used by the transport schema:
278+
279+
* `host`
280+
* `name`
281+
* `protocol`
282+
* `uri`
283+
284+
###### Non-Usable within the schema
285+
286+
The following keywords are Bolt keywords that must not be used by the transport schema:
287+
288+
* `run-on`
289+
* `remote-transport`
290+
* `credentials`
291+
292+
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).
272293

273294
#### Transport/device specific providers
274295

0 commit comments

Comments
 (0)