(PUP-9747) update bolt transport key description #142
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Emphasise source of design constraint * Emphasise recommendation to use these keys when applicable * Add `password` key following feedback from the bolt team * Add note on bolt behaviour of `uri` vs `name`
DavidS
force-pushed
the
pup-9747-bolt-keys
branch
from
0bcd36c to
e362d8b
Compare
clairecadman
approved these changes
Jun 12, 2019
Contributor
clairecadman
left a comment
clairecadman
left a comment
There was a problem hiding this comment.
I made a few minor edits.
DavidS
added a commit
to DavidS/puppet-resource_api
that referenced
this pull request
Jun 12, 2019
Bolt always provides all computed connection info attributes to tasks, instead of only the ones the user provided. Therefore we can't be strict when validating the passed in arguments. To limit the impact to bolt users, this change makes the relaxed validation trigger only when a `'remote-transport'` key is specified, as that is always provided by bolt. This also contains the docs changes from puppetlabs/puppet-specifications#142
DavidS
added a commit
to DavidS/puppet-resource_api
that referenced
this pull request
Jun 12, 2019
Bolt always provides all computed connection info attributes to tasks, instead of only the ones the user provided. Therefore we can't be strict when validating the passed in arguments. To limit the impact to bolt users, this change makes the relaxed validation trigger only when a `'remote-transport'` key is specified, as that is always provided by bolt. This also contains the docs changes from puppetlabs/puppet-specifications#142
da-ar
reviewed
Jun 13, 2019
language/resource-api/README.md
Outdated
| * `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. | ||
| * `remote-transport`: determines which transport to load. It is always the transport class named "declassified". |
There was a problem hiding this comment.
It is always the transport class named "declassified".
The sentence doesn't make sense to me. It reads like remote-transport: declassified.
Should it be: It is always the transport class name "declassified".`
If so, I believe it may make more sense to be written as:
It is always the transport class name written in lowercase. e.g. class Panos becomes panos
Contributor
Author
There was a problem hiding this comment.
It should always be the transport name. The class name for the transport is the snake case (SnakeCase) version of the transport name.
good spot, @da-ar
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
passwordkey following feedback from the bolt team