Skip to content

Terraform for Corelight's Sensor Configuration.

License

Notifications You must be signed in to change notification settings

corelight/terraform-config-sensor

Repository files navigation

terraform-config-sensor

Terraform for Corelight's Sensor Configuration.

Usage

module "sensor_config" {
  source = "github.com/corelight/terraform-config-sensor"

  fleet_community_string                       = "<your Corelight Fleet community string>"
  sensor_license                               = "<your Corelight sensor license key>"
  sensor_management_interface_name             = "<the instance's management interface name>"
  sensor_monitoring_interface_name             = "<the instance's monitoring interface name>"
  sensor_health_check_probe_source_ranges_cidr = "<the cloud provider's health check source CIDR>"
  subnetwork_monitoring_cidr                   = "<the instance's monitoring subnetwork CIDR>"
  subnetwork_monitoring_gateway                = "<the instance's monitoring subnetwork gateway IP>"

  # Optional - Fleet Manager
  fleet_token = "b1cd099ff22ed8a41abc63929d1db126"
  fleet_url   = "https://fleet.example.com:1443/fleet/v1/internal/softsensor/websocket"

  # Optional - Enrichment Service
  enrichment_enabled             = "<if cloud enrichment should enabled at time of sensor deployment>"
  enrichment_cloud_provider_name = "<the cloud provider name>"
  enrichment_bucket_name         = "<the s3 bucket, azure storage container, or gcs bucket name>"

  # Optional - Enrichment Service Azure Only
  enrichment_storage_account_name = "<the azure storage account where enrichment data is stored>"

  # Optional - Enrichment Service AWS Only
  enrichment_bucket_region = "<the region for the s3 enrichment bucket>"
}

Deployment

The variables for this module all have default values that can be overwritten to meet your naming and compliance standards.

Deployment examples can be found here.

License

The project is licensed under the MIT license.