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

Fix docs extra disks #159

Merged
merged 3 commits into from
May 3, 2023
Merged

Fix docs extra disks #159

merged 3 commits into from
May 3, 2023

Conversation

lbajolet-hashicorp
Copy link
Contributor

When the disk_attachment block was introduced to the builder, the docs weren't updated, making the feature essentially invisible for users.

This commit adds a section to document those, and links for easier navigation in the docs.

@lbajolet-hashicorp lbajolet-hashicorp requested a review from a team as a code owner May 1, 2023 21:16
These can be defined using the [disk_attachment](#disk_attachment) block in the configuration.

Note that this is an array, and therefore in HCL2 can be defined as multiple blocks, each
one corresponding to a disk that will be attached to the instance you are booting.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be helpful to add an example hcl2 block here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, I added one example with two disks defined in the template. Also to make sure it works well, I added an acceptance test for this case.

Copy link
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

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

This looks good to me. I left a question about adding an example. There looks to be a number of configuration attributes. So I'm not sure if an example would help or add confusion for a new user.

Copy link
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

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

Looks good. Love the tests.

@lbajolet-hashicorp lbajolet-hashicorp merged commit ceee881 into main May 3, 2023
@lbajolet-hashicorp lbajolet-hashicorp deleted the fix_docs_extra_disks branch May 3, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants