Skip to content

Commit

Permalink
Merge pull request #51 from equinix/create-pull-request/patch-1685988488
Browse files Browse the repository at this point in the history
generate-terraform-docs: automated action
  • Loading branch information
displague authored Jun 5, 2023
2 parents 8d0165c + 5dac85f commit edc91cf
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,32 +303,32 @@ sv-k3s-aio Ready control-plane,master 9m20s v1.26.5+k3s1

<!-- TEMPLATE: The following block has been generated by terraform-docs util: https://github.com/terraform-docs/terraform-docs -->
<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.14.2 |

## Providers
### Providers

| Name | Version |
|------|---------|
| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | 1.14.2 |
| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.14.2 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_k3s_cluster"></a> [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 |
|------|-------------|------|---------|:--------:|
Expand All @@ -337,7 +337,7 @@ sv-k3s-aio Ready control-plane,master 9m20s v1.26.5+k3s1
| <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 |

## Outputs
### Outputs

| Name | Description |
|------|-------------|
Expand Down
14 changes: 7 additions & 7 deletions examples/demo_cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,28 @@ terraform apply

<!-- TEMPLATE: The following block has been generated by terraform-docs util: https://github.com/terraform-docs/terraform-docs -->
<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.14.2 |

## Providers
### Providers

No providers.

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_demo"></a> [demo](#module\_demo) | ../.. | n/a |

## Resources
### Resources

No resources.

## Inputs
### Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
Expand All @@ -42,9 +42,9 @@ No resources.
| <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` | `true` | 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` | `true` | no |

## Outputs
### Outputs

| Name | Description |
|------|-------------|
| <a name="output_demo_cluster"></a> [demo\_cluster](#output\_demo\_cluster) | n/a |
| <a name="output_demo_cluster"></a> [demo\_cluster](#output\_demo\_cluster) | Passthrough of the root module output |
<!-- END_TF_DOCS -->
12 changes: 6 additions & 6 deletions modules/k3s_cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

<!-- TEMPLATE: The following block has been generated by terraform-docs util: https://github.com/terraform-docs/terraform-docs -->
<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.14.2 |
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.5.1 |

## Providers
### Providers

| Name | Version |
|------|---------|
| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.14.2 |
| <a name="provider_random"></a> [random](#provider\_random) | >= 3.5.1 |

## Modules
### Modules

No modules.

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand All @@ -58,7 +58,7 @@ No modules.
| <a name="input_plan_control_plane"></a> [plan\_control\_plane](#input\_plan\_control\_plane) | K3s control plane type/size | `string` | `"c3.small.x86"` | no |
| <a name="input_plan_node"></a> [plan\_node](#input\_plan\_node) | K3s node type/size | `string` | `"c3.small.x86"` | no |

## Outputs
### Outputs

| Name | Description |
|------|-------------|
Expand Down

0 comments on commit edc91cf

Please sign in to comment.