Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Basic Cloud Scanner Example

This example demonstrates a basic deployment of the Upwind Cloud Scanner module with minimal configuration.

Features

  • Single Cloud Scanner instance group
  • Default VPC network configuration
  • Standard machine type and disk configuration
  • IAP SSH access enabled
  • Automatic scaling disabled (fixed size: 1)

Usage

  1. Set your required variables:
export TF_VAR_upwind_organization_id="org_your_org_id"
export TF_VAR_scanner_id="ucsc-your-scanner-id"
export TF_VAR_cloudscanner_sa_email="cloudscanner-sa@your-project.iam.gserviceaccount.com"
export TF_VAR_cloudscanner_scaler_sa_email="cloudscanner-scaler-sa@your-project.iam.gserviceaccount.com"
export TF_VAR_upwind_orchestrator_project="your-google-cloud-project-id"
  1. Initialize and apply:
terraform init
terraform plan
terraform apply

Requirements

  • Service accounts must be pre-created with appropriate permissions
  • Secret Manager secrets must contain the scanner credentials
  • Required IAM roles must be created for the service accounts

Resources Created

  • Cloud Scanner instance group manager (1 instance)
  • Instance templates with blue/green deployment support
  • Cloud Run scaler function
  • Cloud Scheduler job for periodic scaling
  • Default VPC network and subnet (if custom network not specified)
  • Cloud NAT for outbound internet access

This configuration is suitable for development and testing environments.

Requirements

Name Version
terraform >= 1.0
null >= 3.0

Providers

No providers.

Modules

Name Source Version
cloudscanner_basic ../../modules/main n/a

Resources

No resources.

Inputs

Name Description Type Default Required
cloudscanner_sa_email The cloudscanner service account email to use string n/a yes
cloudscanner_scaler_sa_email The cloudscanner scaler service account email to use string n/a yes
scanner_id The Upwind Scanner ID string n/a yes
upwind_orchestrator_project The main Google Cloud project where the resources are created string n/a yes
upwind_organization_id The Upwind Organization ID string n/a yes

Outputs

Name Description
cloudscanner_asg_name The name of the Cloud Scanner Auto Scaling Group

Requirements

Name Version
terraform >= 1.0
null >= 3.0

Providers

No providers.

Modules

Name Source Version
cloudscanner_basic ../../modules/main n/a

Resources

No resources.

Inputs

Name Description Type Default Required
cloudscanner_sa_email The cloudscanner service account email to use string n/a yes
cloudscanner_scaler_sa_email The cloudscanner scaler service account email to use string n/a yes
scanner_id The Upwind Scanner ID string n/a yes
upwind_orchestrator_project The main Google Cloud project where the resources are created string n/a yes
upwind_organization_id The Upwind Organization ID string n/a yes

Outputs

Name Description
cloudscanner_asg_name The name of the Cloud Scanner Auto Scaling Group