GCP Labels Mod

Run label controls across all your GCP projects to look for unlabeled resources, missing labels , resources with too many labels, and more.

References

GCP provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

Steampipe Mods are collections of named queries, and codified controls that can be used to test current configuration of your cloud resources against a desired configuration.

Documentation

Benchmarks and controls →

Getting started

Installation

Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install steampipe

Install the GCP plugin with Steampipe:

steampipe plugin install gcp

Clone:

git clone https://github.com/turbot/steampipe-mod-gcp-labels.git
cd steampipe-mod-gcp-labels

Usage

Start your dashboard server to get started:

steampipe dashboard

By default, the dashboard interface will then be launched in a new browser window at https://localhost:9194. From here, you can run benchmarks by selecting one or searching for a specific one.

Instead of running benchmarks in a dashboard, you can also run them within your terminal with the steampipe check command:

Run all benchmarks:

steampipe check all

Run a single benchmark:

steampipe check benchmark.unlabeled

Run a specific control:

steampipe check control.storage_bucket_unlabeled

Different output formats are also available, for more information please see Output Formats.

Credentials

This mod uses the credentials configured in the Steampipe GCP plugin.

Configuration

Several benchmarks have input variables that can be configured to better match your environment and requirements. Each variable has a default defined in its source file, e.g., controls/limit.sp, but these can be overriden in several ways:

Copy and rename the steampipe.spvars.example file to steampipe.spvars, and then modify the variable values inside that file

Pass in a value on the command line:

steampipe check benchmark.mandatory --var 'mandatory_labels=["application", "environment", "department", "owner"]'

Set an environment variable:
```
SP_VAR_mandatory_labels='["application", "environment", "department", "owner"]' steampipe check control.compute_instance_mandatory
```
- Note: When using environment variables, if the variable is defined in steampipe.spvars or passed in through the command line, either of those will take precedence over the environment variable value. For more information on variable definition precedence, please see the link below.

These are only some of the ways you can set variables. For a full list, please see Passing Input Variables.

Advanced usage

Remediation

Using the control output and the gcloud CLI, you can remediate various label issues.

For instance, with the results of the compute_instance_mandatory control, you can add missing labels with the gcloud CLI:

#!/bin/bash

OLDIFS=$IFS
IFS='#'

INPUT=$(steampipe check control.compute_instance_mandatory --var 'mandatory_labels=["application"]' --output csv --header=false --separator '#' | grep 'alarm')
[ -z "$INPUT" ] && { echo "No instances in alarm, aborting"; exit 0; }

while read -r group_id title description control_id control_title control_description reason resource status location project
do
  # Get the instance name from the self-link, e.g., https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance
  instance_name=$(echo "$resource" | rev | cut -d "/" -f1 | rev)
  gcloud compute instances add-labels "$instance_name" --labels=application=my_application --zone=${location}
done <<< "$INPUT"

IFS=$OLDIFS

To remove prohibited labels from Compute instances:

#!/bin/bash

OLDIFS=$IFS
IFS='#'

INPUT=$(steampipe check control.compute_instance_mandatory --var 'prohibited_labels=["password"]' --output csv --header=false --separator '#' | grep 'alarm')
[ -z "$INPUT" ] && { echo "No instances in alarm, aborting"; exit 0; }

while read -r group_id title description control_id control_title control_description reason resource status location project
do
  # Get the instance name from the self-link, e.g., https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance
  instance_name=$(echo "$resource" | rev | cut -d "/" -f1 | rev)
  gcloud compute instances remove-labels ${instance_name} --labels=password --zone=${location}
done <<< "$INPUT"

IFS=$OLDIFS

Contributing

If you have an idea for additional controls or just want to help maintain and extend this mod (or others) we would love you to join the community and start contributing.

Join our Slack community → and hang out with other Mod developers.

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

Want to help but not sure where to start? Pick up one of the help wanted issues:

turbot/gcp_labels