# Google Cloud VMWare Engine Private Cloud Module

This module implements the creation and management of a Google Cloud VMWare Engine Private Cloud with its management cluster. If configured, it also creates the vmware engine network or it can work with an existing one. The creation of the private connection with the user VPC requires the execution of the  [Google SDK command](https://cloud.google.com/sdk/gcloud/reference/vmware/private-connections/create#--routing-mode) the module provides as an output.

Be aware that the deployment of this module might requires up to 2 hours depending on the selected private cloud target zone.

## TOC

<!-- BEGIN TOC -->
- [TOC](#toc)
- [Limitations](#limitations)
- [Basic Private Cloud Creation](#basic-private-cloud-creation)
- [Private Cloud Creation with custom nodes and cores count](#private-cloud-creation-with-custom-nodes-and-cores-count)
- [Files](#files)
- [Variables](#variables)
<!-- END TOC -->

## Limitations
At the moment this module doesn't support the following use cases:
- `Single node private cloud`
- `Stretched private cloud`

## Basic Private Cloud Creation

```hcl
module "gcve-pc" {
  source          = "./fabric/modules/gcve-private-cloud"
  name            = "gcve-pc"
  project_id      = "gcve-test-project"
  zone            = "asia-southeast1-a"
  management_cidr = "192.168.0.0/24"

  private_connections = {
    transit-conn1 = {
      name              = "transit-conn1",
      network_self_link = "projects/test-prj-elia-01/global/networks/default",
      peering           = "servicenetworking-googleapis-com"
      type              = "PRIVATE_SERVICE_ACCESS",
      routing_mode      = "REGIONAL"
    }
  }
}
# tftest modules=1 resources=2 inventory=basic.yaml
```
## Private Cloud Creation with custom nodes and cores count

```hcl
module "gcve-pc" {
  source          = "./fabric/modules/gcve-private-cloud"
  name            = "gcve-pc"
  project_id      = "gcve-test-project"
  zone            = "asia-southeast1-a"
  management_cidr = "192.168.0.0/24"

  management_cluster_config = {
    node_type_id      = "standard-72"
    node_count        = 6
    custom_core_count = 28
  }

  private_connections = {
    transit-conn1 = {
      name              = "transit-conn1",
      network_self_link = "projects/test-prj-elia-01/global/networks/default",
      peering           = "servicenetworking-googleapis-com"
      type              = "PRIVATE_SERVICE_ACCESS",
      routing_mode      = "REGIONAL"
    }
  }
}
# tftest modules=1 resources=2 inventory=custom.yaml
```

<!-- TFDOC OPTS files:1 -->
<!-- BEGIN TFDOC -->
## Files

| name | description | resources |
|---|---|---|
| [main.tf](./main.tf) | Module-level locals and resources. | <code>google_vmwareengine_network</code> · <code>google_vmwareengine_private_cloud</code> |
| [output.tf](./output.tf) | None |  |
| [variables.tf](./variables.tf) | Module variables. |  |
| [versions.tf](./versions.tf) | Version pins. |  |

## Variables

| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [management_cidr](variables.tf#L23) | vSphere/vSAN subnets CIDR range. | <code>string</code> | ✓ |  |
| [name](variables.tf#L42) | Private cloud name. | <code>string</code> | ✓ |  |
| [project_id](variables.tf#L74) | Project id. | <code>string</code> | ✓ |  |
| [zone](variables.tf#L85) | Private cloud zone. | <code>string</code> | ✓ |  |
| [description](variables.tf#L17) | Private cloud description. | <code>string</code> |  | <code>&#34;Terraform-managed.&#34;</code> |
| [management_cluster_config](variables.tf#L28) | Management cluster configuration. | <code title="object&#40;&#123;&#10;  node_type_id      &#61; string&#10;  node_count        &#61; number,&#10;  custom_core_count &#61; number&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code title="&#123;&#10;  node_type_id      &#61; &#34;standard-72&#34;,&#10;  node_count        &#61; 3,&#10;  custom_core_count &#61; null&#10;&#125;">&#123;&#8230;&#125;</code> |
| [private_connections](variables.tf#L47) | VMWare private connections configuration. It is used to create the gcloud command printed as output. | <code title="map&#40;object&#40;&#123;&#10;  name              &#61; string&#10;  description       &#61; optional&#40;string, &#34;Terraform-managed.&#34;&#41;&#10;  network_self_link &#61; string&#10;  peering           &#61; string&#10;  type              &#61; optional&#40;string, &#34;REGIONAL&#34;&#41;&#10;  routing_mode      &#61; optional&#40;string, &#34;PRIVATE_SERVICE_ACCESS&#34;&#41;&#10;&#125;&#41;&#41;">map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> |  | <code>&#123;&#125;</code> |
| [vmwareengine_network_create](variables.tf#L79) | Create the VMware Engine network. When set to false, it uses a data source to reference an existing VMware Engine network. | <code>bool</code> |  | <code>true</code> |
<!-- END TFDOC -->