Skip to content
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.

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

Improve remote block docs for local unix sockets #190

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

mttjohnson
Copy link
Contributor

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 the address 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 when schema is set to unix.

@mttjohnson
Copy link
Contributor Author

I was testing this in relation to a pull request on the incus-deploy repo lxc/incus-deploy#16

@maveonair maveonair enabled auto-merge January 13, 2025 11:05
@maveonair maveonair disabled auto-merge January 13, 2025 11:05
Copy link
Member

@maveonair maveonair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please combine the commits into a single one and add a commit message that follows our contribution guidelines?

Here’s an example: docs: Improve remote block for local unix sockets

@mttjohnson
Copy link
Contributor Author

I updated my branch, combined my changes into a single commit, and updated the commit comment as requested.

@mttjohnson mttjohnson requested a review from maveonair January 14, 2025 01:04
Copy link
Member

@maveonair maveonair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@maveonair maveonair merged commit 6299cb7 into lxc:main Jan 14, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants