Skip to content

Commit 9094587

Browse files
authored
docs: Update references to docs.equinix.com (#956)
This updates references from the old deploy.equinix.com docs to the new location and fixes links to VRFs that were incorrect.
2 parents effd554 + d4dbf71 commit 9094587

28 files changed

+226
-214
lines changed

docs/data-sources/metal_device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ output "ipv4" {
6464
- `plan` (String) The hardware config of the device
6565
- `ports` (List of Object) Ports assigned to the device (see [below for nested schema](#nestedatt--ports))
6666
- `root_password` (String, Sensitive) Root password to the server (if still available)
67-
- `sos_hostname` (String) The hostname to use for [Serial over SSH](https://deploy.equinix.com/developers/docs/metal/resilience-recovery/serial-over-ssh/) access to the device
67+
- `sos_hostname` (String) The hostname to use for [Serial over SSH](https://docs.equinix.com/metal/resilience-recovery/serial-over-ssh/) access to the device
6868
- `ssh_key_ids` (List of String) List of IDs of SSH keys deployed in the device, can be both user or project SSH keys
6969
- `state` (String) The state of the device
7070
- `storage` (String)

docs/data-sources/metal_gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "Metal"
66

77
Use this datasource to retrieve Metal Gateway resources in Equinix Metal.
88

9-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
9+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1010

1111
## Example Usage
1212

docs/data-sources/metal_reserved_ip_block.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Use this data source to find IP address blocks in Equinix Metal. You can use IP
88

99
~> For backward compatibility, this data source can be also used for precreated (management) IP blocks.
1010

11-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
11+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1212

1313
## Example Usage
1414

docs/data-sources/metal_virtual_circuit.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ subcategory: "Metal"
44

55
# equinix_metal_virtual_circuit (Data Source)
66

7-
Use this data source to retrieve a virtual circuit resource from [Equinix Fabric - software-defined interconnections](https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/)
7+
Use this data source to retrieve a virtual circuit resource from [Equinix Fabric - software-defined interconnections](https://docs.equinix.com/metal/interconnections/introduction/)
88

9-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
9+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1010

1111
## Example Usage
1212

@@ -44,8 +44,8 @@ data "equinix_metal_virtual_circuit" "example_vc" {
4444
- `md5` (String, Sensitive) The password that can be set for the VRF BGP peer
4545
- `metal_ip` (String) The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
4646
- `name` (String) Name of the virtual circuit
47-
- `nni_vlan` (Number) Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
48-
- `nni_vnid` (Number) Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
47+
- `nni_vlan` (Number) Nni VLAN parameter, see https://docs.equinix.com/metal/interconnections/introduction/
48+
- `nni_vnid` (Number) Nni VLAN ID parameter, see https://docs.equinix.com/metal/interconnections/introduction/
4949
- `peer_asn` (Number) The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
5050
- `port_id` (String) UUID of the Connection Port where the VC is scoped to
5151
- `project_id` (String) ID of the projct to which the virtual circuit belongs
@@ -56,5 +56,5 @@ data "equinix_metal_virtual_circuit" "example_vc" {
5656
* For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
5757
- `tags` (List of String) Tags attached to the virtual circuit
5858
- `vlan_id` (String) UUID of the associated VLAN
59-
- `vnid` (Number) VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
59+
- `vnid` (Number) VNID VLAN parameter, see https://docs.equinix.com/metal/interconnections/introduction/
6060
- `vrf_id` (String) UUID of the associated VRF

docs/data-sources/metal_vrf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "Metal"
66

77
Use this data source to retrieve a VRF resource.
88

9-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
9+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1010

1111
## Example Usage
1212

docs/guides/migration_guide_facilities_to_metros_devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page_title: "Migrating devices from facilities to metros"
44

55
# Metros vs. Facilities
66

7-
In April 2021, [Equinix Metal](https://metal.equinix.com/) rolled out a new location concept - [metros](https://feedback.equinixmetal.com/changelog/new-metros-feature-live). A metro is an Equinix-wide concept for data centers which are grouped together geographically. Data centers within a metro share capacity and networking features. You can read more about metros at https://metal.equinix.com/developers/docs/locations/metros/. In April 2023, [facility deployment was deprecated](https://feedback.equinixmetal.com/changelog/bye-facilities-hello-again-metros) with metro provisioning offered as an all-around superior deployment strategy. See the [facilities guide in the Metal API docs](https://deploy.equinix.com/developers/docs/metal/locations/facilities/) for more details about the API change.
7+
In April 2021, [Equinix Metal](https://metal.equinix.com/) rolled out a new location concept - [metros](https://feedback.equinixmetal.com/changelog/new-metros-feature-live). A metro is an Equinix-wide concept for data centers which are grouped together geographically. Data centers within a metro share capacity and networking features. You can read more about metros at https://metal.equinix.com/developers/docs/locations/metros/. In April 2023, [facility deployment was deprecated](https://feedback.equinixmetal.com/changelog/bye-facilities-hello-again-metros) with metro provisioning offered as an all-around superior deployment strategy. See the [facilities guide in the Metal API docs](https://docs.equinix.com/metal/locations/facilities/) for more details about the API change.
88

99
Before the introduction of metros, resources were deployed to a single `facility` location. When provisioning `equinix_metal_device` resources, the facility could be chosen by Equinix Metal with a user-supplied list of `facilities`, or a wildcard `any` facility. The individual facility locations use a code like "sv15" or "ny5". Metros group facilities. For example, metro "sv" contains the "sv15" facility, among others. If you specify a metro when creating a resource, it will be deployed to one of the facilities in the metro group. You can then find the deployed facility using a read-only attribute of the resource (e.g. `deployed_facility` for `equinix_metal_device` resources).
1010

docs/guides/network_types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ page_title: "Metal Device Network Types"
77

88
Server network types, such as Layer-2, Layer-3, and Hybrid may be familiar to users of the Equinix Metal Portal. In the Portal, you can toggle the network type with a click of the UI. To take advantage of these features in Terraform, which closely follows the Equinix Metal API, it is important to understand that the network type is a composite string value determined by one or more port bonding, addressing, and VLAN attachment configurations. To change the network type, you must change these underlying properties of the port(s).
99

10-
For more details, see the Equinix Metal documentation on [Network Configuration Types](https://metal.equinix.com/developers/docs/layer2-networking/overview/#network-configuration-types).
10+
For more details, see the Equinix Metal documentation on [Network Configuration Types](https://docs.equinix.com/metal/layer2-networking/overview#network-configuration-types).
1111

1212
This Terraform provider offers two ways to define the network type.
1313

@@ -38,7 +38,7 @@ resource "equinix_metal_port" "eth1" {
3838

3939
### Layer 2 Unbonded Port
4040

41-
This example configures an Equinix Metal server with a [pure layer 2 unbonded](https://deploy.equinix.com/developers/docs/metal/layer2-networking/layer2-mode/#:~:text=Layer%202%20Unbonded%20Mode) network configuration and adds two VLANs to its `eth1` port; one of them set as the [native VLAN](https://deploy.equinix.com/developers/docs/metal/layer2-networking/native-vlan/). Notice the `depends_on` meta-argument in the `equinix_metal_port.eth1` resource and the `reset_on_delete` attribute in both ports’ configuration. The `reset_on_delete` will set the port to the default settings (layer3 bonded without VLANs attached) before the terraform resource delete/destroy. It is recommended to use the `depends_on` argument here to ensure that the port resources with attached VLANs are reset first, since all VLANs must be detached before re-bonding the ports.
41+
This example configures an Equinix Metal server with a [pure layer 2 unbonded](https://docs.equinix.com/metal/layer2-networking/layer2-mode/#:~:text=Layer%202%20Unbonded%20Mode) network configuration and adds two VLANs to its `eth1` port; one of them set as the [native VLAN](https://docs.equinix.com/metal/layer2-networking/native-vlan/). Notice the `depends_on` meta-argument in the `equinix_metal_port.eth1` resource and the `reset_on_delete` attribute in both ports’ configuration. The `reset_on_delete` will set the port to the default settings (layer3 bonded without VLANs attached) before the terraform resource delete/destroy. It is recommended to use the `depends_on` argument here to ensure that the port resources with attached VLANs are reset first, since all VLANs must be detached before re-bonding the ports.
4242

4343
```hcl
4444
resource "equinix_metal_port" "bond0" {

docs/resources/metal_device.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ resource "equinix_metal_device" "pxe1" {
155155
### Required
156156

157157
- `operating_system` (String) The operating system slug. To find the slug, or visit [Operating Systems API docs](https://metal.equinix.com/developers/api/operatingsystems), set your API auth token in the top of the page and see JSON from the API response. By default, changing this attribute will cause your device to be deleted and recreated. If `reinstall` is enabled, the device will be updated in-place instead of recreated.
158-
- `plan` (String) The device plan slug. To find the plan slug, visit the [bare-metal server](https://deploy.equinix.com/product/bare-metal/servers/) and [plan documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/)
158+
- `plan` (String) The device plan slug. To find the plan slug, visit the [plan documentation](https://docs.equinix.com/metal/hardware/standard-servers/)
159159
- `project_id` (String) The ID of the project in which to create the device
160160

161161
### Optional
@@ -196,7 +196,7 @@ resource "equinix_metal_device" "pxe1" {
196196
- `network_type` (String, Deprecated) Network type of a device, used in [Layer 2 networking](https://metal.equinix.com/developers/docs/networking/layer2/). Will be one of layer3, hybrid, hybrid-bonded, layer2-individual, layer2-bonded
197197
- `ports` (List of Object) Ports assigned to the device (see [below for nested schema](#nestedatt--ports))
198198
- `root_password` (String, Sensitive) Root password to the server (disabled after 24 hours)
199-
- `sos_hostname` (String) The hostname to use for [Serial over SSH](https://deploy.equinix.com/developers/docs/metal/resilience-recovery/serial-over-ssh/) access to the device
199+
- `sos_hostname` (String) The hostname to use for [Serial over SSH](https://docs.equinix.com/metal/resilience-recovery/serial-over-ssh/) access to the device
200200
- `ssh_key_ids` (List of String) List of IDs of SSH keys deployed in the device, can be both user and project SSH keys
201201
- `state` (String) The status of the device
202202
- `updated` (String) The timestamp for the last time the device was updated

docs/resources/metal_gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "Metal"
66

77
Use this resource to create Metal Gateway resources in Equinix Metal.
88

9-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
9+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1010

1111
## Example Usage
1212

docs/resources/metal_reserved_ip_block.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Addresses from global blocks can be assigned in any metro. Global blocks can hav
1414

1515
Once IP block is allocated or imported, an address from it can be assigned to device with the `equinix_metal_ip_attachment` resource.
1616

17-
See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
17+
See the [Virtual Routing and Forwarding documentation](https://docs.equinix.com/metal/networking/vrf/) for product details and API reference material.
1818

1919
## Example Usage
2020

0 commit comments

Comments
 (0)