[Feature]: Migrate resources to terraform plugin framework

[ocobles]

We are in the process of migrating all Terraform resources previously defined using the SDKv2 to the Terraform Framework. The utilization of the terraform-plugin-mux Go module has been successfully implemented to facilitate the gradual migration of resources. We have also adopted internal/ layout structure so the resources that are migrated to the framework must now be in their own compartment within internal/{services}/{resource}

Migrate to terraform plugin framework
adopt internal/ layout structure #106

Checklist for Unmigrated Resources

Fabric Resources

• equinix_ecx_l2_connection
• equinix_ecx_l2_connection_accepter
• equinix_ecx_l2_serviceprofile
• equinix_fabric_cloud_router
• equinix_fabric_connection
• equinix_fabric_network
• equinix_fabric_routing_protocol
• equinix_fabric_service_profile

Metal Resources

• equinix_metal_bgp_session
• equinix_metal_connection
• equinix_metal_device
• equinix_metal_device_network_type
• equinix_metal_gateway
• equinix_metal_ip_attachment
• equinix_metal_organization
  WIP refactor: migrate resource metal_organization to framework #568
• equinix_metal_organization_member
  WIP refactor: migrate resource metal_organization_member to framework #588
• equinix_metal_port
• equinix_metal_port_vlan_attachment
• equinix_metal_project
  WIP refactor: migrate resource and datasource equinix_metal_project to framework  #604
• equinix_metal_project_api_key
• equinix_metal_project_ssh_key
• equinix_metal_reserved_ip_block
• equinix_metal_spot_market_request
• equinix_metal_ssh_key
• equinix_metal_user_api_key
• equinix_metal_virtual_circuit
• equinix_metal_vlan
• equinix_metal_vrf

Network Edge Resources

• equinix_network_acl_template
• equinix_network_bgp
• equinix_network_device
• equinix_network_device_link
• equinix_network_file
• equinix_network_ssh_key
• equinix_network_ssh_user

Checklist for Unmigrated Datasources

Fabric Datasources

• equinix_ecx_l2_sellerprofile
• equinix_ecx_l2_sellerprofiles
• equinix_ecx_port
• equinix_fabric_cloud_router
• equinix_fabric_connection
• equinix_fabric_network
• equinix_fabric_port
• equinix_fabric_ports
• equinix_fabric_routing_protocol
• equinix_fabric_service_profile
• equinix_fabric_service_profiles

Metal Datasources

• equinix_metal_connection
• equinix_metal_device
• equinix_metal_device_bgp_neighbors
• equinix_metal_devices
• equinix_metal_facility
• equinix_metal_gateway
• equinix_metal_hardware_reservation
• equinix_metal_ip_block_ranges
• equinix_metal_metro
• equinix_metal_operating_system
• equinix_metal_organization
  WIP refactor: migrate resource metal_organization to framework #568
• equinix_metal_plans
• equinix_metal_port
• equinix_metal_precreated_ip_block
• equinix_metal_project
  WIP refactor: migrate resource and datasource equinix_metal_project to framework  #604
• equinix_metal_project_ssh_key
• equinix_metal_reserved_ip_block
• equinix_metal_spot_market_price
• equinix_metal_spot_market_request
• equinix_metal_virtual_circuit
• equinix_metal_vlan
• equinix_metal_vrf

Network Edge Datasources

• equinix_network_account
• equinix_network_device
• equinix_network_device_platform
• equinix_network_device_software
• equinix_network_device_type

Migration Guide

Code in https://github.com/equinix/terraform-provider-equinix/blob/framework_migr_resources/internal/metal_organization/resource.go should be used as a base to migrate this resource.

Checkout the sdkv2 version https://github.com/equinix/terraform-provider-equinix/blob/main/equinix/resource_metal_organization.go

Checkout official documentation https://developer.hashicorp.com/terraform/plugin/framework/migrating/attributes-blocks/blocks for mapping between SDK Schema Fields and the Framewor. Here's also the link to recommended steps https://developer.hashicorp.com/terraform/plugin/framework/migrating#migration-steps

1. Code structure:

   • Separate the code into the following files:
     • models.go
     • resource.go
     • resource_schema.go
     • resource_test.go

2. Schema Review:

   • Review the resource schema and compare it with the SDKv2 code to ensure no validation or planmodifier has been forgotten.

3. Update Imports:

   • Review and update imports as necessary. Some imports might have been renamed or moved.

4. Rename Functions and Variables:

   • Rename functions and variables to follow the same standards as in the already migrated resources (e.g., OrganizationResourceModel to ResourceModel or organizationResourceSchema to resourceSchema).

5. Migrate End-to-End Tests (e2e):

   • Update end-to-end tests (e2e) to use ProtoV5ProviderFactories: acceptance.ProtoV5ProviderFactories instead of Providers: testAccProviders.
   • Add an additional test to verify the migration is correct. You can use the test added in ssh_key as a reference, TestAccMetalSSHKey_upgradeFromVersion.

6. Verification and Testing:

   • Verify that the new code functions as expected and that all tests pass.

7. Migrate Equivalent Data Source (if applicable):

   • If there exists an equivalent data source for the resource being migrated, it should also be migrated in the same Pull Request (PR).
   • Follow the same steps as above for migrating the data source, using the following files:
     • datasource.go
     • datasource_test.go
     • datasource_schema.go
   • Ensure that the data source is updated to match the changes made in the resource migration.

[ctreatma]

Noting here that ECX resources are probably not worth migrating, since the ECX API will be shut down this year, after which time the resources can be deleted entirely.