Skip to content

Commit

Permalink
docs: fix docs of vpc_v1
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhukun-Huawei committed Oct 7, 2023
1 parent 07e6b32 commit 36a8a3d
Show file tree
Hide file tree
Showing 18 changed files with 124 additions and 31 deletions.
17 changes: 9 additions & 8 deletions docs/data-sources/networking_port.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ data "flexibleengine_networking_port" "port_1" {

## Argument Reference

* `admin_state_up` - The administrative state of the port.

* `device_id` - The ID of the device the port belongs to.

* `device_owner` - The device owner of the port.

* `name` - The name of the port.

* `region` - (Optional, String) Specifies the region in which to obtain the port. If omitted, the provider-level region
will be used.

Expand All @@ -38,14 +46,7 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The data source ID in UUID format.

* `name` - The name of the port.

* `admin_state_up` - The administrative state of the port.

* `device_owner` - The device owner of the port.

* `device_id` - The ID of the device the port belongs to.

* `all_fixed_ips` - The collection of Fixed IP addresses on the port.

* `all_security_group_ids` - The collection of security group IDs applied on the port.

3 changes: 3 additions & 0 deletions docs/data-sources/vpc_peering_connection_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ The given filters must match exactly one VPC peering connection whose data will

* `name` (Optional) - The name of the specific VPC Peering Connection to retrieve.

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

## Attributes Reference

All of the argument attributes are exported as result attributes.
3 changes: 3 additions & 0 deletions docs/data-sources/vpc_route_ids_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ output "route_nexthop" {

* `vpc_id` (Required) - The VPC ID that you want to filter from.

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

## Attributes Reference

* `ids` - A list of all the route ids found. This data source will fail if none are found.
6 changes: 6 additions & 0 deletions docs/data-sources/vpc_route_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ route whose data will be exported as attributes.

* `type` (Optional) - Route type for filtering.

* `nexthop` (Optional) - Specifies the next hop. If the route type is peering, enter the VPC peering connection ID.
Changing this creates a new Route.

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

## Attribute Reference

All of the argument attributes are also exported as
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/vpc_subnet_ids_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ The following arguments are supported:

* `vpc_id` (Required) - Specifies the VPC ID used as the query filter.

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

## Attributes Reference

The following attributes are exported:
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/vpc_subnet_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ subnet whose data will be exported as attributes.

* `primary_dns` (Optional) - The IP address of DNS server 1 on the specific subnet.

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

* `secondary_dns` (Optional) - The IP address of DNS server 2 on the specific subnet.

* `availability_zone` (Optional) - The availability zone (AZ) to which the subnet should belong.
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/vpc_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,7 @@ The following attributes are exported:
* `shared` - Specifies whether the cross-tenant sharing is supported.

* `region` - See Argument Reference above.

* `routes.destination` - Specifies the destination network segment of a routex.

* `routes.nexthop` - Specifies the next hop of a route.
4 changes: 3 additions & 1 deletion docs/data-sources/vpcep_endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ data "flexibleengine_vpcep_endpoints" "dns_endpoints" {
## Attributes Reference

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

``
* `id` - Specifies a data source ID in UUID format.

* `endpoints` - Indicates the public VPC endpoints information. Structure is documented below.
Expand All @@ -50,6 +50,8 @@ The `endpoints` block contains:
* `whitelist` - List of IP or CIDR block which can access the VPC endpoint.
* `private_domain_name` - DNS name pointing to the VPC endpoint ip.
* `tags` - The key/value pairs to associate with the VPC endpoint.
* `tags.key` - Specifies the tag key. Each tag key contains a maximum of 127 unicode characters but cannot be left blank.
* `tags.value` - Specifies the tag value list. Each value contains a maximum of 255 Unicode characters. Before using values, delete SBC spaces before and after the value.
* `project_id` - The ID of the project holding the VPC endpoint.
* `created_at` - Creation date of the VPC endpoint.
* `updated_at` - Last update date of the VPC endpoint.
4 changes: 2 additions & 2 deletions docs/data-sources/vpcep_public_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ data "flexibleengine_vpcep_public_services" "dns_service" {

* `service_id` - (Optional, String) Specifies the unique ID of the public VPC endpoint service.

* `region` - The region in which to obtain the public VPC endpoint services.

## Attributes Reference

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

* `id` - Specifies a data source ID in UUID format.

* `region` - The region in which to obtain the public VPC endpoint services.

* `services` - Indicates the public VPC endpoint services information. Structure is documented below.

The `services` block contains:
Expand Down
9 changes: 8 additions & 1 deletion docs/resources/vpc_flow_log_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,17 @@ In addition to all arguments above, the following attributes are exported:

* `status` - The status of the flow log. The value can be `ACTIVE`, `DOWN` or `ERROR`.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.

## Import

VPC flow logs can be imported using the `id`, e.g.

```sh
terraform import flexibleengine_vpc_flow_log_v1.flowlog1 41b9d73f-eb1c-4795-a100-59a99b062513
```
```
10 changes: 10 additions & 0 deletions docs/resources/vpc_peering_connection_accepter_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ The following arguments are supported:

* `accept` (Optional)- Whether or not to accept the peering request. Defaults to `false`.

* `region` - (Optional, String, ForceNew) Specifies the region in which to create the vpc subnet. If omitted, the
provider-level region will be used. Changing this creates a new subnet.

## Removing flexibleengine_vpc_peering_connection_accepter_v2 from your configuration

FlexibleEngine allows a cross-tenant VPC Peering Connection to be deleted from either the requester's or accepter's side.
Expand All @@ -102,6 +105,13 @@ All of the argument attributes except accept are also exported as result attribu

* `peer_tenant_id` - The Tenant Id of the accepter tenant.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.

## Import

VPC Peering Connection Accepter can be imported using the VPC Peering Connection ID `vpc_peering_connection_id`, e.g.
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/vpc_peering_connection_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ The following arguments are supported:
* `peer_vpc_id` (Required) - Specifies the VPC ID of the accepter tenant. Changing this creates a new VPC peering connection.

* `peer_tenant_id` (Optional) - Specified the Tenant Id of the accepter tenant. Changing this creates a new VPC peering connection.

* `region` - (Optional, String, ForceNew) Specifies the region in which to create the vpc subnet. If omitted, the
provider-level region will be used. Changing this creates a new subnet.

## Attributes Reference

Expand All @@ -53,6 +56,13 @@ result attributes:

* `status` - The VPC peering connection status. The value can be PENDING_ACCEPTANCE, REJECTED, EXPIRED, DELETED, or ACTIVE.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.

## Import

VPC Peering resources can be imported using the `vpc peering id`, e.g.
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/vpc_route_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ resource "flexibleengine_vpc_route_v2" "vpc_route" {

The following arguments are supported:

* `region` - (Optional, String, ForceNew) The region in which to create the vpc route table.
If omitted, the provider-level region will be used. Changing this creates a new resource.

* `destination` (Required) - Specifies the destination IP address or CIDR block. Changing this creates a new Route.

* `nexthop` (Required) - Specifies the next hop. If the route type is peering, enter the VPC peering connection ID.
Expand All @@ -44,3 +47,10 @@ All of the argument attributes are also exported as
result attributes:

* `id` - The route ID.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.
10 changes: 10 additions & 0 deletions docs/resources/vpc_subnet_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ The following arguments are supported:

* `tags` - (Optional, Map) The key/value pairs to associate with the subnet.

* `description` (Optional, String) - Provides supplementary information about the subnet.
The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

## Attributes Reference

In addition to all arguments above, the following attributes are exported:
Expand All @@ -91,6 +94,13 @@ In addition to all arguments above, the following attributes are exported:

* `ipv6_gateway` - The IPv6 subnet gateway.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 5 minute.
* `delete` - Default is 5 minute.

## Import

Subnets can be imported using the VPC subnet ID, e.g.
Expand Down
7 changes: 7 additions & 0 deletions docs/resources/vpc_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ In addition to all arguments above, the following attributes are exported:

* `status` - The current status of the VPC. Possible values are as follows: CREATING, OK or ERROR.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 3 minute.

## Import

VPCs can be imported using the `id`, e.g.
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/vpcep_approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ The following arguments are supported:
* `endpoints` (Required) - Specifies the list of VPC endpoint IDs which accepted to connect to VPC endpoint service.
The VPC endpoints will be rejected when the resource was destroyed.

* `region` - The region in which to obtain the VPC endpoint service.

## Attributes Reference

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

* `id` - The unique ID in UUID format which equals to the ID of the VPC endpoint service.

* `region` - The region in which to obtain the VPC endpoint service.

* `connections` - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- `endpoint_id` - The unique ID of the VPC endpoint.
- `packet_id` - The packet ID of the VPC endpoint.
Expand All @@ -85,4 +85,4 @@ In addition to all arguments above, the following attributes are exported:
This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 3 minute.
* `delete` - Default is 10 minute.
11 changes: 9 additions & 2 deletions docs/resources/vpcep_endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,14 @@ The following arguments are supported:

* `tags` - (Optional) The key/value pairs to associate with the VPC endpoint.

* `region` - The region in which to create the VPC endpoint.

## Attributes Reference

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

* `id` - The unique ID of the VPC endpoint.

* `region` - The region in which to create the VPC endpoint.

* `status` - The status of the VPC endpoint. The value can be **accepted**, **pendingAcceptance** or **rejected**.

* `service_name` - The name of the VPC endpoint service.
Expand All @@ -123,6 +123,13 @@ In addition to all arguments above, the following attributes are exported:
* `private_domain_name` - The domain name for accessing the associated VPC endpoint service.
This parameter is only available when enable_dns is set to true.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.

## Import

VPC endpoint can be imported using the `id`, e.g.
Expand Down
35 changes: 21 additions & 14 deletions docs/resources/vpcep_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,62 +35,69 @@ resource "flexibleengine_vpcep_service" "demo" {

The following arguments are supported:

* `name` (Optional) - Specifies the name of the VPC endpoint service. The value contains a maximum of
* `name` (Optional, String) - Specifies the name of the VPC endpoint service. The value contains a maximum of
16 characters, including letters, digits, underscores (_), and hyphens (-).

* `vpc_id` (Required) - Specifies the ID of the VPC to which the backend resource of
* `vpc_id` (Required, String, ForceNew) - Specifies the ID of the VPC to which the backend resource of
the VPC endpoint service belongs. Changing this creates a new VPC endpoint service.

* `server_type` (Required) - Specifies the backend resource type. The value can be **VM**, **VIP** or **LB**.
Changing this creates a new VPC endpoint service.

* `port_id` (Required) - Specifies the ID for identifying the backend resource of the VPC endpoint service.
* `port_id` (Required, String) - Specifies the ID for identifying the backend resource of the VPC endpoint service.
- If the `server_type` is **VM**, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the `server_type` is **VIP**, the value is the NIC ID of the physical server where virtual resources are created.
- If the `server_type` is **LB**, the value is the ID of the port bound to the private IP address of the load balancer.

* `port_mapping` (Required) - Specified the port mappings opened to the VPC endpoint service.
* `port_mapping` (Required, List) - Specified the port mappings opened to the VPC endpoint service.
Structure is documented below.

* `approval` (Optional) - Specifies whether connection approval is required. The default value is false.
* `approval` (Optional, Bool) - Specifies whether connection approval is required. The default value is false.

* `permissions` (Optional) - Specifies the list of accounts to access the VPC endpoint service.
* `permissions` (Optional, Set) - Specifies the list of accounts to access the VPC endpoint service.
The record is in the `iam:domain::domain_id` format, while `*` allows all users to access the VPC endpoint service.

* `tags` - (Optional) The key/value pairs to associate with the VPC endpoint service.
* `tags` - (Optional, Map) The key/value pairs to associate with the VPC endpoint service.

The `port_mapping` block supports:

* `protocol` - (Optional) Specifies the protocol used in port mappings.
* `protocol` - (Optional, String) Specifies the protocol used in port mappings.
The value can be *TCP* or *UDP*. The default value is *TCP*.

* `service_port` - (Optional) Specifies the port for accessing the VPC endpoint service.
* `service_port` - (Optional, Int) Specifies the port for accessing the VPC endpoint service.
This port is provided by the backend service to provide services. The value ranges from 1 to 65535.

* `terminal_port` - (Optional) Specifies the port for accessing the VPC endpoint.
* `terminal_port` - (Optional, Int) Specifies the port for accessing the VPC endpoint.
This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service.
The value ranges from 1 to 65535.

* `region` - The region in which to create the VPC endpoint service.

* `service_type` - (Required, String, ForceNew)The type of the VPC endpoint service. Only **interface** can be configured.

## Attributes Reference

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

* `id` - The unique ID of the VPC endpoint service.

* `region` - The region in which to create the VPC endpoint service.

* `status` - The status of the VPC endpoint service. The value can be **available** or **failed**.

* `service_name` - The full name of the VPC endpoint service in the format: *region.name.id*.

* `service_type` - The type of the VPC endpoint service. Only **interface** can be configured.

* `connections` - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- `endpoint_id` - The unique ID of the VPC endpoint.
- `packet_id` - The packet ID of the VPC endpoint.
- `domain_id` - The user's domain ID.
- `status` - The connection status of the VPC endpoint.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 10 minute.

## Import

VPC endpoint services can be imported using the `id`, e.g.
Expand Down

0 comments on commit 36a8a3d

Please sign in to comment.