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
* Emphasise source of design constraint
* Emphasise recommendation to use these keys when applicable
* Add `password` key following feedback from the bolt team
Copy file name to clipboardExpand all lines: language/resource-api/README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -432,23 +432,24 @@ Password attributes should also set `sensitive: true` to ensure that the data is
432
432
433
433
#### Schema
434
434
435
-
A transport schema accepts the following keywords:
435
+
To line up with [bolt's inventory file](https://puppet.com/docs/bolt/latest/inventory_file.html), a transport schema should prefer the following keywords when relevant:
436
436
437
-
* `uri`: use when you need to specify a specific URL to connect to. All of the following keys will be computed from the `uri` when possible. In the future more url parts may be computed from the URI.
438
-
* `host`: use to specify an IP or address to connect to.
437
+
* `uri`: use when you need to specify a specific URL to connect to. Bolt will compute the following keys from the `uri` when possible. In the future more url parts may be computed from the URI.
439
438
* `protocol`: use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`.
440
-
* `user`: the user the transport should connect as.
439
+
* `host`: use to specify an IP or address to connect to.
441
440
* `port`: the port the transport should connect to.
441
+
* `user`: the user the transport should connect as.
442
+
* `password`: the password for the specified user.
442
443
443
444
Do not use the following keywords when writing a schema:
444
445
446
+
* `implementations`: reserved by Bolt.
445
447
* `name`: transports should use `uri` instead of name.
446
448
* `path`: reserved as a uri part.
447
449
* `query`: reserved as a uri part.
448
-
* `run-on`: This is used by Bolt to determine which target to proxy to. Transports should not rely on this key.
449
-
* `remote-transport`: This is used to determine which transport to load. It should always be the transport class named "declassified".
450
450
* `remote-*`: any key starting with `remote-` is reserved for future use.
451
-
* `implementations`: reserved by Bolt.
451
+
* `remote-transport`: This is used to determine which transport to load. It should always be the transport class named "declassified".
452
+
* `run-on`: This is used by Bolt to determine which target to proxy to. Transports should not rely on this key.
0 commit comments