CloudBolt supports managing AWS, VMware (v6.5+), and Azure (Resource Manager) tags on your servers by linking them to CloudBolt server attributes. When the value of the CloudBolt attribute changes on the server, so will the value of the tag.
How to Use Tags¶
An example use-case is to manage AWS cost center tags. Say you want servers provisioned by your Dev group to have the Cost Center tag set to 1. Here are the steps to make that happen:
- Create a new Cost Center parameter in the Admin interface. Make sure to select “Show on servers” to make the parameter taggable, and select “Required” if you want to hide it on the order form.
- Add the parameter to the Dev group, and add 1 as the sole option.
- Under the Tags tab of the resource handler, add a new tag, Enter Cost Center as the Tag Name, and select cost_center as the attribute.
Now whenever the Dev group provisions a server, the Cost Center parameter and tag will both be set to 1.
Tags are created on the server at provision time, but they can also be updated on servers at any time. If you edit a parameter on a server in CloudBolt, it will automatically write the new value to the linked tag.
Likewise, changes to tags in the Resource Handler can be detected by CloudBolt. When you run the Refresh Info server action on a server, CloudBolt will not only update the “Tags” section of the server, but also the “Parameters” section for any parameters that are linked to tags.
Syncing from remote tags is only enabled out-of-the-box for Parameters, not built-in server attributes like owner, environment, or group.
You can enable bidirectional syncing on group and owner tags by choosing ‘Bidirectional’ under the ‘Syncing’ column on the Resource Handler’s ‘Tags’ table.
For VMware, CloudBolt will treat all tags as if they have single cardinality, meaning there can be only one tag value per category per VM. If you make a category in VMware that supports multiple tags, only one of those tag’s values will show on the server in CB. Also, it’s important to be aware that if you were to change the value of the parameter associated with that tag in CB, all the other values would be removed from that VM.
Viewing and Editing Tags¶
Tags that are created on a server in CloudBolt will be viewable from the Overview tab of the server’s details page, under the tech-specific details pane. For example, the pane would be labelled Azure Details for an Azure server in CloudBolt.
For tags associated with parameters, the values will be viewable and editable from the Parameters tab of the server’s detail page. To change the value of a tag, click on the pencil icon in the Value column for the associated parameter. When the value is saved, a parameter change hook is triggered to update the value of the tag in the associated cloud, i.e. VMWare, Azure, or AWS. A dialog will then pop up to indicate that the change was successful.
Automated Spelling Corrections¶
CloudBolt provides the ability to automate spelling corrections for tag values that will be applied whenever tags are synced in or out of CloudBolt.
Admins can specify mappings between misspelled tag values and the correct spelling on the resource handler. For example, an admin can specify that the misspelled value ‘poduction’ should be corrected to ‘production’. Then, if CloudBolt discovers a VM with that tag value, it will correct the value to ‘production’.
To set a spelling correction, go to the resource handler’s Tags tab, then click Add Tag Spelling Correction. Specify the correct value and the misspelled value. Then, your spelling correction will be applied anytime you provision with tags, discover a VM (via sync VMS), refresh info on a server, or edit the tag values on a server in CloudBolt. If you’d like to apply corrections right away, we recommend running sync VMS from the resource handler’s Servers tab.
Tags During Azure Server Provisioning¶
In order to help you take advantage of Azure’s Policy Service If there are tags specified for a server you are provisioning to Azure, CloudBolt will assign all of those tags to each Azure resource CloudBolt creates during the provisioning step (not afterwards). CloudBolt may or may not create a given resource depending on the details of your provision job, but may create and tag some combination of the following:
- Virtual Machine
- Network Interface “Card” (NIC)
- Initial OS disk
- Zero or more additional disks
- Availability Set
- Resource Group
- Storage Account
- Public IP