Add quickstart guide for DHCP #68
Conversation
| } | ||
| ```` | ||
|
|
||
| !> Warning: Hard-coded credentials are not recommended in any configuration file. It is recommended to use environment variables. |
There was a problem hiding this comment.
is that a valid markdown ?
There was a problem hiding this comment.
Terraform Registry documentation accepts it as a special case. It shows up as a colored callout box.
https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
templates/guides/quickstart-dhcp.md
Outdated
|
|
||
| ```` | ||
|
|
||
| We can now run `terraform plan` to see what resources will be created. |
There was a problem hiding this comment.
Guides are usually written in an impersonal style. The beginning of the guid talks to the user with "You", it should continue to do so all along.
There was a problem hiding this comment.
Fixed the "we" language.
templates/guides/quickstart-dhcp.md
Outdated
|
|
||
| Further, we will create a range and a fixed address reservation within the subnet. | ||
|
|
||
| We will use the following resources to create these |
templates/guides/quickstart-dhcp.md
Outdated
| dhcp_options = [ | ||
| { | ||
| option_code = local.dhcp4_option_code_lookup["domain-name-servers"] | ||
| option_value = "1.1.1.1" |
There was a problem hiding this comment.
Let's avoid promoting a competitor (cloudflare's dns address)...
Use an address within the 10/16 network.
There was a problem hiding this comment.
Changed to 10.0.0.1
| } | ||
| ```` | ||
|
|
||
| !> Warning: Hard-coded credentials are not recommended in any configuration file. It is recommended to use the AWS credentials file or environment variables. |
| @@ -24,5 +24,6 @@ testacc: | |||
|
|
|||
| gen: | |||
| go generate | |||
| terraform-docs ./modules/bloxone_infra_host_aws | |||
There was a problem hiding this comment.
| terraform-docs ./modules/bloxone_infra_host_aws | |
| terraform-docs ./modules/ |
There was a problem hiding this comment.
To support future modules(GCP, Azure)
There was a problem hiding this comment.
This doesn't work. The terraform-docs requires the proper directory and does not recursively figure out the sub directories
There was a problem hiding this comment.
https://terraform-docs.io/user-guide/configuration/recursive/
Can we try this?
There was a problem hiding this comment.
Tried it, still doesn't work correctly. That works only for child modules. Our directory structure is a bit different.
| ````terraform | ||
| terraform { | ||
| required_providers { | ||
| bloxone = { |
There was a problem hiding this comment.
We should mention the terraform client version has to be >= 1.0.0.
Why do we want the provider version to 0.1.X? We are planning to release 1.0.0 and this wouldn't allow that. See: https://developer.hashicorp.com/terraform/tutorials/configuration-language/versions#review-example-configuration
docs/guides/quickstart-dhcp.md
Outdated
| terraform { | ||
| required_providers { | ||
| bloxone = { | ||
| source = "infobloxopen/bloxone" | ||
| version = "~> 0.1.0" | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
| terraform { | |
| required_providers { | |
| bloxone = { | |
| source = "infobloxopen/bloxone" | |
| version = "~> 0.1.0" | |
| } | |
| } | |
| } | |
| terraform { | |
| required_providers { | |
| bloxone = { | |
| source = "infobloxopen/bloxone" | |
| version = ">= 0.1.0" | |
| } | |
| } | |
| required_version = ">= 1.0.0" | |
| } |
Added quickstart guide for DHCP
Made minor corrections to other documentation