Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nordcloud/azure-tag-manager
Azure Tag Manager, enforce tags at scale.
https://github.com/nordcloud/azure-tag-manager
azure azure-resource-manager azure-resources azure-tags-remediation
Last synced: 2 months ago
JSON representation
Azure Tag Manager, enforce tags at scale.
- Host: GitHub
- URL: https://github.com/nordcloud/azure-tag-manager
- Owner: nordcloud
- License: mit
- Created: 2019-07-21T08:40:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-05T15:57:33.000Z (over 1 year ago)
- Last Synced: 2024-06-19T03:08:21.249Z (7 months ago)
- Topics: azure, azure-resource-manager, azure-resources, azure-tags-remediation
- Language: Go
- Homepage: https://medium.com/nordcloud-engineering
- Size: 146 KB
- Stars: 20
- Watchers: 12
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://dev.azure.com/dariuszdwornikowski0297/azure-tag-manager/_build/latest?definitionId=1&branchName=master)
[](https://goreportcard.com/report/github.com/nordcloud/azure-tag-manager)
# Azure Tag manager
Tag manager is used to add or change tags on Azure resources on a massive scale. The tags are applied only when given rules are satisfied, for example prior existance of a certain tag, or the lack of it.
## Download
You can download a binary for your architecture from the releases page.
## Usage
To use it you need to create Azure service principal. Create service principal file:
```bash
az ad sp create-for-rbac --sdk-auth > my.auth
```
and export path to the authorizer:
```bash
export AZURE_AUTH_LOCATION=my.auth
```
`beta`: Using cli authorizer is in works.
## How it works ?
Azure Tag Manager needs a file with rules, each rule consists of conditions and actions. Given all the conditions, all actions are executed. The rules file can be supplied either in json or yaml.
```json
{
"dryrun": true,
"rules": [
{
"name": "Tag me stuff",
"conditions": [
{"type": "tagEqual", "tag": "myTag", "value" : "example"},
{"type": "tagExists", "tag": "myTagWhichExists"},
{"type": "tagNotExists", "tag": "env"}
],
"actions": [
{"type": "addTag", "tag": "newTag", "value": "value" },
{"type": "addTag", "tag": "newTag2", "value": "value2" }
]
}
]
}
```
Equivalent of the same file in YAML would look like:
```YAML
---
dryrun: true
rules:
- name: Tag me this
conditions:
- type: tagEqual
tag: myTag
value: example
- type: tagExists
tag: myTagWhichExists
- type: tagNotExists
tag: env
- type: regionEqual
region: westeurope
- type: rgEqual
resourceGroup: exampleRg
actions:
- type: addTag
tag: newTag
value: newValue
- type: addTag
tag: newTag2
value: someValue
```
The following types of conditions are accepted:
* `noTags` - checks if there are no tags set
* `tagEqual` - checks if a `tag` has a `value` set
* `tagNotEqual` - checks if a `tag` has a value set different than `value`
* `tagExists` - checks if a tag with key `tag` exists
* `tagNotExists` - same as above but negative
* `regionEqual` - checks if resource is in key `region` (aka location in azure)
* `regionNotEqual` - same as above but negative
* `rgEqual` - match resource group in a key `resourceGroup`
* `rgNotEqual` - match not resource group
* `resEqual` - resource name equals `resource`
The supported actions are:
* `addTag` - adds a tag with key `tag` and value `value`
* `delTag` - deletes a tag with key `tag`
When rewriting, the tool will first do a backup of old tags. It will be saved in a file in the current (run) directory.
## Running
Tagmanager accepts commands and flags: `tagmanager COMMAND [FLAGS`].
```
Usage:
tagmanager [command]
Available Commands:
check Do sanity checks on a resource group (NOT FULLY IMPLEMENTED YET)
help Help about any command
restore Restore previous tags from a file backup
retagrg Retag resources in a rg based on tags on rgs
rewrite Rewrite tags based on rules from a file
Flags:
-h, --help help for tagmanager
-v, --verbose verbose output
```
Commands:
* `rewrite` - mode where tagmanager will retag the resources based on mapping given in a mapping file input (specified with `-m filepath` flag). If `--dry` flag is given, the tagging actions will not be executed
* `restore` - restores tags backed up in a file, supplied by `-f filepath` flag
* `check` - (EXPERIMENTAL) does some basic sanity checks on the resource group given as `--rg` flag
* `retagrg` - Takes tags form a given resource group (`--rg`) and applies them to all of the resources in the resource group. If any existing tags are already there, the new ones with be appended. Adding `--cleantags` will clean ALL the tags on resources before adding new ones.
## Todo
* Azure ARM policy setting
* AWS support for EC2
## Licence
MIT licence.
Author(s): Dariusz Dwornikowski (@tdi)
Made by Nordcloud in Poznań with ♥.