corelight/sensor-enrichment-gcp repository overview

⁠GCP Cloud Enrichment

Corelight's GCP Cloud Enrichment requires the deployment of a Cloud Run service and its supporting infrastructure to ensure the data in your Corelight cloud sensors are always up-to-date with the latest state of your cloud resources. This image is responsible for collecting cloud resource data and processing asset state change events.

This image should be deployed via the terraform-gcp-enrichment⁠ terraform module.

⁠Configuration (Environment Variables)

ROOT_FOLDER_ID
The ID of the folder the Cloud Run service will collect cloud resource data

BUCKET_NAME
The name of the GCS bucket where cloud enrichment data will be stored

PREFIX
Default: corelight

The prefix prepended to each object. Must be set to a value and not contain a forward slash "/"

REGIONS
Default:

"asia-east1", "asia-east2","asia-northeast1","asia-northeast2","asia-northeast3","asia-south1",
"asia-south2","asia-southeast1","asia-southeast2","australia-southeast1","australia-southeast2",
"europe-central2","europe-north1","europe-southwest1","europe-west1","europe-west2","europe-west3",
"europe-west4","europe-west6","europe-west8","europe-west9","europe-west10","europe-west12",
"me-central1","me-central2","me-west1","northamerica-northeast1","northamerica-northeast2",
"southamerica-east1","southamerica-west1", "us-central1", "us-east1", "us-east4", "us-east5", 
"us-south1", "us-west1", "us-west2", "us-west3", "us-west4",

The GCP regions the Cloud Run service should collect cloud resource data in. Pare down the list to only regions you utilize.

LOG_LEVEL
Default: info

Set to debug while testing or troubleshooting for additional logging

⁠License

The MIT License (MIT)

Copyright (c) 2024 Corelight, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.