Buttonwood VSCode Extension for Tags

Tags are an important metadata component of cloud resources to aid in their visibility and operations.

Buttonwood is a compliance and assurance platform built for Governance teams to manage their cloud environments. The Buttonwood VSCode Extension for Tags allows organisations to centralise their tag dictionary and for developers to include expected and correct organisation tags for the resources they deploy.

Features

• Supports and detects multiple IaaS scripting languages (JSON, YAML, Bicep, ARM, Terraform)
• Insert Tag Profiles - a collection of tags and their values/types
• Insert Tag Names
• Insert Tag Values
• Tag definitions - limit tags from a controlled vocabulary or allow free text

Requirements

• Buttonwood Tenant with defined tag profiles
• Buttonwood API Token

Extension Settings

This extension contributes the following settings:

• buttonwood.apiUrl: Should not need to change from default (https://exchange.bcx.buttonwood.net)

The extension creates a number of default keyboard shortcuts with the buttonwood.* prefix. These can be changed under File > Preferences > Keyboard Shortcuts.

Getting Started

Generate your API Token

1. Log in to Buttonwood Central New tenant sign-ups are available at: https://central.bcx.buttonwood.net/trial

2. From your user icon in the top-right, select My Details

3. Navigate to the API Tokens tab

4. Click Add

5. Create an API token with a suitable expiry period

6. Note the generated token, it will not be available for retrieval after closing the dialog

Create Tag Definitions

1. Log in to Buttonwood Central
2. Navigate to Govern > Tag Definitions
3. Add your tag definitions
4. If the selected Value Type for the tag is Controlled Vocabulary, edit the saved definition to add the allowed values

Create Tag Profiles

1. Log in to Buttonwood Central
2. Navigate to Govern > Tag Profiles
3. Add your tag profiles
4. Edit the saved profile to associate tag definitions to the profile

Add your API Token to the VSCode Extension

1. Open VSCode where the extension is installed
2. Open the API Token input box (Ctrl + T, Ctrl + A)
3. Enter your generated API Token
4. Refresh the tag definitions and profiles from Buttonwood Central (Ctrl + T, Ctrl + F)

Using the Extension

• Add tag profiles using IntelliSense by typing tag
• Add tag profiles with Ctrl T + Ctrl P
• Add tag values with Ctrl T + Ctrl V
• Different formats may be suggested depending on the file type