A utility to tag AWS EBS volumes based on the PVC's aws-ebs-tagger/tags annotation

The k8s-aws-ebs-tagger watches for new PersistentVolumeClaims and when new AWS EBS volumes are created it adds tags based on the PVC's aws-ebs-tagger/tags annotation to the created EBS volume.

--default-tags - A json or csv encoded key/value map of the tags to set by default on EBS Volumes. Values can be overwritten by the aws-ebs-tagger/tags annotation.

--tag-format - Either json or csv for the format the aws-ebs-tagger/tags and --default-tags are in.

aws-ebs-tagger/ignore - When this annotation is set (any value) it will ignore this PVC and not add any tags to it

aws-ebs-tagger/tags - A json encoded key/value map of the tags to set on the EBS Volume (in addition to the --default-tags). It can also be used to override the values set in the --default-tags

1. The cmdline arg --default-tags={"me": "touge"} and no annotation will set the tag me=touge

2. The cmdline arg --default-tags={"me": "touge"} and the annotation aws-ebs-tagger/tags: | {"me": "someone else", "another tag": "some value"} will create the tags me=someone else and another tag=some value on the EBS Volume

3. The cmdline arg --default-tags={"me": "touge"} and the annotation aws-ebs-tagger/ignore: "" will not set any tags on the EBS Volume

4. The cmdline arg --default-tags={"me": "touge"} and the annotation aws-ebs-tagger/tags: | {"cost-center": "abc", "environment": "prod"} will create the tags me=touge, cost-center=abc and environment=prod on the EBS Volume

The following tags are ignored

• kubernetes.io/*
• KubernetesCluster
• Name

You need to create an AWS IAM Role that can be used by k8s-aws-ebs-tagger. I recommend using a tool like kube2iam instead of using an AWS access key/secret. An example policy is in examples/iam-role.json.

helm repo add mtougeron https://mtougeron.github.io/helm-charts/
helm repo update
helm install k8s-aws-ebs-tagger mtougeron/k8s-aws-ebs-tagger

Images are available on the GitHub Container Registry and DockerHub. Containers are published for linux/amd64 & linux/arm64.

This project is licensed under the Apache V2 License. See LICENSE for more information.