Guide for tofu openstack config usage - #19
Conversation
c0d600a to
6171886
Compare
ddb3ab7 to
b10027d
Compare
1bc0015 to
ccdfb0b
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
L-Chams
left a comment
L-Chams
left a comment
There was a problem hiding this comment.
Looking good, just a few grammatical changes I'd recommend.
sjpb
left a comment
sjpb
left a comment
There was a problem hiding this comment.
Think it needs some work:
a. Make it clear what's different from the README - maybe some stuff needs moving from there to here.
b. Currently it just shows structures, so you're still going to have to read the code to find out types and optional/required.
If you really want to add this much detail, I think it needs to be much more like the provider docs TBH, e.g. https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/compute_instance_v2.html
which has examples, optional/required, type information and descriptions. If you want to do that - which is useful - I'd be tempted to point an LLM at it as a first pass, then review carefully!
| @@ -0,0 +1,69 @@ | |||
| > **WARNING:** | |||
There was a problem hiding this comment.
| @@ -0,0 +1,28 @@ | |||
| # Tofu OpenStack Config User Guide | |||
There was a problem hiding this comment.
| # Tofu OpenStack Config User Guide | |
| ## Tofu OpenStack Config User Guide |
for consistency
| - Note that the `--output` argument can be used to determine where files are | ||
| generated. | ||
|
|
||
| ## VAST Support |
There was a problem hiding this comment.
Should this be here? Why does it alone get a demo here?
There was a problem hiding this comment.
Moved to docs/vast.md but left a reference to this in the readme
c01f6d3 to
c3f7e3a
Compare
| - `end` (Required) number | ||
| - `client_ip_ranges` (Optional) list. Overrides `client_ranges`. | ||
|
|
||
| ## Vast Provider |
There was a problem hiding this comment.
Can we move this to the top? Logically you need to know about this before the resources
There was a problem hiding this comment.
I thought you were going to signpost the shared_filesystems.md from here too? I can't find such?
| skip_ssl_verify = true | ||
| } | ||
|
|
||
| variable "vast_password" { |
There was a problem hiding this comment.
I still think we should note that this ends up in state. It is not unique to this provider, but it is a massive potential gocha for a filesystem and e.g. the openstack provider does not store creds in state, so it is not obvious.
3 participants
User guide for
tofu-openstack-config#21 should be merged first.