164 lines
8.0 KiB
Markdown
164 lines
8.0 KiB
Markdown
# Google Cloud VMWare Engine Private Cloud Module
|
|
|
|
The module manages one or more Google Cloud VMWare Engine Private Clouds.
|
|
|
|
It can either create a new VMWare engine network shared between the private clouds or it can use an existing one. The module also creates peering connections to users' VPCs or other VMware engine networks.
|
|
|
|
To understand the limits and to properly configure the vSphere/vSAN subnets CIDR range please refer to the [GCVE public documentation](https://cloud.google.com/vmware-engine/docs/quickstart-networking-requirements).
|
|
|
|
The deployment might require up to 2 hours, depending on the selected private cloud target zone.
|
|
|
|
<!-- BEGIN TOC -->
|
|
- [Limitations](#limitations)
|
|
- [Basic Private Cloud Creation](#basic-private-cloud-creation)
|
|
- [Customize management cluster configs](#customize-management-cluster-configs)
|
|
- [Create additional clusters](#create-additional-clusters)
|
|
- [Enable cluster Internet access and inbound connectivity](#enable-cluster-internet-access-and-inbound-connectivity)
|
|
- [Variables](#variables)
|
|
- [Outputs](#outputs)
|
|
<!-- END TOC -->
|
|
|
|
## Limitations
|
|
|
|
The module (and the underlying resource) still don't support the creation of stretched (regional) private clouds.
|
|
|
|
## Basic Private Cloud Creation
|
|
|
|
```hcl
|
|
module "gcve-pc" {
|
|
source = "./fabric/modules/gcve-private-cloud"
|
|
prefix = "gcve-pc"
|
|
project_id = "gcve-test-project"
|
|
|
|
vmw_network_peerings = {
|
|
transit-conn1 = {
|
|
peer_network = "projects/test-prj-gcve-01/global/networks/default"
|
|
}
|
|
}
|
|
|
|
vmw_private_cloud_configs = {
|
|
pcc_one = {
|
|
cidr = "192.168.0.0/24"
|
|
zone = "europe-west8-a"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3 inventory=basic.yaml
|
|
```
|
|
|
|
## Customize management cluster configs
|
|
|
|
You can customize the management cluster of each VMware engine private cloud.
|
|
|
|
```hcl
|
|
module "gcve-pc" {
|
|
source = "./fabric/modules/gcve-private-cloud"
|
|
prefix = "gcve-pc"
|
|
project_id = "gcve-test-project"
|
|
|
|
vmw_network_peerings = {
|
|
transit-conn1 = {
|
|
peer_network = "projects/test-prj-gcve-01/global/networks/default"
|
|
}
|
|
}
|
|
|
|
vmw_private_cloud_configs = {
|
|
pcc_one = {
|
|
cidr = "192.168.0.0/24"
|
|
management_cluster_config = {
|
|
node_type_id = "standard-72"
|
|
node_count = 6
|
|
custom_core_count = 28
|
|
}
|
|
zone = "europe-west8-a"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3 inventory=custom-management.yaml
|
|
```
|
|
|
|
## Create additional clusters
|
|
|
|
You can optionally create additional clusters in each VMware engine private cloud.
|
|
|
|
```hcl
|
|
module "gcve-pc" {
|
|
source = "./fabric/modules/gcve-private-cloud"
|
|
prefix = "gcve-pc"
|
|
project_id = "gcve-test-project"
|
|
|
|
vmw_network_peerings = {
|
|
transit-conn1 = {
|
|
peer_network = "projects/test-prj-gcve-01/global/networks/default"
|
|
}
|
|
}
|
|
|
|
vmw_private_cloud_configs = {
|
|
pcc_one = {
|
|
cidr = "192.168.0.0/24"
|
|
additional_cluster_configs = {
|
|
test-cluster-one = {
|
|
node_type_id = "standard-72"
|
|
node_count = 6
|
|
custom_core_count = 28
|
|
}
|
|
test-cluster-two = {
|
|
node_type_id = "standard-72"
|
|
node_count = 4
|
|
custom_core_count = 28
|
|
}
|
|
}
|
|
zone = "europe-west8-a"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=5 inventory=additional-clusters.yaml
|
|
```
|
|
|
|
## Enable cluster Internet access and inbound connectivity
|
|
|
|
```hcl
|
|
module "gcve-pc" {
|
|
source = "./fabric/modules/gcve-private-cloud"
|
|
prefix = "gcve-pc"
|
|
project_id = "gcve-test-project"
|
|
vmw_network_config = {
|
|
network_policies = {
|
|
ew8 = {
|
|
edge_services_cidr = "192.168.100.0/26"
|
|
region = "europe-west8"
|
|
expose_on_internet = true
|
|
outbound_internet_access = true
|
|
}
|
|
}
|
|
}
|
|
vmw_private_cloud_configs = {
|
|
pcc_one = {
|
|
cidr = "192.168.0.0/24"
|
|
zone = "europe-west8-a"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3 inventory=network-policy.yaml
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [prefix](variables.tf#L17) | Resources name prefix. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L22) | Project id. | <code>string</code> | ✓ | |
|
|
| [vmw_network_config](variables.tf#L27) | VMware Engine network configuration. | <code title="object({ create = optional(bool, true) description = optional(string, "Terraform-managed.") name = optional(string, "default") network_policies = optional(map(object({ edge_services_cidr = string region = string description = optional(string, "Terraform-managed.") expose_on_internet = optional(bool) outbound_internet_access = optional(bool) })), {}) })">object({…})</code> | | <code>{}</code> |
|
|
| [vmw_network_peerings](variables.tf#L44) | The network peerings towards users' VPCs or other VMware Engine networks. The key is the peering name suffix. | <code title="map(object({ peer_network = string description = optional(string, "Managed by Terraform.") export_custom_routes = optional(bool, false) export_custom_routes_with_public_ip = optional(bool, false) import_custom_routes = optional(bool, false) import_custom_routes_with_public_ip = optional(bool, false) peer_to_vmware_engine_network = optional(bool, false) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
| [vmw_private_cloud_configs](variables.tf#L58) | The VMware private cloud configurations. The key is the unique private cloud name suffix. | <code title="map(object({ cidr = string zone = string additional_cluster_configs = optional(map(object({ custom_core_count = optional(number) node_count = optional(number, 3) node_type_id = optional(string, "standard-72") })), {}) management_cluster_config = optional(object({ custom_core_count = optional(number) name = optional(string, "mgmt-cluster") node_count = optional(number, 3) node_type_id = optional(string, "standard-72") }), {}) description = optional(string, "Managed by Terraform.") }))">map(object({…}))</code> | | <code title="{ pcc_one = { cidr = "192.168.0.0/24" additional_cluster_configs = { test-cluster-one = { node_type_id = "standard-72" node_count = 6 custom_core_count = 28 } test-cluster-two = { node_type_id = "standard-72" node_count = 4 custom_core_count = 28 } } zone = "europe-west8-a" } }">{…}</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [vmw_engine_network_config](outputs.tf#L17) | VMware engine network configuration. | |
|
|
| [vmw_engine_network_peerings](outputs.tf#L22) | The peerings created towards the user VPC or other VMware engine networks. | |
|
|
| [vmw_engine_network_policies](outputs.tf#L27) | The network policies associated to the VMware engine network. | |
|
|
| [vmw_engine_private_clouds](outputs.tf#L32) | VMware engine private cloud resources. | |
|
|
<!-- END TFDOC -->
|