From 5dac85f6351317b2c86e92b3b56fafcb6570e2e4 Mon Sep 17 00:00:00 2001 From: displague Date: Mon, 5 Jun 2023 18:08:07 +0000 Subject: [PATCH] generate-terraform-docs: automated action Signed-off-by: GitHub --- README.md | 14 +++++++------- examples/demo_cluster/README.md | 14 +++++++------- modules/k3s_cluster/README.md | 12 ++++++------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0521199..9c29f20 100644 --- a/README.md +++ b/README.md @@ -303,32 +303,32 @@ sv-k3s-aio Ready control-plane,master 9m20s v1.26.5+k3s1 -## Requirements +### Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.3 | | [equinix](#requirement\_equinix) | >= 1.14.2 | -## Providers +### Providers | Name | Version | |------|---------| -| [equinix](#provider\_equinix) | 1.14.2 | +| [equinix](#provider\_equinix) | >= 1.14.2 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| | [k3s\_cluster](#module\_k3s\_cluster) | ./modules/k3s_cluster | n/a | -## Resources +### Resources | Name | Type | |------|------| | [equinix_metal_reserved_ip_block.global_ip](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_reserved_ip_block) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -337,7 +337,7 @@ sv-k3s-aio Ready control-plane,master 9m20s v1.26.5+k3s1 | [deploy\_demo](#input\_deploy\_demo) | Deploys a simple demo using a global IP as ingress and a hello-kubernetes pods | `bool` | `false` | no | | [global\_ip](#input\_global\_ip) | Enables a global anycast IPv4 that will be shared for all clusters in all metros | `bool` | `false` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/examples/demo_cluster/README.md b/examples/demo_cluster/README.md index 28096fd..0856906 100644 --- a/examples/demo_cluster/README.md +++ b/examples/demo_cluster/README.md @@ -11,28 +11,28 @@ terraform apply -## Requirements +### Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.3 | | [equinix](#requirement\_equinix) | >= 1.14.2 | -## Providers +### Providers No providers. -## Modules +### Modules | Name | Source | Version | |------|--------|---------| | [demo](#module\_demo) | ../.. | n/a | -## Resources +### Resources No resources. -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -42,9 +42,9 @@ No resources. | [deploy\_demo](#input\_deploy\_demo) | Deploys a simple demo using a global IP as ingress and a hello-kubernetes pods | `bool` | `true` | no | | [global\_ip](#input\_global\_ip) | Enables a global anycast IPv4 that will be shared for all clusters in all metros | `bool` | `true` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| -| [demo\_cluster](#output\_demo\_cluster) | n/a | +| [demo\_cluster](#output\_demo\_cluster) | Passthrough of the root module output | diff --git a/modules/k3s_cluster/README.md b/modules/k3s_cluster/README.md index 37c37c7..dbce797 100644 --- a/modules/k3s_cluster/README.md +++ b/modules/k3s_cluster/README.md @@ -2,7 +2,7 @@ -## Requirements +### Requirements | Name | Version | |------|---------| @@ -10,18 +10,18 @@ | [equinix](#requirement\_equinix) | >= 1.14.2 | | [random](#requirement\_random) | >= 3.5.1 | -## Providers +### Providers | Name | Version | |------|---------| | [equinix](#provider\_equinix) | >= 1.14.2 | | [random](#provider\_random) | >= 3.5.1 | -## Modules +### Modules No modules. -## Resources +### Resources | Name | Type | |------|------| @@ -37,7 +37,7 @@ No modules. | [equinix_metal_reserved_ip_block.ip_pool](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_reserved_ip_block) | resource | | [random_string.random_k3s_token](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -58,7 +58,7 @@ No modules. | [plan\_control\_plane](#input\_plan\_control\_plane) | K3s control plane type/size | `string` | `"c3.small.x86"` | no | | [plan\_node](#input\_plan\_node) | K3s node type/size | `string` | `"c3.small.x86"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------|