|
1 |
| -# terraform-equinix-template |
| 1 | +# terraform-equinix-labs |
2 | 2 |
|
3 | 3 | <!-- TEMPLATE: Review all "TEMPLATE" comments and remove them when applied. -->
|
4 | 4 | <!-- TEMPLATE: replace "template" with the name of your project. The prefix "terraform-equinix-" informs the Terraform registry that this project is a Terraform module associated with the Equinix provider, preserve this prefix. -->
|
5 | 5 | [](https://github.com/equinix-labs/standards#about-uniform-standards)
|
6 |
| -[](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/pre-commit.yaml) |
7 |
| -[](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/documentation.yaml) |
8 |
| - |
9 |
| -`terraform-equinix-template` is a minimal Terraform module that utilizes [Terraform providers for Equinix](https://registry.terraform.io/namespaces/equinix) to provision digital infrastructure and demonstrate higher level integrations. |
10 |
| - |
11 |
| -<!-- TEMPLATE: Insert an image here of the infrastructure diagram. You can generate a starting image using instructions found at https://www.terraform.io/docs/cli/commands/graph.html#generating-images --> |
| 6 | +[](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/pre-commit.yaml) |
| 7 | +[](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/documentation.yaml) |
12 | 8 |
|
13 | 9 | ## Usage
|
14 | 10 |
|
@@ -61,46 +57,8 @@ The main README.md, the modules README.md and the examples README.md are populat
|
61 | 57 |
|
62 | 58 | To view examples for how you can leverage this module, please see the [examples](examples/) directory.
|
63 | 59 |
|
64 |
| -<!-- TEMPLATE: The following block has been generated by terraform-docs util: https://github.com/terraform-docs/terraform-docs --> |
65 | 60 | <!-- BEGIN_TF_DOCS -->
|
66 |
| -## Requirements |
67 |
| - |
68 |
| -| Name | Version | |
69 |
| -|------|---------| |
70 |
| -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 | |
71 |
| -| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.8.0 | |
72 |
| - |
73 |
| -## Providers |
74 |
| - |
75 |
| -| Name | Version | |
76 |
| -|------|---------| |
77 |
| -| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.8.1 | |
78 |
| - |
79 |
| -## Modules |
80 |
| - |
81 |
| -| Name | Source | Version | |
82 |
| -|------|--------|---------| |
83 |
| -| <a name="module_inline-module"></a> [inline-module](#module\_inline-module) | ./modules/inline-module | n/a | |
84 |
| - |
85 |
| -## Resources |
86 |
| - |
87 |
| -| Name | Type | |
88 |
| -|------|------| |
89 |
| -| [equinix_metal_device.example](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_device) | resource | |
90 |
| - |
91 |
| -## Inputs |
92 |
| - |
93 |
| -| Name | Description | Type | Default | Required | |
94 |
| -|------|-------------|------|---------|:--------:| |
95 |
| -| <a name="input_example_auth_token"></a> [example\_auth\_token](#input\_example\_auth\_token) | The example auth token value defines what will be included in the example resource in main.tf. This example is descriptive. | `string` | n/a | yes | |
96 |
| -| <a name="input_example_project_id"></a> [example\_project\_id](#input\_example\_project\_id) | The example project id value defines what will be included in the example resource in main.tf. This example is descriptive. | `string` | n/a | yes | |
97 |
| - |
98 |
| -## Outputs |
99 | 61 |
|
100 |
| -| Name | Description | |
101 |
| -|------|-------------| |
102 |
| -| <a name="output_example_device_hostname"></a> [example\_device\_hostname](#output\_example\_device\_hostname) | The example output. In practice, output value reference implicit resource attributes declared in main.tf | |
103 |
| -| <a name="output_example_gateway_id"></a> [example\_gateway\_id](#output\_example\_gateway\_id) | The example output. In practice, output value reference implicit resource attributes declared in main.tf | |
104 | 62 | <!-- END_TF_DOCS -->
|
105 | 63 | ## Contributing
|
106 | 64 |
|
|
0 commit comments