Improve remote block docs for local unix sockets #190
Merged
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.
I was confused when trying to define the remote block for the incus host I want Terraform/OpenTofu to talk to and was using variables to set the values for the remote. While the arguments are optional and some of the defaults are stated I found that the
schema
value can change how theaddress
argument is used. When the arguments are not present they will use a default value, but I needed the same behavior when an argument was present and contained a value.I thought it might be useful to provide both an example of a defined local connection to a UNIX socket and a connection to a remote Incus host that would connect over HTTPS.
I also provided a suggestion for updating the description on the
address
field to indicate how the fields value changes whenschema
is set tounix
.