Skip to content

Commit

Permalink
fix: update internal docs links with new resource/datasource URLs (#718)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctreatma committed Jul 2, 2024
1 parent d87be0e commit f5723b6
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/metal_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In addition to all arguments above, the following attributes are exported:
* `organization_id` - ID of the organization where the connection is scoped to.
* `status` - Status of the connection resource.
* `service_tokens` - List of connection service tokens with attributes
* `id` - UUID of the service token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard).
* `id` - UUID of the service token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard).
* `expires_at` - Expiration date of the service token.
* `max_allowed_speed` - Maximum allowed speed for the service token, string like in the `speed` attribute.
* `type` - Token type, `a_side` or `z_side`.
Expand All @@ -55,4 +55,4 @@ In addition to all arguments above, the following attributes are exported:
* `status` - Port status.
* `link_status` - Port link status.
* `virtual_circuit_ids` - List of IDs of virtual cicruits attached to this port.
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
6 changes: 3 additions & 3 deletions docs/data-sources/metal_devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ subcategory: "Metal"

The datasource can be used to find a list of devices which meet filter criteria.

If you need to fetch a single device by ID or by project ID and hostname, use the [equinix_metal_device](equinix_metal_device.md) datasource.
If you need to fetch a single device by ID or by project ID and hostname, use the [equinix_metal_device](metal_device.md) datasource.

## Example Usage

Expand Down Expand Up @@ -54,7 +54,7 @@ The following arguments are supported:
* `project_id` - (Optional) ID of project containing the devices. Exactly one of `project_id` and `organization_id` must be set.
* `organization_id` - (Optional) ID of organization containing the devices.
* `search` - (Optional) - Search string to filter devices by hostname, description, short_id, reservation short_id, tags, plan name, plan slug, facility code, facility name, operating system name, operating system slug, IP addresses.
* `filter` - (Optional) One or more attribute/values pairs to filter. List of atributes to filter can be found in the [attribute reference](equinix_metal_device.md#attributes-reference) of the `equinix_metal_device` datasource.
* `filter` - (Optional) One or more attribute/values pairs to filter. List of atributes to filter can be found in the [attribute reference](metal_device.md#attributes-reference) of the `equinix_metal_device` datasource.
- `attribute` - (Required) The attribute used to filter. Filter attributes are case-sensitive
- `values` - (Required) The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR by default, and the request returns all results that match any of the specified values
- `match_by` - (Optional) The type of comparison to apply. One of: `in` , `re`, `substring`, `less_than`, `less_than_or_equal`, `greater_than`, `greater_than_or_equal`. Default is `in`.
Expand All @@ -66,4 +66,4 @@ All fields in the `devices` block defined below can be used as attribute for bot

In addition to all arguments above, the following attributes are exported:

* `devices` - list of resources with attributes like in the [equninix_metal_device datasources](equinix_metal_device.md).
* `devices` - list of resources with attributes like in the [equninix_metal_device datasources](metal_device.md).
2 changes: 1 addition & 1 deletion docs/data-sources/metal_precreated_ip_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use this data source to get CIDR expression for precreated (management) IPv6 and

-> Precreated (management) IP blocks for a metro will not be available until first device is created in that metro.

-> Public IPv4 blocks auto-assigned (management) to a device cannot be retrieved. If you need that information, consider using the [equinix_metal_device](equinix_metal_device.md) data source instead.
-> Public IPv4 blocks auto-assigned (management) to a device cannot be retrieved. If you need that information, consider using the [equinix_metal_device](metal_device.md) data source instead.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/metal_reserved_ip_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ The following arguments are supported:

## Attributes Reference

This datasource exposes the same attributes as the [equinix_metal_reserved_ip_block](../resources/equinix_metal_reserved_ip_block.md) resource, with the following differences:
This datasource exposes the same attributes as the [equinix_metal_reserved_ip_block](../resources/metal_reserved_ip_block.md) resource, with the following differences:

* `type` - One of `global_ipv4`, `public_ipv4`, `private_ipv4`, `public_ipv6`,or `vrf`
2 changes: 1 addition & 1 deletion docs/guides/equinix_fabric_cloud_providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for further details and other options you can check on [References](#references)
## Getting started - Enabling an interconnection

Whether you are setting up a Multi-Cloud or Hybrid Cloud architecture, the main resource you will
need to define is an [equinix_fabric_connection](../resources/equinix_fabric_connection.md) which
need to define is an [equinix_fabric_connection](../resources/fabric_connection.md) which
will let Equinix enable an interconnection on your behalf to the specified cloud provider.
However, there are other required resources that must be configured on both Equinix and your cloud
provider to have the interconnection up and running. Below we describe these general steps using
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/metal_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,6 @@ In addition to all arguments above, the following attributes are exported:

* `organization_id` - ID of the organization where the connection is scoped to.
* `status` - Status of the connection resource.
* `ports` - List of connection ports - primary (`ports[0]`) and secondary (`ports[1]`). Schema of port is described in documentation of the [equinix_metal_connection datasource](../data-sources/equinix_metal_connection.md).
* `service_tokens` - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). Scehma of service_token is described in documentation of the [equinix_metal_connection datasource](../data-sources/equinix_metal_connection.md).
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
* `ports` - List of connection ports - primary (`ports[0]`) and secondary (`ports[1]`). Schema of port is described in documentation of the [equinix_metal_connection datasource](../data-sources/metal_connection.md).
* `service_tokens` - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). Scehma of service_token is described in documentation of the [equinix_metal_connection datasource](../data-sources/metal_connection.md).
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
2 changes: 1 addition & 1 deletion docs/resources/metal_spot_market_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following arguments are supported:
* `facilities` - (**Deprecated**) Facility IDs where devices should be created. Use metro instead; read the [facility to metro migration guide](https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices)
* `metro` - (Optional) Metro where devices should be created.
* `locked` - (Optional) Blocks deletion of the SpotMarketRequest device until the lock is disabled.
* `instance_parameters` - (Required) Key/Value pairs of parameters for devices provisioned from this request. Valid keys are: `billing_cycle`, `plan`, `operating_system`, `hostname`, `termination_time`, `always_pxe`, `description`, `features`, `locked`, `project_ssh_keys`, `user_ssh_keys`, `userdata`, `customdata`, `ipxe_script_url`, `tags`. You can find each parameter description in [equinix_metal_device](equinix_metal_device.md) docs.
* `instance_parameters` - (Required) Key/Value pairs of parameters for devices provisioned from this request. Valid keys are: `billing_cycle`, `plan`, `operating_system`, `hostname`, `termination_time`, `always_pxe`, `description`, `features`, `locked`, `project_ssh_keys`, `user_ssh_keys`, `userdata`, `customdata`, `ipxe_script_url`, `tags`. You can find each parameter description in [equinix_metal_device](metal_device.md) docs.

## Attributes Reference

Expand Down
4 changes: 2 additions & 2 deletions internal/resources/metal/connection/datasource_schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func dataSourceSchema(ctx context.Context) schema.Schema {
Computed: true,
},
"token": schema.StringAttribute{
Description: "Only used with shared connection. Fabric Token required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/equinix_fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Description: "Only used with shared connection. Fabric Token required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Computed: true,
DeprecationMessage: "If your organization already has connection service tokens enabled, use `service_tokens` instead",
},
Expand All @@ -103,7 +103,7 @@ func dataSourceSchema(ctx context.Context) schema.Schema {
Computed: true,
},
"service_tokens": schema.ListAttribute{
Description: "Only used with shared connection. List of service tokens required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/equinix_fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Description: "Only used with shared connection. List of service tokens required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
CustomType: fwtypes.NewListNestedObjectTypeOf[ServiceTokenModel](ctx),
ElementType: fwtypes.NewObjectTypeOf[ServiceTokenModel](ctx),
Computed: true,
Expand Down
4 changes: 2 additions & 2 deletions internal/resources/metal/connection/resource_schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ func resourceSchema(ctx context.Context) schema.Schema {
Computed: true,
},
"token": schema.StringAttribute{
Description: "Only used with shared connection. Fabric Token required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/equinix_fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Description: "Only used with shared connection. Fabric Token required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
Expand All @@ -187,7 +187,7 @@ func resourceSchema(ctx context.Context) schema.Schema {
},
},
"service_tokens": schema.ListAttribute{
Description: "Only used with shared connection. List of service tokens required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/equinix_fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
Description: "Only used with shared connection. List of service tokens required to continue the setup process with [equinix_fabric_connection](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/fabric_connection) or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard)",
CustomType: fwtypes.NewListNestedObjectTypeOf[ServiceTokenModel](ctx),
ElementType: fwtypes.NewObjectTypeOf[ServiceTokenModel](ctx),
Computed: true,
Expand Down
4 changes: 2 additions & 2 deletions templates/data-sources/metal_connection.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In addition to all arguments above, the following attributes are exported:
* `organization_id` - ID of the organization where the connection is scoped to.
* `status` - Status of the connection resource.
* `service_tokens` - List of connection service tokens with attributes
* `id` - UUID of the service token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard).
* `id` - UUID of the service token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard).
* `expires_at` - Expiration date of the service token.
* `max_allowed_speed` - Maximum allowed speed for the service token, string like in the `speed` attribute.
* `type` - Token type, `a_side` or `z_side`.
Expand All @@ -55,4 +55,4 @@ In addition to all arguments above, the following attributes are exported:
* `status` - Port status.
* `link_status` - Port link status.
* `virtual_circuit_ids` - List of IDs of virtual cicruits attached to this port.
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/equinix_fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
* `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
6 changes: 3 additions & 3 deletions templates/data-sources/metal_devices.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For example, the {{ .SchemaMarkdown }} template can be used to replace manual sc

The datasource can be used to find a list of devices which meet filter criteria.

If you need to fetch a single device by ID or by project ID and hostname, use the [equinix_metal_device](equinix_metal_device.md) datasource.
If you need to fetch a single device by ID or by project ID and hostname, use the [equinix_metal_device](metal_device.md) datasource.

## Example Usage

Expand All @@ -29,7 +29,7 @@ The following arguments are supported:
* `project_id` - (Optional) ID of project containing the devices. Exactly one of `project_id` and `organization_id` must be set.
* `organization_id` - (Optional) ID of organization containing the devices.
* `search` - (Optional) - Search string to filter devices by hostname, description, short_id, reservation short_id, tags, plan name, plan slug, facility code, facility name, operating system name, operating system slug, IP addresses.
* `filter` - (Optional) One or more attribute/values pairs to filter. List of atributes to filter can be found in the [attribute reference](equinix_metal_device.md#attributes-reference) of the `equinix_metal_device` datasource.
* `filter` - (Optional) One or more attribute/values pairs to filter. List of atributes to filter can be found in the [attribute reference](metal_device.md#attributes-reference) of the `equinix_metal_device` datasource.
- `attribute` - (Required) The attribute used to filter. Filter attributes are case-sensitive
- `values` - (Required) The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR by default, and the request returns all results that match any of the specified values
- `match_by` - (Optional) The type of comparison to apply. One of: `in` , `re`, `substring`, `less_than`, `less_than_or_equal`, `greater_than`, `greater_than_or_equal`. Default is `in`.
Expand All @@ -41,4 +41,4 @@ All fields in the `devices` block defined below can be used as attribute for bot

In addition to all arguments above, the following attributes are exported:

* `devices` - list of resources with attributes like in the [equninix_metal_device datasources](equinix_metal_device.md).
* `devices` - list of resources with attributes like in the [equninix_metal_device datasources](metal_device.md).
2 changes: 1 addition & 1 deletion templates/data-sources/metal_precreated_ip_block.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Use this data source to get CIDR expression for precreated (management) IPv6 and

-> Precreated (management) IP blocks for a metro will not be available until first device is created in that metro.

-> Public IPv4 blocks auto-assigned (management) to a device cannot be retrieved. If you need that information, consider using the [equinix_metal_device](equinix_metal_device.md) data source instead.
-> Public IPv4 blocks auto-assigned (management) to a device cannot be retrieved. If you need that information, consider using the [equinix_metal_device](metal_device.md) data source instead.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion templates/data-sources/metal_reserved_ip_block.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ The following arguments are supported:

## Attributes Reference

This datasource exposes the same attributes as the [equinix_metal_reserved_ip_block](../resources/equinix_metal_reserved_ip_block.md) resource, with the following differences:
This datasource exposes the same attributes as the [equinix_metal_reserved_ip_block](../resources/metal_reserved_ip_block.md) resource, with the following differences:

* `type` - One of `global_ipv4`, `public_ipv4`, `private_ipv4`, `public_ipv6`,or `vrf`
2 changes: 1 addition & 1 deletion templates/guides/equinix_fabric_cloud_providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for further details and other options you can check on [References](#references)
## Getting started - Enabling an interconnection

Whether you are setting up a Multi-Cloud or Hybrid Cloud architecture, the main resource you will
need to define is an [equinix_fabric_connection](../resources/equinix_fabric_connection.md) which
need to define is an [equinix_fabric_connection](../resources/fabric_connection.md) which
will let Equinix enable an interconnection on your behalf to the specified cloud provider.
However, there are other required resources that must be configured on both Equinix and your cloud
provider to have the interconnection up and running. Below we describe these general steps using
Expand Down
Loading

0 comments on commit f5723b6

Please sign in to comment.