From ec0b19a943804239e64d94e5e94508a0a7e981a2 Mon Sep 17 00:00:00 2001 From: thogarty <139183873+thogarty@users.noreply.github.com> Date: Mon, 4 Dec 2023 20:37:14 -0800 Subject: [PATCH] Update README.mds and variable requirements (#15) * Update README.mds and variable requirements * Require notifications variable * Update README.md files to include developer documentation link --- README.md | 10 ++- .../cloud-router-2-aws-connection/README.md | 69 ++++-------------- .../cloud-router-2-aws-connection/main.tf | 2 +- ...fvars.example => terraform.tfvars.example} | 6 +- .../variables.tf | 15 +--- .../cloud-router-2-azure-connection/README.md | 63 ++++------------ .../variables.tf | 5 +- .../README.md | 71 ++++--------------- .../variables.tf | 6 +- .../cloud-router-2-gcp-connection/README.md | 66 ++++------------- .../variables.tf | 5 +- .../README.md | 67 ++++------------- .../variables.tf | 4 +- .../cloud-router-2-port-connection/README.md | 64 ++++------------- .../variables.tf | 5 +- .../README.md | 64 ++++------------- .../variables.tf | 4 +- .../cloud-router-2-wan-connection/README.md | 62 ++++------------ .../variables.tf | 4 +- examples/port-2-alibaba-connection/README.md | 67 ++++------------- .../port-2-alibaba-connection/variables.tf | 5 +- examples/port-2-aws-connection/README.md | 67 ++++------------- examples/port-2-aws-connection/main.tf | 1 + .../terraform.tfvars.example | 6 +- examples/port-2-aws-connection/variables.tf | 10 ++- examples/port-2-azure-connection/README.md | 66 ++++------------- examples/port-2-azure-connection/variables.tf | 5 +- .../README.md | 70 ++++-------------- .../variables.tf | 5 +- examples/port-2-google-connection/README.md | 67 ++++------------- .../port-2-google-connection/variables.tf | 5 +- examples/port-2-ibm1-connection/README.md | 68 ++++-------------- examples/port-2-ibm1-connection/variables.tf | 5 +- examples/port-2-ibm2-connection/README.md | 68 ++++-------------- examples/port-2-ibm2-connection/variables.tf | 5 +- examples/port-2-oracle-connection/README.md | 67 ++++------------- .../port-2-oracle-connection/variables.tf | 5 +- examples/port-2-port-connection/README.md | 65 ++++------------- examples/port-2-port-connection/variables.tf | 5 +- .../README.md | 65 ++++------------- .../variables.tf | 5 +- .../README.md | 65 ++++------------- .../variables.tf | 5 +- examples/routing-protocols/README.md | 63 ++++------------ modules/cloud-router-connection/README.md | 8 ++- modules/cloud-router-connection/main.tf | 8 +-- modules/cloud-router-connection/variables.tf | 5 +- modules/port-connection/README.md | 8 ++- modules/port-connection/main.tf | 9 +-- modules/port-connection/variables.tf | 13 ++-- 50 files changed, 390 insertions(+), 1118 deletions(-) rename examples/cloud-router-2-aws-connection/{terrafor.tfvars.example => terraform.tfvars.example} (84%) diff --git a/README.md b/README.md index 078d8faf..8a91176d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,13 @@ > This is a empty module that houses multiple submodules for Equinix Fabric Terraform usage. -### Modules +## 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) + +## Modules This repository consists in a collection of modules that will accelerate your adoption of Equinix Terraform for Fabric use cases. Each module is fully independent and it is dedicated to be used as its own module. They are placed here for organization of @@ -19,7 +25,7 @@ Each module has: * Terraform source code to be used as a module * README.md file containing instructions and specific notes to work with the module -### Examples +## Examples Each example is a specific use case in Equinix Fabric that the specific sub-module can be used for. Each example has the following: diff --git a/examples/cloud-router-2-aws-connection/README.md b/examples/cloud-router-2-aws-connection/README.md index 037a4c36..5a36ef1b 100644 --- a/examples/cloud-router-2-aws-connection/README.md +++ b/examples/cloud-router-2-aws-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -45,56 +57,3 @@ module "cloud_router_aws_connection" { zside_fabric_sp_name = var.zside_fabric_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_aws\_connection](#module\_cloud\_router\_aws\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [additional\_info](#input\_additional\_info) | Additional parameters required for some service profiles. It should be a list of maps containing 'key' and 'value e.g. `[{ key='asn' value = '65000'}, { key='ip' value = '192.168.0.1'}]` | `list(object({ key = string, value = string }))` | `[]` | no | -| [aws\_access\_key](#input\_aws\_access\_key) | AWS Access Key from the AWS Console | `string` | `null` | no | -| [aws\_secret\_key](#input\_aws\_secret\_key) | AWS Secret Key from the AWS Console | `string` | `null` | no | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-aws-connection/main.tf b/examples/cloud-router-2-aws-connection/main.tf index ca5bc5fe..52b3c804 100644 --- a/examples/cloud-router-2-aws-connection/main.tf +++ b/examples/cloud-router-2-aws-connection/main.tf @@ -10,7 +10,7 @@ module "cloud_router_aws_connection" { connection_type = var.connection_type notifications_type = var.notifications_type notifications_emails = var.notifications_emails - additional_info = [{ key = "accessKey", value = var.aws_access_key }, { key = "secretKey", value = var.aws_secret_key }] + additional_info = var.additional_info bandwidth = var.bandwidth purchase_order_number = var.purchase_order_number diff --git a/examples/cloud-router-2-aws-connection/terrafor.tfvars.example b/examples/cloud-router-2-aws-connection/terraform.tfvars.example similarity index 84% rename from examples/cloud-router-2-aws-connection/terrafor.tfvars.example rename to examples/cloud-router-2-aws-connection/terraform.tfvars.example index 28ee1a01..e17c8515 100644 --- a/examples/cloud-router-2-aws-connection/terrafor.tfvars.example +++ b/examples/cloud-router-2-aws-connection/terraform.tfvars.example @@ -15,5 +15,7 @@ zside_ap_profile_type = "L2_PROFILE" zside_location = "SV" zside_seller_region = "us-west-1" zside_fabric_sp_name = "AWS Direct Connect" -aws_access_key = "" -aws_secret_key = "" +additional_info = [ + { key = "accessKey", value = "" }, + { key = "secretKey", value = "" } +] diff --git a/examples/cloud-router-2-aws-connection/variables.tf b/examples/cloud-router-2-aws-connection/variables.tf index 6a1322fe..f2f6073b 100644 --- a/examples/cloud-router-2-aws-connection/variables.tf +++ b/examples/cloud-router-2-aws-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" @@ -70,16 +71,6 @@ variable "zside_seller_region" { type = string default = "" } -variable "aws_access_key" { - description = "AWS Access Key from the AWS Console" - type = string - default = null -} -variable "aws_secret_key" { - description = "AWS Secret Key from the AWS Console" - type = string - default = null -} variable "additional_info" { description = "Additional parameters required for some service profiles. It should be a list of maps containing 'key' and 'value e.g. `[{ key='asn' value = '65000'}, { key='ip' value = '192.168.0.1'}]`" diff --git a/examples/cloud-router-2-azure-connection/README.md b/examples/cloud-router-2-azure-connection/README.md index f4bbbff7..dc87aac2 100644 --- a/examples/cloud-router-2-azure-connection/README.md +++ b/examples/cloud-router-2-azure-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -45,53 +56,3 @@ module "cloud_router_azure_connection" { zside_fabric_sp_name = var.zside_fabric_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_azure\_connection](#module\_cloud\_router\_azure\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_peering\_type](#input\_zside\_peering\_type) | Access point peering type - PRIVATE, MICROSOFT, PUBLIC, MANUAL | `string` | `"PRIVATE"` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-azure-connection/variables.tf b/examples/cloud-router-2-azure-connection/variables.tf index c7b51c90..142a6d9a 100644 --- a/examples/cloud-router-2-azure-connection/variables.tf +++ b/examples/cloud-router-2-azure-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/cloud-router-2-azure-redundant-connection/README.md b/examples/cloud-router-2-azure-redundant-connection/README.md index 7c4dc602..871e03c0 100644 --- a/examples/cloud-router-2-azure-redundant-connection/README.md +++ b/examples/cloud-router-2-azure-redundant-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -50,58 +62,3 @@ module "cloud_router_azure_redundant_connection" { aside_sec_fcr_uuid = var.aside_sec_fcr_uuid } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_azure\_redundant\_connection](#module\_cloud\_router\_azure\_redundant\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [aside\_sec\_fcr\_uuid](#input\_aside\_sec\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier for Secondary Connection | `string` | `""` | no | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [secondary\_bandwidth](#input\_secondary\_bandwidth) | Connection bandwidth in Mbps | `number` | `50` | no | -| [secondary\_connection\_name](#input\_secondary\_connection\_name) | Secondary Connection name | `string` | `""` | no | -| [secondary\_redundancy](#input\_secondary\_redundancy) | Redundancy Priority for the Secondary connection | `string` | `"SECONDARY"` | no | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_peering\_type](#input\_zside\_peering\_type) | Access point peering type - PRIVATE, MICROSOFT, PUBLIC, MANUAL | `string` | `"PRIVATE"` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | -| [secondary\_connection\_result](#output\_secondary\_connection\_result) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-azure-redundant-connection/variables.tf b/examples/cloud-router-2-azure-redundant-connection/variables.tf index 29e8ebfb..19c795d3 100644 --- a/examples/cloud-router-2-azure-redundant-connection/variables.tf +++ b/examples/cloud-router-2-azure-redundant-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,7 +31,9 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } + variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" type = string diff --git a/examples/cloud-router-2-gcp-connection/README.md b/examples/cloud-router-2-gcp-connection/README.md index 22fc383d..c4ce18e1 100644 --- a/examples/cloud-router-2-gcp-connection/README.md +++ b/examples/cloud-router-2-gcp-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -44,53 +56,3 @@ module "cloud_router_gcp_connection" { zside_fabric_sp_name = var.zside_fabric_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_gcp\_connection](#module\_cloud\_router\_gcp\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-gcp-connection/variables.tf b/examples/cloud-router-2-gcp-connection/variables.tf index f62c7b71..f21c1f85 100644 --- a/examples/cloud-router-2-gcp-connection/variables.tf +++ b/examples/cloud-router-2-gcp-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/cloud-router-2-oracle-connection/README.md b/examples/cloud-router-2-oracle-connection/README.md index 12647998..a42dcffd 100644 --- a/examples/cloud-router-2-oracle-connection/README.md +++ b/examples/cloud-router-2-oracle-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -45,54 +57,3 @@ module "cloud_router_oracle_connection" { zside_fabric_sp_name = var.zside_fabric_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_oracle\_connection](#module\_cloud\_router\_oracle\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_peering\_type](#input\_zside\_peering\_type) | Access point peering type - PRIVATE, MICROSOFT, PUBLIC, MANUAL | `string` | `"PRIVATE"` | no | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-oracle-connection/variables.tf b/examples/cloud-router-2-oracle-connection/variables.tf index 16f6a502..4e3ca215 100644 --- a/examples/cloud-router-2-oracle-connection/variables.tf +++ b/examples/cloud-router-2-oracle-connection/variables.tf @@ -16,8 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -30,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/cloud-router-2-port-connection/README.md b/examples/cloud-router-2-port-connection/README.md index 79a0098d..8637bfe9 100644 --- a/examples/cloud-router-2-port-connection/README.md +++ b/examples/cloud-router-2-port-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -42,51 +54,3 @@ module "cloud_router_port_connection" { zside_vlan_tag = var.zside_vlan_outer_tag } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_port\_connection](#module\_cloud\_router\_port\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_port\_name](#input\_zside\_port\_name) | Equinix Zside Port Name | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | -| [zside\_vlan\_outer\_tag](#input\_zside\_vlan\_outer\_tag) | Access point protocol Vlan tag number for DOT1Q or QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-port-connection/variables.tf b/examples/cloud-router-2-port-connection/variables.tf index 77976cb6..0bca44ce 100644 --- a/examples/cloud-router-2-port-connection/variables.tf +++ b/examples/cloud-router-2-port-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/cloud-router-2-service-profile-connection/README.md b/examples/cloud-router-2-service-profile-connection/README.md index 8aff43cc..9a9a70d8 100644 --- a/examples/cloud-router-2-service-profile-connection/README.md +++ b/examples/cloud-router-2-service-profile-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -42,51 +54,3 @@ module "cloud_router_sp_connection" { zside_fabric_sp_name = var.zside_fabric_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_sp\_connection](#module\_cloud\_router\_sp\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | `"L2_PROFILE"` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_fabric\_sp\_name](#input\_zside\_fabric\_sp\_name) | Equinix Service Profile Name | `string` | `""` | no | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | `"SP"` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-service-profile-connection/variables.tf b/examples/cloud-router-2-service-profile-connection/variables.tf index 5ca56215..d1414d2a 100644 --- a/examples/cloud-router-2-service-profile-connection/variables.tf +++ b/examples/cloud-router-2-service-profile-connection/variables.tf @@ -16,8 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -30,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/cloud-router-2-wan-connection/README.md b/examples/cloud-router-2-wan-connection/README.md index 5bc9da93..23e53ea9 100644 --- a/examples/cloud-router-2-wan-connection/README.md +++ b/examples/cloud-router-2-wan-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -40,49 +52,3 @@ module "cloud_router_wan_connection" { zside_network_uuid = var.zside_network_uuid } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [cloud\_router\_wan\_connection](#module\_cloud\_router\_wan\_connection) | ../../modules/cloud-router-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_ap\_type](#input\_aside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [aside\_fcr\_uuid](#input\_aside\_fcr\_uuid) | Equinix-assigned Fabric Cloud Router identifier | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [connection\_type](#input\_connection\_type) | Defines the connection type like VG\_VC, EVPL\_VC, EPL\_VC, EC\_VC, IP\_VC, ACCESS\_EPL\_VC | `string` | `""` | no | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | `"SP"` | no | -| [zside\_network\_uuid](#input\_zside\_network\_uuid) | Network UUID | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [module\_output](#output\_module\_output) | n/a | - \ No newline at end of file diff --git a/examples/cloud-router-2-wan-connection/variables.tf b/examples/cloud-router-2-wan-connection/variables.tf index f141ca8d..44219347 100644 --- a/examples/cloud-router-2-wan-connection/variables.tf +++ b/examples/cloud-router-2-wan-connection/variables.tf @@ -16,8 +16,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -30,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/examples/port-2-alibaba-connection/README.md b/examples/port-2-alibaba-connection/README.md index ff2f0fde..ca5a9ddc 100644 --- a/examples/port-2-alibaba-connection/README.md +++ b/examples/port-2-alibaba-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -44,54 +56,3 @@ module "create_port_2_alibaba_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_alibaba\_connection](#module\_create\_port\_2\_alibaba\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [alibaba\_connection\_id](#output\_alibaba\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-alibaba-connection/variables.tf b/examples/port-2-alibaba-connection/variables.tf index 2ea84172..c1eac384 100644 --- a/examples/port-2-alibaba-connection/variables.tf +++ b/examples/port-2-alibaba-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-aws-connection/README.md b/examples/port-2-aws-connection/README.md index ba80c1ce..8219355c 100644 --- a/examples/port-2-aws-connection/README.md +++ b/examples/port-2-aws-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -45,54 +57,3 @@ module "create_port_2_aws_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_aws\_connection](#module\_create\_port\_2\_aws\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [aws\_connection\_id](#output\_aws\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-aws-connection/main.tf b/examples/port-2-aws-connection/main.tf index c78cd4b3..4d0e73e1 100644 --- a/examples/port-2-aws-connection/main.tf +++ b/examples/port-2-aws-connection/main.tf @@ -12,6 +12,7 @@ module "create_port_2_aws_connection" { notifications_emails = var.notifications_emails bandwidth = var.bandwidth purchase_order_number = var.purchase_order_number + additional_info = var.additional_info # A-side aside_port_name = var.aside_port_name diff --git a/examples/port-2-aws-connection/terraform.tfvars.example b/examples/port-2-aws-connection/terraform.tfvars.example index 00ba323d..3c70215a 100644 --- a/examples/port-2-aws-connection/terraform.tfvars.example +++ b/examples/port-2-aws-connection/terraform.tfvars.example @@ -11,8 +11,12 @@ aside_port_name = "sit-001-200009-CX-TY4-NL-Qinq-STD-10G-PRI-JP-252" aside_vlan_tag = "2019" aside_vlan_inner_tag = "2112" zside_ap_type = "SP" -zside_ap_authentication_key = "357848976964" +zside_ap_authentication_key = "" zside_ap_profile_type = "L2_PROFILE" zside_location = "SV" zside_seller_region = "us-west-1" zside_sp_name = "AWS Direct Connect" +additional_info = [ + { key = "accessKey", value = "" }, + { key = "secretKey", value = "" } +] diff --git a/examples/port-2-aws-connection/variables.tf b/examples/port-2-aws-connection/variables.tf index 2ea84172..d2d5fb6f 100644 --- a/examples/port-2-aws-connection/variables.tf +++ b/examples/port-2-aws-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { @@ -71,3 +72,8 @@ variable "zside_seller_region" { description = "Access point seller region" type = string } +variable "additional_info" { + description = "Additional info parameters. It's a list of maps containing 'key' and 'value' keys with their corresponding values." + type = list(object({ key = string, value = string })) + default = [] +} diff --git a/examples/port-2-azure-connection/README.md b/examples/port-2-azure-connection/README.md index 1d9a61d1..b9a58f75 100644 --- a/examples/port-2-azure-connection/README.md +++ b/examples/port-2-azure-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -44,53 +56,3 @@ module "create_port_2_azure_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_azure\_connection](#module\_create\_port\_2\_azure\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [azure\_connection\_id](#output\_azure\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-azure-connection/variables.tf b/examples/port-2-azure-connection/variables.tf index 87280b2d..9d9643bb 100644 --- a/examples/port-2-azure-connection/variables.tf +++ b/examples/port-2-azure-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-azure-redundant-connections/README.md b/examples/port-2-azure-redundant-connections/README.md index e32113bc..6577367d 100644 --- a/examples/port-2-azure-redundant-connections/README.md +++ b/examples/port-2-azure-redundant-connections/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -52,57 +64,3 @@ module "create_port_2_azure_connections" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_azure\_connections](#module\_create\_port\_2\_azure\_connections) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_secondary\_port\_name](#input\_aside\_secondary\_port\_name) | Secondary Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [secondary\_bandwidth](#input\_secondary\_bandwidth) | Secondary Connection bandwidth in Mbps | `number` | n/a | yes | -| [secondary\_connection\_name](#input\_secondary\_connection\_name) | Secondary Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [azure\_primary\_connection\_id](#output\_azure\_primary\_connection\_id) | n/a | -| [azure\_secondary\_connection\_id](#output\_azure\_secondary\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-azure-redundant-connections/variables.tf b/examples/port-2-azure-redundant-connections/variables.tf index 4d48e317..602b266b 100644 --- a/examples/port-2-azure-redundant-connections/variables.tf +++ b/examples/port-2-azure-redundant-connections/variables.tf @@ -21,9 +21,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -41,6 +41,7 @@ variable "secondary_bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-google-connection/README.md b/examples/port-2-google-connection/README.md index 5d4cdb9f..b34684b8 100644 --- a/examples/port-2-google-connection/README.md +++ b/examples/port-2-google-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -45,54 +57,3 @@ module "create_port_2_google_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_google\_connection](#module\_create\_port\_2\_google\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [google\_connection\_id](#output\_google\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-google-connection/variables.tf b/examples/port-2-google-connection/variables.tf index 2ea84172..c1eac384 100644 --- a/examples/port-2-google-connection/variables.tf +++ b/examples/port-2-google-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-ibm1-connection/README.md b/examples/port-2-ibm1-connection/README.md index a3f2e06d..626000a3 100644 --- a/examples/port-2-ibm1-connection/README.md +++ b/examples/port-2-ibm1-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -46,55 +58,3 @@ module "create_port_2_ibm1_connection" { primary_additional_info = var.additional_info } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_ibm1\_connection](#module\_create\_port\_2\_ibm1\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [additional\_info](#input\_additional\_info) | Additional info parameters. It's a list of maps containing 'key' and 'value' keys with their corresponding values. | `list(object({ key = string, value = string }))` | `[]` | no | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [ibm1\_connection\_id](#output\_ibm1\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-ibm1-connection/variables.tf b/examples/port-2-ibm1-connection/variables.tf index 46c80916..d2d5fb6f 100644 --- a/examples/port-2-ibm1-connection/variables.tf +++ b/examples/port-2-ibm1-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-ibm2-connection/README.md b/examples/port-2-ibm2-connection/README.md index 8de673c1..b68b538c 100644 --- a/examples/port-2-ibm2-connection/README.md +++ b/examples/port-2-ibm2-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -46,55 +58,3 @@ module "create_port_2_ibm2_connection" { primary_additional_info = var.additional_info } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_ibm2\_connection](#module\_create\_port\_2\_ibm2\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [additional\_info](#input\_additional\_info) | Additional info parameters. It's a list of maps containing 'key' and 'value' keys with their corresponding values. | `list(object({ key = string, value = string }))` | `[]` | no | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [ibm2\_connection\_id](#output\_ibm2\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-ibm2-connection/variables.tf b/examples/port-2-ibm2-connection/variables.tf index 46c80916..d2d5fb6f 100644 --- a/examples/port-2-ibm2-connection/variables.tf +++ b/examples/port-2-ibm2-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-oracle-connection/README.md b/examples/port-2-oracle-connection/README.md index 77ed270d..116e0bc6 100644 --- a/examples/port-2-oracle-connection/README.md +++ b/examples/port-2-oracle-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -44,54 +56,3 @@ module "create_port_2_oracle_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_oracle\_connection](#module\_create\_port\_2\_oracle\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_authentication\_key](#input\_zside\_ap\_authentication\_key) | Authentication key for provider based connections | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_seller\_region](#input\_zside\_seller\_region) | Access point seller region | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [oracle\_connection\_id](#output\_oracle\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-oracle-connection/variables.tf b/examples/port-2-oracle-connection/variables.tf index 2ea84172..c1eac384 100644 --- a/examples/port-2-oracle-connection/variables.tf +++ b/examples/port-2-oracle-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-port-connection/README.md b/examples/port-2-port-connection/README.md index 6ce9dda1..8578b650 100644 --- a/examples/port-2-port-connection/README.md +++ b/examples/port-2-port-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -42,52 +54,3 @@ module "create_port_2_port_connection" { zside_location = var.zside_location } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_port\_connection](#module\_create\_port\_2\_port\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_port\_name](#input\_zside\_port\_name) | Equinix Port Name | `string` | n/a | yes | -| [zside\_vlan\_tag](#input\_zside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [port\_connection\_id](#output\_port\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-port-connection/variables.tf b/examples/port-2-port-connection/variables.tf index defe1e86..c65b659c 100644 --- a/examples/port-2-port-connection/variables.tf +++ b/examples/port-2-port-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-private-service-profile-connection/README.md b/examples/port-2-private-service-profile-connection/README.md index c42c6ef0..98ea6d85 100644 --- a/examples/port-2-private-service-profile-connection/README.md +++ b/examples/port-2-private-service-profile-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -42,52 +54,3 @@ module "create_port_2_private_sp_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_private\_sp\_connection](#module\_create\_port\_2\_private\_sp\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [private\_sp\_connection\_id](#output\_private\_sp\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-private-service-profile-connection/variables.tf b/examples/port-2-private-service-profile-connection/variables.tf index 46ab9070..463c789c 100644 --- a/examples/port-2-private-service-profile-connection/variables.tf +++ b/examples/port-2-private-service-profile-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/port-2-public-service-profile-connection/README.md b/examples/port-2-public-service-profile-connection/README.md index 77365963..745a4144 100644 --- a/examples/port-2-public-service-profile-connection/README.md +++ b/examples/port-2-public-service-profile-connection/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -42,52 +54,3 @@ module "create_port_2_public_sp_connection" { zside_sp_name = var.zside_sp_name } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [create\_port\_2\_public\_sp\_connection](#module\_create\_port\_2\_public\_sp\_connection) | ../../modules/port-connection | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aside\_port\_name](#input\_aside\_port\_name) | Equinix A-Side Port Name | `string` | n/a | yes | -| [aside\_vlan\_tag](#input\_aside\_vlan\_tag) | Vlan Tag information, outer vlanSTag for QINQ connections | `string` | n/a | yes | -| [bandwidth](#input\_bandwidth) | Connection bandwidth in Mbps | `number` | n/a | yes | -| [connection\_name](#input\_connection\_name) | Connection name. An alpha-numeric 24 characters string which can include only hyphens and underscores | `string` | n/a | yes | -| [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 | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [notifications\_emails](#input\_notifications\_emails) | Array of contact emails | `list(string)` | n/a | yes | -| [notifications\_type](#input\_notifications\_type) | Notification Type - ALL,CONNECTION\_APPROVAL,SALES\_REP\_NOTIFICATIONS, NOTIFICATIONS | `string` | n/a | yes | -| [purchase\_order\_number](#input\_purchase\_order\_number) | Purchase order number | `string` | n/a | yes | -| [zside\_ap\_profile\_type](#input\_zside\_ap\_profile\_type) | Service profile type - L2\_PROFILE, L3\_PROFILE, ECIA\_PROFILE, ECMC\_PROFILE | `string` | n/a | yes | -| [zside\_ap\_type](#input\_zside\_ap\_type) | Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW | `string` | n/a | yes | -| [zside\_location](#input\_zside\_location) | Access point metro code | `string` | n/a | yes | -| [zside\_sp\_name](#input\_zside\_sp\_name) | Equinix Service Profile Name | `string` | n/a | yes | -| [aside\_vlan\_inner\_tag](#input\_aside\_vlan\_inner\_tag) | Vlan Inner Tag information, inner vlanCTag for QINQ connections | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [public\_sp\_connection\_id](#output\_public\_sp\_connection\_id) | n/a | - \ No newline at end of file diff --git a/examples/port-2-public-service-profile-connection/variables.tf b/examples/port-2-public-service-profile-connection/variables.tf index 46ab9070..463c789c 100644 --- a/examples/port-2-public-service-profile-connection/variables.tf +++ b/examples/port-2-public-service-profile-connection/variables.tf @@ -16,9 +16,9 @@ variable "connection_type" { type = string } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -31,6 +31,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { diff --git a/examples/routing-protocols/README.md b/examples/routing-protocols/README.md index 9feb80e6..df92df33 100644 --- a/examples/routing-protocols/README.md +++ b/examples/routing-protocols/README.md @@ -1,4 +1,15 @@ -## Usage +## 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. @@ -12,7 +23,8 @@ terraform init terraform apply ``` -To use this example of the module in your own terraform configuration outside of the repo include the following: +To use this example of the module in your own terraform configuration include the following +(You must also have variables/values defined and have the contents of versions.tf somewhere in your config): ```hcl @@ -40,50 +52,3 @@ module "routing_protocols" { bgp_enabled_ipv6 = var.bgp_enabled_ipv6 } ``` - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1.5.4 | -| [equinix](#requirement\_equinix) | >= 1.20.0 | - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [routing\_protocols](#module\_routing\_protocols) | ../../modules/routing-protocols | n/a | - -## Resources - -No resources. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [connection\_uuid](#input\_connection\_uuid) | Equinix Connection UUID to Apply the Routing Protocols to | `string` | n/a | yes | -| [direct\_equinix\_ipv4\_ip](#input\_direct\_equinix\_ipv4\_ip) | IPv4 Address for Direct Routing Protocol | `string` | n/a | yes | -| [direct\_equinix\_ipv6\_ip](#input\_direct\_equinix\_ipv6\_ip) | IPv6 Address for Direct Routing Protocol | `string` | n/a | yes | -| [direct\_rp\_name](#input\_direct\_rp\_name) | Name of the Direct Routing Protocol | `string` | n/a | yes | -| [equinix\_client\_id](#input\_equinix\_client\_id) | Equinix client ID (consumer key), obtained after registering app in the developer platform | `string` | n/a | yes | -| [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 | -| [bgp\_customer\_asn](#input\_bgp\_customer\_asn) | Customer ASN for BGP Routing Protocol | `string` | `""` | no | -| [bgp\_customer\_peer\_ipv4](#input\_bgp\_customer\_peer\_ipv4) | Customer Peering IPv4 Address for BGP Routing Protocol | `string` | `""` | no | -| [bgp\_customer\_peer\_ipv6](#input\_bgp\_customer\_peer\_ipv6) | Customer Peering IPv6 Address for BGP Routing Protocol | `string` | `""` | no | -| [bgp\_enabled\_ipv4](#input\_bgp\_enabled\_ipv4) | Boolean Enable Flag for IPv4 Peering on BGP Routing Protocol | `bool` | `true` | no | -| [bgp\_enabled\_ipv6](#input\_bgp\_enabled\_ipv6) | Boolean Enable Flag for IPv6 Peering on BGP Routing Protocol | `bool` | `true` | no | -| [bgp\_rp\_name](#input\_bgp\_rp\_name) | Name of the BGP Routing Protocol | `string` | `""` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| [bgp\_rp\_id](#output\_bgp\_rp\_id) | n/a | -| [direct\_rp\_id](#output\_direct\_rp\_id) | n/a | - \ No newline at end of file diff --git a/modules/cloud-router-connection/README.md b/modules/cloud-router-connection/README.md index 71348253..409e64d7 100644 --- a/modules/cloud-router-connection/README.md +++ b/modules/cloud-router-connection/README.md @@ -1,3 +1,9 @@ +## 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) + ## Requirements @@ -59,4 +65,4 @@ No modules. |------|-------------| | [primary\_connection\_id](#output\_primary\_connection\_id) | n/a | | [secondary\_connection\_id](#output\_secondary\_connection\_id) | n/a | - \ No newline at end of file + diff --git a/modules/cloud-router-connection/main.tf b/modules/cloud-router-connection/main.tf index 2382e904..27cec075 100644 --- a/modules/cloud-router-connection/main.tf +++ b/modules/cloud-router-connection/main.tf @@ -18,14 +18,14 @@ resource "equinix_fabric_connection" "primary_cloud_router_connection" { name = var.connection_name type = var.connection_type notifications { - type = var.notifications_type + type = var.notifications_emails emails = var.notifications_emails } additional_info = var.additional_info != [] ? var.additional_info : null bandwidth = var.bandwidth redundancy { priority = "PRIMARY" } order { - purchase_order_number = var.purchase_order_number + purchase_order_number = var.purchase_order_number != "" ? var.purchase_order_number : null } a_side { access_point { @@ -94,7 +94,7 @@ resource "equinix_fabric_connection" "secondary_cloud_router_connection" { name = var.secondary_connection_name type = var.connection_type notifications { - type = var.notifications_type + type = var.notifications_emails emails = var.notifications_emails } additional_info = var.additional_info != [] ? var.additional_info : null @@ -104,7 +104,7 @@ resource "equinix_fabric_connection" "secondary_cloud_router_connection" { group = one(equinix_fabric_connection.primary_cloud_router_connection.redundancy).group } order { - purchase_order_number = var.purchase_order_number + purchase_order_number = var.purchase_order_number != "" ? var.purchase_order_number : null } a_side { access_point { diff --git a/modules/cloud-router-connection/variables.tf b/modules/cloud-router-connection/variables.tf index dad413d5..e5be4f7d 100644 --- a/modules/cloud-router-connection/variables.tf +++ b/modules/cloud-router-connection/variables.tf @@ -8,9 +8,9 @@ variable "connection_type" { default = "" } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + description = "Notification Type - ALL is the only type currently supported" type = string - + default = "ALL" } variable "notifications_emails" { description = "Array of contact emails" @@ -23,6 +23,7 @@ variable "bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_ap_type" { description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW" diff --git a/modules/port-connection/README.md b/modules/port-connection/README.md index 2ae171cd..4901070a 100644 --- a/modules/port-connection/README.md +++ b/modules/port-connection/README.md @@ -1,3 +1,9 @@ +## 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) + ## Requirements @@ -62,4 +68,4 @@ No modules. |------|-------------| | [primary\_connection\_id](#output\_primary\_connection\_id) | n/a | | [secondary\_connection\_id](#output\_secondary\_connection\_id) | n/a | - \ No newline at end of file + diff --git a/modules/port-connection/main.tf b/modules/port-connection/main.tf index b57a8d6b..7630378a 100644 --- a/modules/port-connection/main.tf +++ b/modules/port-connection/main.tf @@ -34,13 +34,14 @@ resource "equinix_fabric_connection" "primary_port_connection" { type = var.notifications_type emails = var.notifications_emails } + bandwidth = var.bandwidth redundancy { priority = "PRIMARY" } order { - purchase_order_number = var.purchase_order_number + purchase_order_number = var.purchase_order_number != "" ? var.purchase_order_number : null } - additional_info = var.primary_additional_info != [] ? var.primary_additional_info : null + additional_info = var.additional_info != [] ? var.additional_info : null a_side { access_point { @@ -116,10 +117,10 @@ resource "equinix_fabric_connection" "secondary_port_connection" { group = one(equinix_fabric_connection.primary_port_connection.redundancy).group } order { - purchase_order_number = var.purchase_order_number + purchase_order_number = var.purchase_order_number != "" ? var.purchase_order_number : null } - additional_info = var.secondary_additional_info != [] ? var.secondary_additional_info : null + additional_info = var.additional_info != [] ? var.additional_info : null a_side { access_point { diff --git a/modules/port-connection/variables.tf b/modules/port-connection/variables.tf index 101082de..0656457c 100644 --- a/modules/port-connection/variables.tf +++ b/modules/port-connection/variables.tf @@ -15,10 +15,10 @@ variable "connection_type" { } variable "notifications_type" { - description = "Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS" + 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) @@ -38,6 +38,7 @@ variable "secondary_bandwidth" { variable "purchase_order_number" { description = "Purchase order number" type = string + default = "" } variable "aside_port_name" { @@ -114,13 +115,7 @@ variable "zside_peering_type" { default = "" } -variable "primary_additional_info" { - description = "Additional info parameters. It's a list of maps containing 'key' and 'value' keys with their corresponding values." - type = list(object({ key = string, value = string })) - default = [] -} - -variable "secondary_additional_info" { +variable "additional_info" { description = "Additional info parameters. It's a list of maps containing 'key' and 'value' keys with their corresponding values." type = list(object({ key = string, value = string })) default = []