Description

This is a helper module used by Status internal repos like: infra-hq, infra-misc, infra-eth-cluster, or infra-swarm.

Usage

Simply import the modue using the source directive:

module "google-cloud" {
  source = "github.com/status-im/infra-tf-google-cloud"
}

More details.

Variables

• Scaling
  • host_count - Number of hosts to start in this zone.
  • image - OS image used to create host. (default: ubuntu-os-cloud/ubuntu-2204-lts)
  • type - Type of machine to deploy. (default: n1-standard-1)
  • zone - Specific zone in which to deploy hosts. (default: us-central1-a)
  • root_vol_type - Type of the base/root volume. (default: pd-standard)
  • root_vol_size - Size of the base/root volume. (default: 10)
  • data_vol_type - Type of the extra data volume. (default: pd-balanced)
  • data_vol_size - Size of the extra data volume. (default: 0)
• General
  • name - Prefix of hostname before index. (default: node)
  • group - Name of Ansible group to add hosts to.
  • env - Environment for these hosts, affects DNS entries.
  • stage - Name of stage, like prod, dev, or staging.
• Security
  • ansible_playbook - Location of the Ansible playbook to run.
  • ssh_user - User used to log in to instance (default: root)
  • ssh_keys - Names of ssh public keys to add to created hosts.
  • win_password - Password for the admin user created with setup.ps1 script.
  • open_tcp_ports - TCP port ranges to enable access from outside. Format: N-N (default: [])
  • open_udp_ports - UDP port ranges to enable access from outside. Format: N-N (default: [])
  • blocked_ips - IP Address ranges to block. Format: CIDR (default: [])
• DNS
  • cf_zone_id - CloudFlare DNS domain zone ID. (ID for status.im)
  • domain - DNS Domain for hostnames. (default: status.im)

Windows

If you want to create a Windows host you'll have to specify a different image and win_password. You will also most probably have to specify a different bootstrap Ansible playbook.

module "google-cloud" {
  image = "windows-cloud/windows-server-2004-dc-core-v20200813"
  win_password = "my-secret-password"
  ansible_playbook = "./ansible/win_bootstrap.yml"
}

You can help yourself debug boot process of new instances using the following commands:

gcloud beta compute connect-to-serial-port "${INSTANCE_NAME}"
gcloud beta compute instances get-serial-port-output "${INSTANCE_NAME}"

But it requires the serial-port-enable metadata attribute to be true for the given host.