Skip to content

Add reserved and recommended keywords for transport schemas #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2019
Merged

Add reserved and recommended keywords for transport schemas #137

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6ca6ef
Add reserved and recommended keywords for transport schemas
DavidS Mar 21, 2019
22f5f34
Remove copy&paste mistake
DavidS Mar 21, 2019
df914aa
Update README.md
clairecadman Mar 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion language/resource-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ To support Puppet versions prior to 6, see the [Legacy Support](#legacy-support)
### Transport

```ruby
# lib/puppet/transport/nexus_schema.rb
# lib/puppet/transport/schema/nexus.rb
Puppet::ResourceAPI.register_transport(
name: 'nexus', # points at class Puppet::Transport::Nexus
desc: 'Connects to a Cisco Nexus device',
Expand Down Expand Up @@ -418,6 +418,24 @@ A transport connects providers to the remote target. It consists of the schema a

Password attributes should also set `sensitive: true` to ensure that the data is handled securely. Attributes marked with this flag allow any UI based off this schema to make appropriate presentation choices. The value will be passed to the transport wrapped in a `Puppet::Pops::Types::PSensitiveType::Sensitive`. This will keep the value from being logged or saved inadvertently while it is being transmitted between components. To access the value within the Transport use the `unwrap` method. e.g. `connection_info[:password].unwrap`.

A transport schema accepts the following keywords:

* `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.
* `host`: use to specify an IP or address to connect to.
* `protocol`: use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`.
* `user`: the user the transport should connect as.
* `port`: the port the transport should connect to.

Do not use the following keywords when writing a schema:

* `name`: transports should use `uri` instead of name.
* `path`: reserved as a uri part.
* `query`: reserved as a uri part.
* `run-on`: This is used by Bolt to determine which target to proxy to. Transports should not rely on this key.
* `remote-transport`: This is used to determine which transport to load. It should always be the transport class named "declassified".
* `remote-*`: any key starting with `remote-` is reserved for future use.
* `implementations`: reserved by Bolt.

The transport implementation must implement the following methods:

* `initialize(context, connection_info)`
Expand Down