-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
generate-terraform-docs: automated action (#161)
Signed-off-by: GitHub <[email protected]> Co-authored-by: srushti-patl <[email protected]>
- Loading branch information
1 parent
fc92c10
commit 9ffc08d
Showing
5 changed files
with
1,035 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,5 +48,370 @@ See example usage below for details on how to use this example. | |
| * This action will automatically delete the connection on the Equinix side, updating its status to Deprovisioned on both Equinix and Provider side | ||
|
|
||
| <!-- BEGIN_TF_DOCS --> | ||
| ## Equinix Fabric Developer Documentation | ||
|
|
||
| To see the documentation for the APIs that the Fabric Terraform Provider is built on | ||
| and to learn how to procure your own Client_Id and Client_Secret follow the link below: | ||
| [Equinix Fabric Developer Portal](https://developer.equinix.com/docs?page=/dev-docs/fabric/overview) | ||
|
|
||
| ## Usage of Example as Terraform Module | ||
|
|
||
| To provision this example directly as a usable module please use the *Provision Instructions* provided by Hashicorp | ||
| in the upper right of this page and be sure to include at a minimum the required variables. | ||
|
|
||
| ## Usage of Example Locally or in Your Own Configuration | ||
|
|
||
| *Note:* This example creates resources which cost money. Run 'terraform destroy' when you don't need these resources. | ||
|
|
||
| To provision this example directly, | ||
| you should clone the github repository for this module and run terraform within this directory: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/equinix/terraform-equinix-fabric.git | ||
| cd terraform-equinix-fabric/examples/port-2-alibaba-connection-with-alicloud-terraform-integration | ||
| terraform init | ||
| terraform apply | ||
| ``` | ||
|
|
||
| To use this example of the module in your own terraform configuration include the following: | ||
|
|
||
| *NOTE: terraform.tfvars must be a separate file, but all other content can be placed together in main.tf if you prefer* | ||
|
|
||
| terraform.tfvars (Replace these values with your own): | ||
| ```hcl | ||
| equinix_client_id = "MyEquinixClientId" | ||
| equinix_client_secret = "MyEquinixSecret" | ||
| connection_name = "Port_2_alibaba" | ||
| connection_type = "EVPL_VC" | ||
| notifications_type = "ALL" | ||
| notifications_emails = ["[email protected]"] | ||
| bandwidth = 50 | ||
| purchase_order_number = "1-323292" | ||
| aside_port_name = "sit-tb1-dc-e5.tlab,10GSMF,A,001,201257, 21951980" | ||
| aside_vlan_tag = 2019 | ||
| zside_ap_type = "SP" | ||
| zside_ap_authentication_key = "<Alibaba Auth Key>" | ||
| zside_ap_profile_type = "L2_PROFILE" | ||
| zside_location = "SY" | ||
| zside_sp_name = "Alibaba Cloud Express Connect" | ||
| zside_seller_region = "ap-southeast-2" | ||
| zside_ap_profile_type = "L2_PROFILE" | ||
| zside_ap_type = "SP" | ||
| zside_location = "SV" | ||
| zside_seller_region = "us-west-1" | ||
| zside_sp_name = "Alibaba Cloud Express Connect" | ||
| region = "us-west-1" | ||
| local_gateway_ip = "10.0.0.1" | ||
| peer_gateway_ip = "10.0.0.2" | ||
| peering_subnet_mask = "255.255.255.252" | ||
| virtual_border_router_name = "Port_2_Alibaba_VBR" | ||
| min_rx_interval = 1000 | ||
| min_tx_interval = 1000 | ||
| detect_multiplier = 10 | ||
| access_key = "<Alibaba_Cloud_Access_Key>" | ||
| secret_key = "<Alibaba_Cloud_Secret_Key>" | ||
| project_id = "<Fabric_Project_ID>" | ||
| ``` | ||
|
|
||
| versions.tf | ||
| ```hcl | ||
| terraform { | ||
| required_version = ">= 1.5.4" | ||
| required_providers { | ||
| equinix = { | ||
| source = "equinix/equinix" | ||
| version = ">= 2.9.0" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| variables.tf | ||
| ```hcl | ||
| variable "equinix_client_id" { | ||
| description = "Equinix client ID (consumer key), obtained after registering app in the developer platform" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
| variable "equinix_client_secret" { | ||
| description = "Equinix client secret ID (consumer secret), obtained after registering app in the developer platform" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
| variable "connection_name" { | ||
| description = "Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores" | ||
| type = string | ||
| } | ||
| variable "project_id" { | ||
| description = "Subscriber-assigned project ID" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "connection_type" { | ||
| description = "Defines the connection type like VG_VC, EVPL_VC, EPL_VC, EC_VC, IP_VC, ACCESS_EPL_VC" | ||
| type = string | ||
| } | ||
| variable "notifications_type" { | ||
| description = "Notification Type - ALL is the only type currently supported" | ||
| type = string | ||
| default = "ALL" | ||
| } | ||
| variable "notifications_emails" { | ||
| description = "Array of contact emails" | ||
| type = list(string) | ||
| } | ||
| variable "bandwidth" { | ||
| description = "Connection bandwidth in Mbps" | ||
| type = number | ||
| } | ||
| variable "purchase_order_number" { | ||
| description = "Purchase order number" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "aside_port_name" { | ||
| description = "Equinix A-Side Port Name" | ||
| type = string | ||
| } | ||
| variable "aside_vlan_tag" { | ||
| description = "Vlan Tag information, outer vlanSTag for QINQ connections" | ||
| type = string | ||
| } | ||
| variable "aside_vlan_inner_tag" { | ||
| description = "Vlan Inner Tag information, inner vlanCTag for QINQ connections" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "zside_ap_type" { | ||
| description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" | ||
| type = string | ||
| } | ||
| variable "zside_ap_authentication_key" { | ||
| description = "Authentication key for provider based connections" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
| variable "zside_ap_profile_type" { | ||
| description = "Service profile type - L2_PROFILE, L3_PROFILE, ECIA_PROFILE, ECMC_PROFILE" | ||
| type = string | ||
| } | ||
| variable "zside_location" { | ||
| description = "Access point metro code" | ||
| type = string | ||
| } | ||
| variable "zside_sp_name" { | ||
| description = "Equinix Service Profile Name" | ||
| type = string | ||
| } | ||
| variable "zside_seller_region" { | ||
| description = "Access point seller region" | ||
| type = string | ||
| } | ||
| variable "region" { | ||
| description = "Region" | ||
| type = string | ||
| } | ||
| variable "access_point_id" { | ||
| description = "Access Point ID" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "local_gateway_ip" { | ||
| description = "Local Gateway IP" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "peer_gateway_ip" { | ||
| description = "Peer Gateway IP" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "peering_subnet_mask" { | ||
| description = "Peering Subnet Mask" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "min_rx_interval" { | ||
| description = "Minimum RX Interval" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "min_tx_interval" { | ||
| description = "Minimum TX Interval" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "detect_multiplier" { | ||
| description = "Detect Multiplier" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "virtual_border_router_name" { | ||
| description = "Virtual Border Router Name" | ||
| type = string | ||
| default = "" | ||
| } | ||
| variable "access_key" { | ||
| description = "Access Key" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
| variable "secret_key" { | ||
| description = "Secret Key" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
| ``` | ||
|
|
||
| outputs.tf | ||
| ```hcl | ||
| output "alibaba_connection" { | ||
| value = module.create_port_2_alibaba_connection.primary_connection | ||
| sensitive = true | ||
| } | ||
| output "alibaba_connection_id" { | ||
| value = module.create_port_2_alibaba_connection.primary_connection_id | ||
| } | ||
| # output "alicloud_express_connect_virtual_border_router" { | ||
| # value = alicloud_express_connect_virtual_border_router.vbr | ||
| # sensitive = true | ||
| # } | ||
| # | ||
| # output "alicloud_express_connect_virtual_border_router_id" { | ||
| # value = alicloud_express_connect_virtual_border_router.vbr.id | ||
| # } | ||
| # | ||
| # output "express_connect_virtual_border_router_id" { | ||
| # value = data.alicloud_express_connect_virtual_border_routers.nameRegexVbr.routers.0.id | ||
| # } | ||
| ``` | ||
|
|
||
| main.tf | ||
| ```hcl | ||
| provider "equinix" { | ||
| client_id = var.equinix_client_id | ||
| client_secret = var.equinix_client_secret | ||
| } | ||
| module "create_port_2_alibaba_connection" { | ||
| source = "equinix/fabric/equinix//modules/port-connection" | ||
| connection_name = var.connection_name | ||
| connection_type = var.connection_type | ||
| notifications_type = var.notifications_type | ||
| notifications_emails = var.notifications_emails | ||
| bandwidth = var.bandwidth | ||
| purchase_order_number = var.purchase_order_number | ||
| project_id = var.project_id | ||
| # A-side | ||
| aside_port_name = var.aside_port_name | ||
| aside_vlan_tag = var.aside_vlan_tag | ||
| # Z-side | ||
| zside_ap_type = var.zside_ap_type | ||
| zside_ap_authentication_key = var.zside_ap_authentication_key | ||
| zside_ap_profile_type = var.zside_ap_profile_type | ||
| zside_location = var.zside_location | ||
| zside_seller_region = var.zside_seller_region | ||
| zside_sp_name = var.zside_sp_name | ||
| } | ||
| # provider "alicloud" { | ||
| # access_key = var.access_key | ||
| # secret_key = var.secret_key | ||
| # region = var.region | ||
| # } | ||
| # | ||
| # data "alicloud_express_connect_physical_connections" "nameRegex" { | ||
| # name_regex = "^${module.create_port_2_alibaba_connection.primary_connection.name}" | ||
| # } | ||
| # | ||
| # resource "alicloud_express_connect_virtual_border_router" "vbr" { | ||
| # local_gateway_ip = var.local_gateway_ip | ||
| # peer_gateway_ip = var.peer_gateway_ip | ||
| # peering_subnet_mask = var.peering_subnet_mask | ||
| # physical_connection_id = data.alicloud_express_connect_physical_connections.nameRegex.connections[0].id | ||
| # virtual_border_router_name = var.virtual_border_router_name | ||
| # vlan_id = one(one(one(module.create_port_2_alibaba_connection.primary_connection.z_side).access_point).link_protocol).vlan_tag | ||
| # min_rx_interval = var.min_rx_interval | ||
| # min_tx_interval = var.min_tx_interval | ||
| # detect_multiplier = var.detect_multiplier | ||
| # } | ||
| # | ||
| # resource "null_resource" "destroy_warning" { | ||
| # triggers = { | ||
| # warning = "WARNING: Destroy process is not complete yet. You need to delete the resource from Alibaba Portal!" | ||
| # } | ||
| # } | ||
| # | ||
| # data "alicloud_express_connect_virtual_border_routers" "nameRegexVbr" { | ||
| # name_regex = "^${alicloud_express_connect_virtual_border_router.vbr.virtual_border_router_name}" | ||
| # } | ||
| ``` | ||
|
|
||
| ## Requirements | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.4 | | ||
| | <a name="requirement_equinix"></a> [equinix](#requirement\_equinix) | >= 2.9.0 | | ||
|
|
||
| ## Providers | ||
|
|
||
| No providers. | ||
|
|
||
| ## Modules | ||
|
|
||
| | Name | Source | Version | | ||
| |------|--------|---------| | ||
| | <a name="module_create_port_2_alibaba_connection"></a> [create\_port\_2\_alibaba\_connection](#module\_create\_port\_2\_alibaba\_connection) | equinix/fabric/equinix//modules/port-connection | n/a | | ||
|
|
||
| ## Resources | ||
|
|
||
| No resources. | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | <a name="input_access_key"></a> [access\_key](#input\_access\_key) | Access Key | `string` | n/a | yes | | ||
| | <a name="input_access_point_id"></a> [access\_point\_id](#input\_access\_point\_id) | Access Point ID | `string` | `""` | no | | ||
| | <a name="input_aside_port_name"></a> [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | | ||
| | <a name="input_aside_vlan_inner_tag"></a> [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | | ||
| | <a name="input_aside_vlan_tag"></a> [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | | ||
| | <a name="input_bandwidth"></a> [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | | ||
| | <a name="input_connection_name"></a> [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | | ||
| | <a name="input_connection_type"></a> [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | n/a | yes | | ||
| | <a name="input_detect_multiplier"></a> [detect\_multiplier](#input\_detect\_multiplier) | Detect Multiplier | `string` | `""` | no | | ||
| | <a name="input_equinix_client_id"></a> [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | | ||
| | <a name="input_equinix_client_secret"></a> [equinix\_client\_secret](#input\_equinix\_client\_secret) | Equinix client secret ID (consumer secret), obtained after registering app in the developer platform | `string` | n/a | yes | | ||
| | <a name="input_local_gateway_ip"></a> [local\_gateway\_ip](#input\_local\_gateway\_ip) | Local Gateway IP | `string` | `""` | no | | ||
| | <a name="input_min_rx_interval"></a> [min\_rx\_interval](#input\_min\_rx\_interval) | Minimum RX Interval | `string` | `""` | no | | ||
| | <a name="input_min_tx_interval"></a> [min\_tx\_interval](#input\_min\_tx\_interval) | Minimum TX Interval | `string` | `""` | no | | ||
| | <a name="input_notifications_emails"></a> [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | | ||
| | <a name="input_notifications_type"></a> [notifications\_type](#input\_notifications\_type) | Notification Type - ALL is the only type currently supported | `string` | `"ALL"` | no | | ||
| | <a name="input_peer_gateway_ip"></a> [peer\_gateway\_ip](#input\_peer\_gateway\_ip) | Peer Gateway IP | `string` | `""` | no | | ||
| | <a name="input_peering_subnet_mask"></a> [peering\_subnet\_mask](#input\_peering\_subnet\_mask) | Peering Subnet Mask | `string` | `""` | no | | ||
| | <a name="input_project_id"></a> [project\_id](#input\_project\_id) | Subscriber-assigned project ID | `string` | `""` | no | | ||
| | <a name="input_purchase_order_number"></a> [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | `""` | no | | ||
| | <a name="input_region"></a> [region](#input\_region) | Region | `string` | n/a | yes | | ||
| | <a name="input_secret_key"></a> [secret\_key](#input\_secret\_key) | Secret Key | `string` | n/a | yes | | ||
| | <a name="input_virtual_border_router_name"></a> [virtual\_border\_router\_name](#input\_virtual\_border\_router\_name) | Virtual Border Router Name | `string` | `""` | no | | ||
| | <a name="input_zside_ap_authentication_key"></a> [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | | ||
| | <a name="input_zside_ap_profile_type"></a> [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | | ||
| | <a name="input_zside_ap_type"></a> [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | | ||
| | <a name="input_zside_location"></a> [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | | ||
| | <a name="input_zside_seller_region"></a> [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | | ||
| | <a name="input_zside_sp_name"></a> [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | <a name="output_alibaba_connection"></a> [alibaba\_connection](#output\_alibaba\_connection) | n/a | | ||
| | <a name="output_alibaba_connection_id"></a> [alibaba\_connection\_id](#output\_alibaba\_connection\_id) | n/a | | ||
| <!-- END_TF_DOCS --> | ||
Oops, something went wrong.