feat(bootstrap): Add ability to load external NODE_FLAVOR
[csit.git] / fdio.infra.terraform / terraform-openstack-2n / README.md
1 # terraform-openstack-2n-generic
2 Terraform module to create 2n-generic topology.
3
4 <!-- BEGIN_TF_DOCS -->
5 ## Requirements
6
7 | Name | Version |
8 |------|---------|
9 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.2 |
10 | <a name="requirement_openstack"></a> [openstack](#requirement\_openstack) | ~> 1.53.0 |
11
12 ## Providers
13
14 | Name | Version |
15 |------|---------|
16 | <a name="provider_local"></a> [local](#provider\_local) | 2.4.1 |
17 | <a name="provider_openstack"></a> [openstack](#provider\_openstack) | 1.53.0 |
18 | <a name="provider_template"></a> [template](#provider\_template) | 2.2.0 |
19
20 ## Modules
21
22 | Name | Source | Version |
23 |------|--------|---------|
24 | <a name="module_openstack_compute_keypair_v2"></a> [openstack\_compute\_keypair\_v2](#module\_openstack\_compute\_keypair\_v2) | pmikus/compute-keypair-v2/openstack | 1.54.1 |
25 | <a name="module_openstack_images_image_v2"></a> [openstack\_images\_image\_v2](#module\_openstack\_images\_image\_v2) | pmikus/images-image-v2/openstack | 1.54.1 |
26 | <a name="module_sut1"></a> [sut1](#module\_sut1) | pmikus/compute-instance-v2/openstack | 1.54.1 |
27 | <a name="module_tg1"></a> [tg1](#module\_tg1) | pmikus/compute-instance-v2/openstack | 1.54.1 |
28
29 ## Resources
30
31 | Name | Type |
32 |------|------|
33 | [local_file.hosts](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
34 | [local_file.topology_file](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
35 | [openstack_networking_port_v2.port_sut1_data1](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
36 | [openstack_networking_port_v2.port_sut1_data2](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
37 | [openstack_networking_port_v2.port_sut1_mgmt](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
38 | [openstack_networking_port_v2.port_tg1_data1](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
39 | [openstack_networking_port_v2.port_tg1_data2](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
40 | [openstack_networking_port_v2.port_tg1_mgmt](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs/resources/networking_port_v2) | resource |
41 | [template_cloudinit_config.cloudinit_config_sut1](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/cloudinit_config) | data source |
42 | [template_cloudinit_config.cloudinit_config_tg1](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/cloudinit_config) | data source |
43
44 ## Inputs
45
46 | Name | Description | Type | Default | Required |
47 |------|-------------|------|---------|:--------:|
48 | <a name="input_flavour_name"></a> [flavour\_name](#input\_flavour\_name) | (Optional; Required if flavor\_id is empty) The name of the desired flavor for the server. Changing this resizes the existing server. | `string` | n/a | yes |
49 | <a name="input_network_id_data"></a> [network\_id\_data](#input\_network\_id\_data) | (Required) The ID of the network to attach the port to. Changing this creates a new port. | `string` | n/a | yes |
50 | <a name="input_network_id_mgmt"></a> [network\_id\_mgmt](#input\_network\_id\_mgmt) | (Required) The ID of the network to attach the port to. Changing this creates a new port. | `string` | n/a | yes |
51
52 ## Outputs
53
54 | Name | Description |
55 |------|-------------|
56 | <a name="output_sut_id"></a> [sut\_id](#output\_sut\_id) | SUT VM ID. |
57 | <a name="output_tg_id"></a> [tg\_id](#output\_tg\_id) | TG VM ID. |
58 <!-- END_TF_DOCS -->