Skip to content

Commit 7cd2f9f

Browse files
displaguedisplague
authored
generate-terraform-docs: automated action
Signed-off-by: GitHub <[email protected]>
1 parent 5ebb5c5 commit 7cd2f9f

File tree

6 files changed

+167
-11
lines changed

6 files changed

+167
-11
lines changed

‎README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,32 @@ The main README.md, the modules README.md and the examples README.md are populat
5858
To view examples for how you can leverage this module, please see the [examples](examples/) directory.
5959

6060
<!-- BEGIN_TF_DOCS -->
61+
## Requirements
6162

63+
| Name | Version |
64+
|------|---------|
65+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
66+
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.8.0 |
67+
68+
## Providers
69+
70+
No providers.
71+
72+
## Modules
73+
74+
No modules.
75+
76+
## Resources
77+
78+
No resources.
79+
80+
## Inputs
81+
82+
No inputs.
83+
84+
## Outputs
85+
86+
No outputs.
6287
<!-- END_TF_DOCS -->
6388
## Contributing
6489

‎examples/k8s-addons/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,17 @@ No providers.
2323

2424
## Modules
2525

26-
| Name | Source | Version |
27-
|------|--------|---------|
28-
| <a name="module_example"></a> [example](#module\_example) | ../../ | n/a |
26+
No modules.
2927

3028
## Resources
3129

3230
No resources.
3331

3432
## Inputs
3533

36-
| Name | Description | Type | Default | Required |
37-
|------|-------------|------|---------|:--------:|
38-
| <a name="input_example_metal_auth_token"></a> [example\_metal\_auth\_token](#input\_example\_metal\_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 |
39-
| <a name="input_example_metal_project_id"></a> [example\_metal\_project\_id](#input\_example\_metal\_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 |
34+
No inputs.
4035

4136
## Outputs
4237

43-
| Name | Description |
44-
|------|-------------|
45-
| <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 |
46-
| <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 |
38+
No outputs.
4739
<!-- END_TF_DOCS -->

‎modules/collaborator-project/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,43 @@ terraform apply
1010
```
1111

1212
<!-- BEGIN_TF_DOCS -->
13+
## Requirements
1314

15+
| Name | Version |
16+
|------|---------|
17+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
18+
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.10.0 |
19+
20+
## Providers
21+
22+
| Name | Version |
23+
|------|---------|
24+
| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.10.0 |
25+
26+
## Modules
27+
28+
No modules.
29+
30+
## Resources
31+
32+
| Name | Type |
33+
|------|------|
34+
| [equinix_metal_organization_member.user](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_organization_member) | resource |
35+
| [equinix_metal_project.project](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_project) | resource |
36+
| [equinix_metal_project_api_key.project_key](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/metal_project_api_key) | resource |
37+
38+
## Inputs
39+
40+
| Name | Description | Type | Default | Required |
41+
|------|-------------|------|---------|:--------:|
42+
| <a name="input_collaborator"></a> [collaborator](#input\_collaborator) | Collaborator email to join the organization | `string` | n/a | yes |
43+
| <a name="input_organization_id"></a> [organization\_id](#input\_organization\_id) | Equinix Metal organization id | `string` | n/a | yes |
44+
| <a name="input_send_invites"></a> [send\_invites](#input\_send\_invites) | Wether Collaborator invitations should be sent. This could be toggled after a successful provision to prevent sending invitations to a project that could be deleted during a reprovision | `bool` | `true` | no |
45+
46+
## Outputs
47+
48+
| Name | Description |
49+
|------|-------------|
50+
| <a name="output_collaborator_project_api_key"></a> [collaborator\_project\_api\_key](#output\_collaborator\_project\_api\_key) | Collaborator Project API Key |
51+
| <a name="output_collaborator_project_id"></a> [collaborator\_project\_id](#output\_collaborator\_project\_id) | Collaborator Project ID |
1452
<!-- END_TF_DOCS -->

‎modules/invite-from-csv/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,40 @@ terraform apply
1010
```
1111

1212
<!-- BEGIN_TF_DOCS -->
13+
## Requirements
1314

15+
| Name | Version |
16+
|------|---------|
17+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
18+
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.10.0 |
19+
20+
## Providers
21+
22+
| Name | Version |
23+
|------|---------|
24+
| <a name="provider_equinix"></a> [equinix](#provider\_equinix) | >= 1.10.0 |
25+
26+
## Modules
27+
28+
| Name | Source | Version |
29+
|------|--------|---------|
30+
| <a name="module_project_invite_setup"></a> [project\_invite\_setup](#module\_project\_invite\_setup) | ../collaborator-project | n/a |
31+
32+
## Resources
33+
34+
| Name | Type |
35+
|------|------|
36+
| [equinix_metal_organization.org](https://registry.terraform.io/providers/equinix/equinix/latest/docs/data-sources/metal_organization) | data source |
37+
38+
## Inputs
39+
40+
| Name | Description | Type | Default | Required |
41+
|------|-------------|------|---------|:--------:|
42+
| <a name="input_organization_id"></a> [organization\_id](#input\_organization\_id) | Equinix Metal organization id | `string` | n/a | yes |
43+
| <a name="input_csv_file"></a> [csv\_file](#input\_csv\_file) | Path to a CSV file containing a list of projects to provision: email,metro,plan. Email address is used as the project name and the collaborator. Metro and plan are used to provision the project. | `string` | `"users.csv"` | no |
44+
| <a name="input_send_invites"></a> [send\_invites](#input\_send\_invites) | Wether Collaborator invitations should be sent. This could be toggled after a successful provision to prevent sending invitations to a project that could be deleted during a reprovision | `bool` | `true` | no |
45+
46+
## Outputs
47+
48+
No outputs.
1449
<!-- END_TF_DOCS -->

‎modules/workshop/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,37 @@ terraform apply
1010
```
1111

1212
<!-- BEGIN_TF_DOCS -->
13+
## Requirements
1314

15+
| Name | Version |
16+
|------|---------|
17+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
18+
19+
## Providers
20+
21+
No providers.
22+
23+
## Modules
24+
25+
| Name | Source | Version |
26+
|------|--------|---------|
27+
| <a name="module_project_setup"></a> [project\_setup](#module\_project\_setup) | ../invite-from-csv | n/a |
28+
29+
## Resources
30+
31+
No resources.
32+
33+
## Inputs
34+
35+
| Name | Description | Type | Default | Required |
36+
|------|-------------|------|---------|:--------:|
37+
| <a name="input_workshop_organization_id"></a> [workshop\_organization\_id](#input\_workshop\_organization\_id) | Equinix Metal organization id | `string` | n/a | yes |
38+
| <a name="input_workshop_csv_file"></a> [workshop\_csv\_file](#input\_workshop\_csv\_file) | Path to a CSV file containing a list of projects to provision: email,metro,plan. Email address is used as the project name and the collaborator. Metro and plan are used to provision the project. | `string` | `"users.csv"` | no |
39+
| <a name="input_workshop_send_invites"></a> [workshop\_send\_invites](#input\_workshop\_send\_invites) | Wether Collaborator invitations should be sent. This could be toggled after a successful provision to prevent sending invitations to a project that could be deleted during a reprovision | `bool` | `true` | no |
40+
41+
## Outputs
42+
43+
| Name | Description |
44+
|------|-------------|
45+
| <a name="output_workshop_outpus"></a> [workshop\_outpus](#output\_workshop\_outpus) | Outputs of the workshop |
1446
<!-- END_TF_DOCS -->

‎modules/workshop/examples/welcome/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,39 @@ terraform apply
1010
```
1111

1212
<!-- BEGIN_TF_DOCS -->
13+
## Requirements
1314

15+
| Name | Version |
16+
|------|---------|
17+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
18+
| <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 1.10.0 |
19+
20+
## Providers
21+
22+
No providers.
23+
24+
## Modules
25+
26+
| Name | Source | Version |
27+
|------|--------|---------|
28+
| <a name="module_welcome_workshop"></a> [welcome\_workshop](#module\_welcome\_workshop) | ../../ | n/a |
29+
30+
## Resources
31+
32+
No resources.
33+
34+
## Inputs
35+
36+
| Name | Description | Type | Default | Required |
37+
|------|-------------|------|---------|:--------:|
38+
| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | Equinix Metal user api token. | `string` | n/a | yes |
39+
| <a name="input_metal_organization_id"></a> [metal\_organization\_id](#input\_metal\_organization\_id) | Equinix Metal organization id | `string` | n/a | yes |
40+
| <a name="input_workshop_csv_file"></a> [workshop\_csv\_file](#input\_workshop\_csv\_file) | Path to a CSV file containing a list of projects to provision: email,metro,plan. Email address is used as the project name and the collaborator. Metro and plan are used to provision the project. | `string` | `"users.csv"` | no |
41+
| <a name="input_workshop_send_invites"></a> [workshop\_send\_invites](#input\_workshop\_send\_invites) | Wether Collaborator invitations should be sent. This could be toggled after a successful provision to prevent sending invitations to a project that could be deleted during a reprovision | `bool` | `true` | no |
42+
43+
## Outputs
44+
45+
| Name | Description |
46+
|------|-------------|
47+
| <a name="output_workshop_outpus"></a> [workshop\_outpus](#output\_workshop\_outpus) | Outputs of the workshop |
1448
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)