feat: deprecate Metal resources and auth_token for June 2026 sunset

[Copilot]

• Create internal/deprecations package with MetalDeprecationMessage constant
• Update all files in equinix/ directory to use deprecations.MetalDeprecationMessage
  • Update data source files (10 files)
  • Update resource files (6 files)
  • Update provider.go
• Update all files in internal/resources/metal/ to use deprecations.MetalDeprecationMessage
  • Update connection schemas (2 files)
  • Update device files (2 files)
  • Update gateway schemas (1 file)
  • Update organization schemas (2 files)
  • Update organization_member schema (1 file)
  • Update port files (2 files)
  • Update portvlanattachment resource (1 file)
  • Update project schemas (2 files)
  • Update project_ssh_key schema (1 file)
  • Update ssh_key schema (1 file)
  • Update virtualcircuit files (2 files)
  • Update vlan schemas (2 files)
  • Update vrf files (2 files)
• Update internal/provider/provider.go
• Delete old deprecation files
  • equinix/metal_deprecation.go
  • internal/resources/metal/deprecation.go
• Verify all changes compile successfully

Original prompt

Using Terraform SDK/Framework best practices, deprecate all Metal resources and the Metal specific provider settings auth_token (env METAL_AUTH_TOKEN). Referring to Equinix Docs for sunset information. Note that docs changes are made through changes to the .go and .tmpl files (make docs). The resources will be removed in the next major release (5.0.0), so the documentation should note that the current major (4.x) should be used for ongoing use through sunset. The project uses conventional commits (including in the PR title).

• https://docs.equinix.com/metal/
• https://developer.hashicorp.com/terraform/plugin/framework/deprecations
• https://developer.hashicorp.com/terraform/plugin/sdkv2/best-practices/deprecations
• https://www.conventionalcommits.org/en/v1.0.0/

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[displague]

@copilot metal_acc_test can go too (the metal tests, metal testing specific github action, any specific harnesses that were metal focused)

[displague]

Doh - I didn't mean that. We can pop that last commit off the stack. We still want the Metal tests until after deprecation. I'm curious what it comes up with.

update: looks like copilot errored out on that request. Nothing to revisit, our tests are saved.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 43.33%. Comparing base (ff6fa16) to head (47b71c7).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #989       +/-   ##
===========================================
+ Coverage   29.40%   43.33%   +13.93%     
===========================================
  Files         246      246               
  Lines       28414    28450       +36     
===========================================
+ Hits         8355    12329     +3974     
+ Misses      19905    15626     -4279     
- Partials      154      495      +341     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[displague]

Hilariously, this is changing the DeprecationMessage per resource. We don't actually want to do that. The same message should be used everywhere.

[displague]

@copilot You used a different DeprecationMessage everywhere. Use the same message, keep it professional (some were not), and remember the .md files are make docs generated. (maybe make a reusable sub-package for this in the metal section, specifically to keep this consistent).

[Copilot]

Standardized all deprecation messages to use a consistent constant. Created metalDeprecationMessage in equinix/metal_deprecation.go and metal.DeprecationMessage in internal/resources/metal/deprecation.go. All resources, data sources, and documentation templates now use the same professional message. Changes committed in c96da02.

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• checkpoint-api.hashicorp.com
  • Triggering command: /tmp/go-build3658376579/b001/exe/tfplugindocs /tmp/go-build3658376579/b001/exe/tfplugindocs --rendered-provider-name=Equinix (dns block)
  • Triggering command: /usr/local/bin/terraform terraform version x64/pkg/tool/lin-test.paniconexit0 (dns block)
  • Triggering command: /usr/local/bin/terraform /usr/local/bin/terraform version -json -goversion go1.24.12 -c=4 -nolocalimports -importcfg /tmp/go-build3658376579/b200/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/bmatcuk/doublestar/v4@v4.8.1/doublestar.go /home/REDACTED/go/pkg/mod/github.com/bmatcuk/doublestar/v4@v4.8.1/glob.go show�� l/resources/meta/tmp/go-build86857291/b769/_pkg_.a ux_amd64/asm p/bin/bash rice.go om/golangci/gola-o x64/bin/go /opt/hostedtoolc-trimpath (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[displague]

@copilot equinix/metal_deprecation.go -> internal/deprecations/metal.go
also see the golang lint failed CI

[displague]

@copilot move equinix/metal_deprecation.go to internal/deprecations/metal.go
also see the golangci-lint failures in CI

[Copilot]

@copilot equinix/metal_deprecation.go -> internal/deprecations/metal.go
also see the golang lint failed CI

Moved equinix/metal_deprecation.go to internal/deprecations/metal.go with proper package and export comments to fix golangci-lint issues. All 39 references updated to use deprecations.MetalDeprecationMessage. Changes in commit 47b71c7.

@copilot move equinix/metal_deprecation.go to internal/deprecations/metal.go
also see the golangci-lint failures in CI

Completed in commit 47b71c7. File moved to internal/deprecations/metal.go with proper linting compliance (package comment and exported const comment added).

[Copilot]

Pull request overview

This pull request implements comprehensive deprecation of all Equinix Metal resources, data sources, and the auth_token provider setting in preparation for the Metal platform's sunset on June 30, 2026. The implementation follows Terraform best practices by creating a centralized deprecation message and applying it consistently across all Metal-related components.

Changes:

• Created internal/deprecations package with a standardized MetalDeprecationMessage constant
• Deprecated all 19 Metal resources and 22 Metal data sources by adding deprecation messages to their schemas
• Deprecated the auth_token provider setting in both SDKv2 and Framework provider implementations
• Updated all documentation templates and generated docs to include clear deprecation notices

Reviewed changes

Copilot reviewed 117 out of 117 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
internal/deprecations/metal.go	New package defining the standard deprecation message for all Metal components
internal/provider/provider.go	Added deprecation to auth_token in Framework provider
equinix/provider.go	Added deprecation to auth_token in SDKv2 provider
internal/resources/metal//resource.go	Added deprecation messages to all Metal resource schemas (connection, device, gateway, organization, port, project, ssh_key, vlan, virtualcircuit, vrf, etc.)
internal/resources/metal//datasource.go	Added deprecation messages to all Metal data source schemas
equinix/resource_metal_*.go	Added deprecation messages to legacy Metal resources (bgp_session, device_network_type, ip_attachment, project_api_key, reserved_ip_block, user_api_key)
equinix/data_source_metal_*.go	Added deprecation messages to legacy Metal data sources (device_bgp_neighbors, facility, hardware_reservation, ip_block_ranges, metro, operating_system, plans, precreated_ip_block, reserved_ip_block, spot_market_price)
templates/resources/metal_*.md.tmpl	Added deprecation notices to all Metal resource documentation templates
templates/data-sources/metal_*.md.tmpl	Added deprecation notices to all Metal data source documentation templates
docs/resources/metal_*.md	Generated documentation with deprecation notices for all Metal resources
docs/data-sources/metal_*.md	Generated documentation with deprecation notices for all Metal data sources
docs/index.md	Updated to show auth_token as deprecated in provider configuration

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.