224 lines
11 KiB
Markdown
224 lines
11 KiB
Markdown
# Google Compute Engine VM module
|
|
|
|
This module can operate in two distinct modes:
|
|
|
|
- instance creation, with optional unmanaged group
|
|
- instance template creation
|
|
|
|
In both modes, an optional service account can be created and assigned to either instances or template. If you need a managed instance group when using the module in template mode, refer to the [`compute-mig`](../compute-mig) module.
|
|
|
|
## Examples
|
|
|
|
### Instance leveraging defaults
|
|
|
|
The simplest example leverages defaults for the boot disk image and size, and uses a service account created by the module. Multiple instances can be managed via the `instance_count` variable.
|
|
|
|
```hcl
|
|
module "simple-vm-example" {
|
|
source = "../modules/compute-vm"
|
|
project_id = "my-project"
|
|
region = "europe-west1"
|
|
name = "test"
|
|
network_interfaces = [{
|
|
network = local.network_self_link
|
|
subnetwork = local.subnet_self_link
|
|
nat = false
|
|
addresses = null
|
|
alias_ips = null
|
|
}]
|
|
service_account_create = true
|
|
instance_count = 1
|
|
}
|
|
```
|
|
|
|
### Disk encryption with Cloud KMS
|
|
|
|
This example shows how to control disk encryption via the the `encryption` variable, in this case the self link to a KMS CryptoKey that will be used to encrypt boot and attached disk. Managing the key with the `../kms` module is of course possible, but is not shown here.
|
|
|
|
```hcl
|
|
module "kms-vm-example" {
|
|
source = "../modules/compute-vm"
|
|
project_id = local.project_id
|
|
region = local.region
|
|
name = "kms-test"
|
|
network_interfaces = [{
|
|
network = local.network_self_link
|
|
subnetwork = local.subnet_self_link
|
|
nat = false
|
|
addresses = null
|
|
alias_ips = null
|
|
}]
|
|
attached_disks = [
|
|
{
|
|
name = "attached-disk"
|
|
size = 10
|
|
image = null
|
|
options = {
|
|
auto_delete = true
|
|
mode = null
|
|
source = null
|
|
type = null
|
|
}
|
|
}
|
|
]
|
|
service_account_create = true
|
|
instance_count = 1
|
|
boot_disk = {
|
|
image = "projects/debian-cloud/global/images/family/debian-10"
|
|
type = "pd-ssd"
|
|
size = 10
|
|
}
|
|
encryption = {
|
|
encrypt_boot = true
|
|
disk_encryption_key_raw = null
|
|
kms_key_self_link = local.kms_key.self_link
|
|
}
|
|
}
|
|
```
|
|
|
|
### Using Alias IPs
|
|
|
|
This example shows how add additional [Alias IPs](https://cloud.google.com/vpc/docs/alias-ip) to your VM.
|
|
|
|
```hcl
|
|
module "vm-with-alias-ips" {
|
|
source = "../modules/compute-vm"
|
|
project_id = "my-project"
|
|
region = "europe-west1"
|
|
name = "test"
|
|
network_interfaces = [{
|
|
network = local.network_self_link
|
|
subnetwork = local.subnet_self_link
|
|
nat = false
|
|
addresses = null
|
|
alias_ips = {
|
|
alias1 = [
|
|
"10.16.0.10/32", # alias1 IP for first instance
|
|
"10.16.0.11/32", # alias1 IP for second instance
|
|
"10.16.0.12/32", # alias1 IP for third instance
|
|
]
|
|
}
|
|
}]
|
|
service_account_create = true
|
|
instance_count = 3
|
|
}
|
|
```
|
|
|
|
### Instance template
|
|
|
|
This example shows how to use the module to manage an instance template that defines an additional attached disk for each instance, and overrides defaults for the boot disk image and service account.
|
|
|
|
```hcl
|
|
module "cos-test" {
|
|
source = "../modules/compute-vm"
|
|
project_id = "my-project"
|
|
region = "europe-west1"
|
|
name = "test"
|
|
network_interfaces = [{
|
|
network = local.network_self_link
|
|
subnetwork = local.subnet_self_link
|
|
nat = false
|
|
addresses = null
|
|
alias_ips = null
|
|
}]
|
|
instance_count = 1
|
|
boot_disk = {
|
|
image = "projects/cos-cloud/global/images/family/cos-stable"
|
|
type = "pd-ssd"
|
|
size = 10
|
|
}
|
|
attached_disks = [
|
|
{ name = "disk-1", size = 10, image = null, options = null }
|
|
]
|
|
service_account = "vm-default@my-project.iam.gserviceaccount.com"
|
|
use_instance_template = true
|
|
}
|
|
```
|
|
|
|
### Instance group
|
|
|
|
If an instance group is needed when operating in instance mode, simply set the `group` variable to a non null map. The map can contain named port declarations, or be empty if named ports are not needed.
|
|
|
|
```hcl
|
|
module "instance-group" {
|
|
source = "../../cloud-foundation-fabric/modules/compute-vm"
|
|
project_id = "my-project"
|
|
region = "europe-west1"
|
|
name = "ilb-test"
|
|
network_interfaces = [{
|
|
network = local.network_self_link
|
|
subnetwork = local.subnetwork_self_link
|
|
nat = false
|
|
addresses = null
|
|
alias_ips = null
|
|
}]
|
|
boot_disk = {
|
|
image = "projects/cos-cloud/global/images/family/cos-stable"
|
|
type = "pd-ssd"
|
|
size = 10
|
|
}
|
|
service_account = local.service_account_email
|
|
service_account_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
|
|
metadata = {
|
|
user-data = local.cloud_config
|
|
}
|
|
group = { named_ports = {} }
|
|
}
|
|
|
|
```
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---: |:---:|:---:|
|
|
| name | Instances base name. | <code title="">string</code> | ✓ | |
|
|
| network_interfaces | Network interfaces configuration. Use self links for Shared VPC, set addresses and alias_ips to null if not needed. | <code title="list(object({ nat = bool network = string subnetwork = string addresses = object({ internal = list(string) external = list(string) }) alias_ips = map(list(string)) }))">list(object({...}))</code> | ✓ | |
|
|
| project_id | Project id. | <code title="">string</code> | ✓ | |
|
|
| region | Compute region. | <code title="">string</code> | ✓ | |
|
|
| *attached_disk_defaults* | Defaults for attached disks options. | <code title="object({ auto_delete = bool mode = string type = string source = string })">object({...})</code> | | <code title="{ auto_delete = true source = null mode = "READ_WRITE" type = "pd-ssd" }">...</code> |
|
|
| *attached_disks* | Additional disks, if options is null defaults will be used in its place. | <code title="list(object({ name = string image = string size = string options = object({ auto_delete = bool mode = string source = string type = string }) }))">list(object({...}))</code> | | <code title="">[]</code> |
|
|
| *boot_disk* | Boot disk properties. | <code title="object({ image = string size = number type = string })">object({...})</code> | | <code title="{ image = "projects/debian-cloud/global/images/family/debian-10" type = "pd-ssd" size = 10 }">...</code> |
|
|
| *can_ip_forward* | Enable IP forwarding. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *enable_display* | Enable virtual display on the instances | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *encryption* | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | <code title="object({ encrypt_boot = bool disk_encryption_key_raw = string kms_key_self_link = string })">object({...})</code> | | <code title="">null</code> |
|
|
| *group* | Define this variable to create an instance group for instances. Disabled for template use. | <code title="object({ named_ports = map(number) })">object({...})</code> | | <code title="">null</code> |
|
|
| *hostname* | Instance FQDN name. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *iam* | IAM bindings in {ROLE => [MEMBERS]} format. | <code title="map(list(string))">map(list(string))</code> | | <code title="">{}</code> |
|
|
| *instance_count* | Number of instances to create (only for non-template usage). | <code title="">number</code> | | <code title="">1</code> |
|
|
| *instance_type* | Instance type. | <code title="">string</code> | | <code title="">f1-micro</code> |
|
|
| *labels* | Instance labels. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
|
| *metadata* | Instance metadata. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
|
| *metadata_list* | List of instance metadata that will be cycled through. Ignored for template use. | <code title="list(map(string))">list(map(string))</code> | | <code title="">[]</code> |
|
|
| *min_cpu_platform* | Minimum CPU platform. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *options* | Instance options. | <code title="object({ allow_stopping_for_update = bool deletion_protection = bool preemptible = bool })">object({...})</code> | | <code title="{ allow_stopping_for_update = true deletion_protection = false preemptible = false }">...</code> |
|
|
| *scratch_disks* | Scratch disks configuration. | <code title="object({ count = number interface = string })">object({...})</code> | | <code title="{ count = 0 interface = "NVME" }">...</code> |
|
|
| *service_account* | Service account email. Unused if service account is auto-created. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *service_account_create* | Auto-create service account. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *service_account_scopes* | Scopes applied to service account. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
| *shielded_config* | Shielded VM configuration of the instances. | <code title="object({ enable_secure_boot = bool enable_vtpm = bool enable_integrity_monitoring = bool })">object({...})</code> | | <code title="">null</code> |
|
|
| *tags* | Instance tags. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
| *use_instance_template* | Create instance template instead of instances. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *zones* | Compute zone, instance will cycle through the list, defaults to the 'b' zone in the region. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| external_ips | Instance main interface external IP addresses. | |
|
|
| group | Instance group resource. | |
|
|
| instances | Instance resources. | |
|
|
| internal_ips | Instance main interface internal IP addresses. | |
|
|
| names | Instance names. | |
|
|
| self_links | Instance self links. | |
|
|
| service_account | Service account resource. | |
|
|
| service_account_email | Service account email. | |
|
|
| service_account_iam_email | Service account email. | |
|
|
| template | Template resource. | |
|
|
| template_name | Template name. | |
|
|
<!-- END TFDOC -->
|
|
|
|
## TODO
|
|
|
|
- [ ] add support for instance groups
|