add gcp resource: gcp network's docs (#513)

* add gcp resource: gcp network's docs

Signed-off-by: Nicola115 <2225992901@qq.com>

* add gcp network in the cloud-resouces-list table

Signed-off-by: Nicola115 <2225992901@qq.com>
This commit is contained in:
Avery 2022-02-17 19:41:50 +08:00 committed by GitHub
parent e090ab1dc0
commit c8e0240366
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 501 additions and 353 deletions

View File

@ -4,7 +4,7 @@ title: Supported Cloud Resource list
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------------ | --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Terraform | Alibaba Cloud | [ack](./terraform/alibaba-ack.md) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [amqp](./terraform/alibaba-amqp.md) | Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) |
| | | [ask](./terraform/alibaba-ask.md) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
@ -91,3 +91,4 @@ title: Supported Cloud Resource list
| | | [virtual network](./terraform/azure-virtual-network.md) | Azure Virtual Network |
| | Tencent Cloud | [subnet](./terraform/tencent-subnet.md) | Tencent Cloud Subnet |
| | | [vpc](./terraform/tencent-vpc.md) | Terraform configuration for Tencent Cloud VPC |
| | Google Cloud Platform | [network](./terraform/gcp-network.md) | Terraform configuration for Google Cloud Platform Network |

View File

@ -0,0 +1,36 @@
---
title: Gcp-Network
---
## Description
Terraform configuration for GCP network
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
subnets | The list of subnets being created | list(map(string)) | true |
routes | List of routes being created in this VPC | list(map(string)) | false |
auto_create_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | false |
network_name | The name of the network being created | | true |
routing_mode | The network routing mode (default 'GLOBAL') | string | false |
secondary_ranges | Secondary ranges that will be used in some of the subnets | map(list(object({ range_name = string, ip_cidr_range = string }))) | false |
firewall_rules | List of firewall rules | any | false |
delete_default_internet_gateway_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | bool | false |
description | An optional description of this resource. The resource must be recreated to modify this field. | string | false |
mtu | The network MTU. Must be a value between 1460 and 1500 inclusive. If set to 0 (meaning MTU is unset), the network will default to 1460 automatically. | number | false |
project_id | The ID of the project where this VPC will be created | | true |
shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -3,7 +3,7 @@ title: 云资源列表
---
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --------- | --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Terraform | 阿里云 | [ack](./terraform/alibaba-ack.md) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [amqp](./terraform/alibaba-amqp.md) | Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) |
| | | [ask](./terraform/alibaba-ask.md) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
@ -90,3 +90,4 @@ title: 云资源列表
| | | [virtual network](./terraform/azure-virtual-network.md) | Azure Virtual Network |
| | 腾讯云 | [subnet](./terraform/tencent-subnet.md) | Tencent Cloud Subnet |
| | | [vpc](./terraform/tencent-vpc.md) | Terraform configuration for Tencent Cloud VPC |
| | Google Cloud Platform | [network](./terraform/gcp-network.md) | Terraform configuration for Google Cloud Platform |

View File

@ -0,0 +1,36 @@
---
title: Gcp-Network
---
## 描述
Terraform configuration for GCP network
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
auto_create_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | false |
network_name | The name of the network being created | | true |
routing_mode | The network routing mode (default 'GLOBAL') | string | false |
routes | List of routes being created in this VPC | list(map(string)) | false |
firewall_rules | List of firewall rules | any | false |
delete_default_internet_gateway_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | bool | false |
mtu | The network MTU. Must be a value between 1460 and 1500 inclusive. If set to 0 (meaning MTU is unset), the network will default to 1460 automatically. | number | false |
project_id | The ID of the project where this VPC will be created | | true |
shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | bool | false |
subnets | The list of subnets being created | list(map(string)) | true |
secondary_ranges | Secondary ranges that will be used in some of the subnets | map(list(object({ range_name = string, ip_cidr_range = string }))) | false |
description | An optional description of this resource. The resource must be recreated to modify this field. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -3,7 +3,7 @@ title: 云资源列表
---
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --------- | ---------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Terraform | 阿里云 | [ack](./terraform/alibaba-ack.md) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [amqp](./terraform/alibaba-amqp.md) | Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) |
| | | [ask](./terraform/alibaba-ask.md) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
@ -90,3 +90,5 @@ title: 云资源列表
| | | [virtual network](./terraform/azure-virtual-network.md) | Azure Virtual Network |
| | 腾讯云 | [subnet](./terraform/tencent-subnet.md) | Tencent Cloud Subnet |
| | | [vpc](./terraform/tencent-vpc.md) | Terraform configuration for Tencent Cloud VPC |
| | Google Cloud Platform | [network](./terraform/gcp-network.md) | Terraform configuration for Google Cloud Platform |

View File

@ -0,0 +1,36 @@
---
title: Gcp-Network
---
## 描述
Terraform configuration for GCP network
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
auto_create_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | false |
network_name | The name of the network being created | | true |
routing_mode | The network routing mode (default 'GLOBAL') | string | false |
routes | List of routes being created in this VPC | list(map(string)) | false |
firewall_rules | List of firewall rules | any | false |
delete_default_internet_gateway_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | bool | false |
mtu | The network MTU. Must be a value between 1460 and 1500 inclusive. If set to 0 (meaning MTU is unset), the network will default to 1460 automatically. | number | false |
project_id | The ID of the project where this VPC will be created | | true |
shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | bool | false |
subnets | The list of subnets being created | list(map(string)) | true |
secondary_ranges | Secondary ranges that will be used in some of the subnets | map(list(object({ range_name = string, ip_cidr_range = string }))) | false |
description | An optional description of this resource. The resource must be recreated to modify this field. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -2,9 +2,8 @@
title: Supported Cloud Resource list
---
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------------ | --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Terraform | Alibaba Cloud | [ack](./terraform/alibaba-ack.md) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [amqp](./terraform/alibaba-amqp.md) | Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) |
| | | [ask](./terraform/alibaba-ask.md) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
@ -91,3 +90,4 @@ title: Supported Cloud Resource list
| | | [virtual network](./terraform/azure-virtual-network.md) | Azure Virtual Network |
| | Tencent Cloud | [subnet](./terraform/tencent-subnet.md) | Tencent Cloud Subnet |
| | | [vpc](./terraform/tencent-vpc.md) | Terraform configuration for Tencent Cloud VPC |
| | Google Cloud Platform | [network](./terraform/gcp-network.md) | Terraform configuration for Google Cloud Platform Network |

View File

@ -0,0 +1,36 @@
---
title: Gcp-Network
---
## Description
Terraform configuration for GCP network
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
subnets | The list of subnets being created | list(map(string)) | true |
routes | List of routes being created in this VPC | list(map(string)) | false |
auto_create_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | false |
network_name | The name of the network being created | | true |
routing_mode | The network routing mode (default 'GLOBAL') | string | false |
secondary_ranges | Secondary ranges that will be used in some of the subnets | map(list(object({ range_name = string, ip_cidr_range = string }))) | false |
firewall_rules | List of firewall rules | any | false |
delete_default_internet_gateway_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | bool | false |
description | An optional description of this resource. The resource must be recreated to modify this field. | string | false |
mtu | The network MTU. Must be a value between 1460 and 1500 inclusive. If set to 0 (meaning MTU is unset), the network will default to 1460 automatically. | number | false |
project_id | The ID of the project where this VPC will be created | | true |
shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |