Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/turbot/steampipe-mod-aws-tags

Is your AWS tagging strategy following best practice? This mod checks if your AWS resource tags are set correctly to help you manage them effectively using Powerpipe and Steampipe.
https://github.com/turbot/steampipe-mod-aws-tags

aws aws-tags hacktoberfest powerpipe powerpipe-mod sql steampipe steampipe-mod tagging tags

Last synced: about 2 months ago
JSON representation

Is your AWS tagging strategy following best practice? This mod checks if your AWS resource tags are set correctly to help you manage them effectively using Powerpipe and Steampipe.

Awesome Lists containing this project

README 

        
# AWS Tags Mod for Powerpipe



> [!IMPORTANT]  

> [Powerpipe](https://powerpipe.io) is now the preferred way to run this mod! [Migrating from Steampipe →](https://powerpipe.io/blog/migrating-from-steampipe)

>

> All v0.x versions of this mod will work in both Steampipe and Powerpipe, but v1.0.0 onwards will be in Powerpipe format only.



An AWS tags checking tool that can be used to look for untagged resources, missing tags, resources with too many tags, and more.



Run checks in a dashboard:



![image](https://raw.githubusercontent.com/turbot/steampipe-mod-aws-tags/main/docs/aws_tags_dashboard.png)



Or in a terminal:



![image](https://raw.githubusercontent.com/turbot/steampipe-mod-aws-tags/main/docs/aws_tags_mod_terminal.png)



## Documentation



- **[Benchmarks and controls →](https://hub.powerpipe.io/mods/turbot/aws_tags/controls)**



## Getting Started



### Installation



Install Powerpipe (https://powerpipe.io/downloads), or use Brew:



```sh

brew install turbot/tap/powerpipe

```



This mod also requires [Steampipe](https://steampipe.io) with the [AWS plugin](https://hub.steampipe.io/plugins/turbot/aws) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:



```sh

brew install turbot/tap/steampipe

steampipe plugin install aws

```



Steampipe will automatically use your default AWS credentials. Optionally, you can [setup multiple accounts](https://hub.steampipe.io/plugins/turbot/aws#multi-account-connections) or [customize AWS credentials](https://hub.steampipe.io/plugins/turbot/aws#configuring-aws-credentials).



Finally, install the mod:



```sh

mkdir dashboards

cd dashboards

powerpipe mod init

powerpipe mod install github.com/turbot/steampipe-mod-aws-tags

```



### Browsing Dashboards



Start Steampipe as the data source:



```sh

steampipe service start

```



Start the dashboard server:



```sh

powerpipe server

```



Browse and view your dashboards at **http://localhost:9033**.



### Running Checks in Your Terminal



Instead of running benchmarks in a dashboard, you can also run them within your

terminal with the `powerpipe benchmark` command:



List available benchmarks:



```sh

powerpipe benchmark list

```



Run a benchmark:



```sh

powerpipe benchmark run aws_tags.benchmark.untagged

```



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

[Output Formats](https://powerpipe.io/docs/reference/cli/benchmark#output-formats).



### Configure Variables



Several benchmarks have [input variables](https://powerpipe.io/docs/build/mod-variables#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 overwritten in several ways:



It's easiest to setup your vars file, starting with the sample:



```sh

cp steampipe.spvars.example steampipe.spvars

vi steampipe.spvars

```



Alternatively you can pass variables on the command line:



```sh

powerpipe benchmark run aws_tags.benchmark.mandatory --var 'mandatory_tags=["Application", "Environment", "Department", "Owner"]'

```



Or through environment variables:



```sh

export PP_VAR_mandatory_tags='["Application", "Environment", "Department", "Owner"]'

powerpipe control run aws_tags.control.ec2_instance_mandatory

```



These are only some of the ways you can set variables. For a full list, please see [Passing Input Variables](https://powerpipe.io/docs/build/mod-variables#passing-input-variables).



### Common and Tag Dimensions



The benchmark queries use common properties (like `account_id`, `connection_name` and `region`) and tags that are defined in the form of a default list of strings in the `variables.sp` file. These properties can be overwritten in several ways:



It's easiest to setup your vars file, starting with the sample:



```sh

cp steampipe.spvars.example steampipe.spvars

vi steampipe.spvars

```



Alternatively you can pass variables on the command line:



```sh

powerpipe benchmark run aws_tags.benchmark.limit --var 'tag_dimensions=["Environment", "Owner"]'

```



Or through environment variables:



```sh

export PP_VAR_common_dimensions='["account_id", "connection_name", "region"]'

export PP_VAR_tag_dimensions='["Environment", "Owner"]'

powerpipe benchmark run aws_tags.benchmark.limit

```



### Remediation



Using the control output and the AWS CLI, you can remediate various tagging issues.



For instance, with the results of the `ec2_instance_mandatory` control, you can add missing tags with the AWS CLI:



```sh

#!/bin/bash



OLDIFS=$IFS

IFS='#'



INPUT=$(powerpipe control run aws_tags.control.ec2_instance_mandatory --var 'mandatory_tags=["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 account_id region

do

  aws resourcegroupstaggingapi tag-resources --region ${region} --resource-arn-list ${resource} --tags Application=MyApplication

done <<< "$INPUT"



IFS=$OLDIFS

```



To remove prohibited tags from EC2 instances:



```sh

#!/bin/bash



OLDIFS=$IFS

IFS='#'



INPUT=$(powerpipe control run aws_tags.control.ec2_instance_prohibited --var 'prohibited_tags=["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 account_id region

do

  aws resourcegroupstaggingapi untag-resources --region ${region} --resource-arn-list ${resource} --tag-keys Password

done <<< "$INPUT"



IFS=$OLDIFS

```



## Open Source & Contributing



This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!



[Steampipe](https://steampipe.io) and [Powerpipe](https://powerpipe.io) are products produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).



## Get Involved



**[Join #powerpipe on Slack →](https://turbot.com/community/join)**



Want to help but don't know where to start? Pick up one of the `help wanted` issues:



- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)

- [AWS Tags Mod](https://github.com/turbot/steampipe-mod-aws-tags/labels/help%20wanted)