Skip to content

Commit

Permalink
Merge pull request #102 from equinix-labs/create-pull-request/patch-1…
Browse files Browse the repository at this point in the history
…723575447

generate-terraform-docs: automated action
  • Loading branch information
displague authored Aug 13, 2024
2 parents 60579f9 + d4f9d67 commit 03e6cc5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions examples/cluster-migration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,12 +287,14 @@ This example demonstrates how to create two Nutanix clusters and set up a protec
| <a name="input_create_project"></a> [create\_project](#input\_create\_project) | (Optional) to use an existing project matching `metal_project_name`, set this to false. | `bool` | `true` | no |
| <a name="input_create_vlan"></a> [create\_vlan](#input\_create\_vlan) | Whether to create a new VLAN for this project. | `bool` | `true` | no |
| <a name="input_create_vrf"></a> [create\_vrf](#input\_create\_vrf) | Whether to create a new VRF for this project. | `bool` | `true` | no |
| <a name="input_metal_nutanix_os"></a> [metal\_nutanix\_os](#input\_metal\_nutanix\_os) | The Equinix Metal OS to use for the Nutanix nodes. nutanix\_lts\_6\_5 is available for Nutanix certified hardware reservation instances. nutanix\_lts\_6\_5\_poc may be available upon request. | `string` | `"nutanix_lts_6_5"` | no |
| <a name="input_metal_organization_id"></a> [metal\_organization\_id](#input\_metal\_organization\_id) | The ID of the Metal organization in which to create the project if `create_project` is true. | `string` | `null` | no |
| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | The ID of the Metal project in which to deploy to cluster. If `create_project` is false and<br> you do not specify a project name, the project will be looked up by ID. One (and only one) of<br> `metal_project_name` or `metal_project_id` is required or `metal_project_id` must be set. | `string` | `""` | no |
| <a name="input_metal_project_name"></a> [metal\_project\_name](#input\_metal\_project\_name) | The name of the Metal project in which to deploy the cluster. If `create_project` is false and<br>you do not specify a project ID, the project will be looked up by name. One (and only one) of<br>`metal_project_name` or `metal_project_id` is required or `metal_project_id` must be set.<br>Required if `create_project` is true. | `string` | `""` | no |
| <a name="input_metal_subnet"></a> [metal\_subnet](#input\_metal\_subnet) | IP pool for all Nutanix Clusters in the example. One bit will be appended to the end and divided between example clusters. (192.168.96.0/21 will result in clusters with ranges 192.168.96.0/22 and 192.168.100.0/22) | `string` | `"192.168.96.0/21"` | no |
| <a name="input_metal_vlan_id"></a> [metal\_vlan\_id](#input\_metal\_vlan\_id) | ID of the VLAN you wish to use. | `number` | `null` | no |
| <a name="input_nutanix_node_count"></a> [nutanix\_node\_count](#input\_nutanix\_node\_count) | The number of Nutanix nodes to create. | `number` | `2` | no |
| <a name="input_nutanix_reservation_ids"></a> [nutanix\_reservation\_ids](#input\_nutanix\_reservation\_ids) | Hardware reservation IDs to use for the Nutanix nodes. If specified, the length of this list must<br> be the same as `nutanix_node_count` for each cluster. Each item can be a reservation UUID or `next-available`. If<br> you use reservation UUIDs, make sure that they are in the same metro specified in `metal_metro`. | <pre>object({<br> cluster_a = list(string)<br> cluster_b = list(string)<br> })</pre> | <pre>{<br> "cluster_a": [],<br> "cluster_b": []<br>}</pre> | no |
| <a name="input_vrf_id"></a> [vrf\_id](#input\_vrf\_id) | ID of the VRF you wish to use. | `string` | `null` | no |
## Outputs
Expand Down

0 comments on commit 03e6cc5

Please sign in to comment.