Our next-gen architecture is built to help you make sense of your ever-growing data Watch a 4-min demo video!

Back to All Docs

Cloud Security Posture Management (CSPM) – GCP Cloud Security Posture Management (CSPM) – GCP

Last Updated: Jan. 18, 2023

Security Posture Management (CSPM) helps to mitigate and minimize cloud data security breaches and to assess the overall posture of the entire cloud environment against best practices and compliance standards to help remediate issues.

CSPM tools verify that cloud configurations follow security best practices and compliance standards such as CIS, Azure, and GCP benchmarks as well as PCI and HIPAA frameworks. As companies are increasingly moving to the cloud, CSPM is becoming a necessary aspect of security insights.

The CSPM can be installed using a Docker container

Coralogix GRPC endpoints

Irelandng-api-grpc.coralogix.com
Stockholmng-api-grpc.eu2.coralogix.com
Singaporeng-api-grpc.coralogixsg.com
Mumbaing-api-grpc.app.coralogix.in
United Statesng-api-grpc.coralogix.us

For each installation method, we need to pass the following environment variables:

API_KEYUnder “Send your data” on your Coralogix account
APPLICATION_NAMESet the application name
SUBSYSTEM_NAMESet the subsystem name
COMPANY_IDThe company ID from the settings screen in your Coralogix account
CORALOGIX_ENDPOINT_HOSTCoralogix GRPC endpoint
CLOUD_PROVIDERThe Cloud Provider that CSPM will be deployed into in lowercase (e.g. aws, gcp, etc)
TESTER_LISTIf specified, will run the tests on the specified service, otherwise will run tests on all the GCP services. leave empty to run all testers, otherwise, comma separated per tester name without spaces
REGION_LISTIf specified, will check only the specified regions (For global services like IAM and DNS, make sure you add region “global”). Otherwise, the tests will be conducted in all regions. leave empty to run on all regions, otherwise, comma separated per region name without spaces
GOOGLE_APPLICATION_CREDENTIALSPath to credentials file inside the container
CORALOGIX_ALERT_API_KEY(Optional parameter) Under “Alerts, Rules and Tags API Key” on your Coralogix account.
When providing this variable, a custom enrichment for failed resources will be created in Coralogix’s account at the end of each run if specified

Installing as a Docker container

Prerequisites

  1. Verify the following APIs are enabled on the project before running
    • Cloud Resource Manager API
    • API Keys API
    • Cloud SQL Admin API
    • Compute Engine API
    • Cloud Key Management Service (KMS) API
    • BigQuery API
    • Kubernetes Engine API
  2. Create a Role with the following permissions (IAM & Admin > Roles)
    • If you have access to use gcloud command and wish to automate the role creation process, download the following file
    • Now run the command gcloud iam roles create test_coralogix_role1 –project –file=/path/to/yaml.yml
  3. Create a service account and attach the previously created role (IAM & Admin > Service Accounts)
  4. Create VM Instance
    • Attach the service account (3) to the instance
    • E2-small is sufficient
    • Internet connectivity
  5. Docker installed on the VM instance – refer to Docker documentation

Note that the instance type will affect the run time, so it’s up to a personal preference and is affected by the environment size.

Deploying

After prerequisites are met, download the docker image using the following command (if the following command hasn’t run, the image will still be downloaded automatically in the next step):

docker pull coralogixrepo/snowbit-cspm

In order to automate the process, use Crontab in the following manner:

Create the crontab using your favorite editor

sudo crontab -e

Inside the document, on the bottom, paste the following one-liner (note that the API_KEY and the CORALOGIX_ENDPOINT_HOST fields are mandatory)

0 0 * * *  docker rm snowbit-cspm ; docker rmi coralogixrepo/snowbit-cspm:latest ; docker run --name snowbit-cspm -d -e PYTHONUNBUFFERED=1 -e CLOUD_PROVIDER="gcp" -e COMPANY_ID=<coralogix_company_ID> -e CORALOGIX_ENDPOINT_HOST="coralogix_grpc_endpoint" -e APPLICATION_NAME="application_name" -e SUBSYSTEM_NAME="subsystem_name" -e TESTER_LIST="" -e API_KEY="send_your_data_api_key" -e REGION_LIST="" -e GOOGLE_APPLICATION_CREDENTIALS="path_to_credentials_file_in_the_container" -v <local_folder_that_contains_gcp_credentials>:<location_to_map_the_credentials_inside_the_container> coralogixrepo/snowbit-cspm

The above command will run once a day, every day at 00:00, and consists of two commands:

  • docker rm snowbit-cspm – removes the last docker container if exists
  • docker run –name snowbit-cspm [Options…] – runs a new container sequence

On this page