Merge pull request #89 from equinix-labs/create-pull-request/patch-17…

…28506190

generate-terraform-docs: automated action

README.md

@@ -496,7 +496,7 @@ It only requires the admin password (>=12 characters) that Rancher will use movi
 
 | Name | Version |
 |------|---------|
-| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | 1.14.3 |
+| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.14.2 |
 
 ### Modules
 
@@ -514,10 +514,10 @@ It only requires the admin password (>=12 characters) that Rancher will use movi
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project ID | `string` | n/a | yes |
 | <a name="input_clusters"></a> [clusters](#input\_clusters) | Cluster definition | <pre>list(object({<br/>    name                    = optional(string, "Demo cluster")<br/>    metro                   = optional(string, "FR")<br/>    plan_control_plane      = optional(string, "c3.small.x86")<br/>    plan_node               = optional(string, "c3.small.x86")<br/>    node_count              = optional(number, 0)<br/>    ha                      = optional(bool, false)<br/>    os                      = optional(string, "debian_11")<br/>    control_plane_hostnames = optional(string, "cp")<br/>    node_hostnames          = optional(string, "node")<br/>    custom_token            = optional(string, "")<br/>    ip_pool_count           = optional(number, 0)<br/>    kube_version            = optional(string, "")<br/>    metallb_version         = optional(string, "")<br/>    rancher_flavor          = optional(string, "")<br/>    rancher_version         = optional(string, "")<br/>    custom_rancher_password = optional(string, "")<br/>  }))</pre> | <pre>[<br/>  {}<br/>]</pre> | no |
 | <a name="input_deploy_demo"></a> [deploy\_demo](#input\_deploy\_demo) | Deploys a simple demo using a global IP as ingress and a hello-kubernetes pods | `bool` | `false` | no |
 | <a name="input_global_ip"></a> [global\_ip](#input\_global\_ip) | Enables a global anycast IPv4 that will be shared for all clusters in all metros | `bool` | `false` | no |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project ID | `string` | n/a | yes |
 
 ### Outputs
 

examples/demo_cluster/README.md

@@ -36,11 +36,11 @@ No resources.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | Your Equinix Metal API key | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Your Equinix Metal Project ID | `string` | n/a | yes |
 | <a name="input_clusters"></a> [clusters](#input\_clusters) | Cluster definition | <pre>list(object({<br/>    name                    = optional(string, "Demo cluster")<br/>    metro                   = optional(string, "FR")<br/>    plan_control_plane      = optional(string, "c3.small.x86")<br/>    plan_node               = optional(string, "c3.small.x86")<br/>    node_count              = optional(number, 0)<br/>    ha                      = optional(bool, false)<br/>    os                      = optional(string, "debian_11")<br/>    control_plane_hostnames = optional(string, "cp")<br/>    node_hostnames          = optional(string, "node")<br/>    custom_token            = optional(string, "")<br/>    ip_pool_count           = optional(number, 0)<br/>    kube_version            = optional(string, "")<br/>    metallb_version         = optional(string, "")<br/>    rancher_version         = optional(string, "")<br/>    rancher_flavor          = optional(string, "")<br/>    custom_rancher_password = optional(string, "")<br/>  }))</pre> | <pre>[<br/>  {}<br/>]</pre> | no |
 | <a name="input_deploy_demo"></a> [deploy\_demo](#input\_deploy\_demo) | Deploys a simple demo using a global IP as ingress and a hello-kubernetes pods | `bool` | `false` | no |
 | <a name="input_global_ip"></a> [global\_ip](#input\_global\_ip) | Enables a global anycast IPv4 that will be shared for all clusters in all metros | `bool` | `false` | no |
-| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | Your Equinix Metal API key | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Your Equinix Metal Project ID | `string` | n/a | yes |
 
 ### Outputs
 

modules/kube_cluster/README.md

@@ -26,8 +26,8 @@ This in-line module deploys the K3s/RKE2 cluster.
 
 | Name | Version |
 |------|---------|
-| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | 2.5.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | 3.6.3 |
+| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.14.2 |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 3.5.1 |
 
 ### Modules
 
@@ -55,6 +55,8 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project ID | `string` | n/a | yes |
 | <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Cluster name | `string` | `"Cluster"` | no |
 | <a name="input_control_plane_hostnames"></a> [control\_plane\_hostnames](#input\_control\_plane\_hostnames) | Control plane hostname prefix | `string` | `"cp"` | no |
 | <a name="input_custom_rancher_password"></a> [custom\_rancher\_password](#input\_custom\_rancher\_password) | Rancher initial password (autogenerated if not provided) | `string` | `null` | no |
@@ -64,8 +66,6 @@ No modules.
 | <a name="input_ha"></a> [ha](#input\_ha) | HA (aka 3 control plane nodes) | `bool` | `false` | no |
 | <a name="input_ip_pool_count"></a> [ip\_pool\_count](#input\_ip\_pool\_count) | Number of public IPv4 per metro to be used as LoadBalancers with MetalLB (it needs to be power of 2 between 0 and 256 as required by Equinix Metal) | `number` | `0` | no |
 | <a name="input_kube_version"></a> [kube\_version](#input\_kube\_version) | K3s/RKE2 version to be installed. Empty for latest K3s | `string` | `""` | no |
-| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project ID | `string` | n/a | yes |
 | <a name="input_metallb_version"></a> [metallb\_version](#input\_metallb\_version) | MetalLB version to be installed. Empty for latest | `string` | `""` | no |
 | <a name="input_node_count"></a> [node\_count](#input\_node\_count) | Number of nodes | `number` | `"0"` | no |
 | <a name="input_node_hostnames"></a> [node\_hostnames](#input\_node\_hostnames) | Node hostname prefix | `string` | `"node"` | no |