Tag Instances

Tags give information about an instance deployed through ElasticBox. They let you report on provider resources consumed by ElasticBox users. They inform what box, provider, user, workspace, and such from ElasticBox were involved in deploying an instance.

As an ElasticBox administrator, you get to apply 10 tags for your organization. From the admin console, once you can add preset or custom tags, they’re applied to the provider when a user launches an instance to any public or private cloud such as AWS, vSphere, Google Cloud, Azure, OpenStack, and CloudStack. They are applied on instances launched in Linux, Windows, CloudFormation, and RDS services.

You can use tags to report on usage metrics from the provider’s interface. Tags help you understand how ElasticBox resources are spread across your organization. Use them to identify usage patterns and optimize resources for your teams and users.

ElasticBox supports tagging in the Enterprise Edition for AWS, Google Cloud, OpenStack, CloudStack, and vSphere.

In the admin console, you can add tags under Providers > Tags.

In this article:

Preset or Custom Tags

A tag consists of a key and a value. You can tag with a custom or preset value.

Preset Tags
  • Custom. Enter any value that’s meaningful to categorize instances, like department name.
  • Preset. Choose from preset values such as box name, environment, and so on. Preset values give specific information about an instance. Choose a value from this table.
Preset Value Description
Box name Name of the box deployed.
Environment Environment name the user gave in the deployment profile when deploying the instance.
Instance ID ID assigned by ElasticBox, for example, i-extwmf.
Provider name Provider defined in ElasticBox to which the instance was deployed.
Service instance ID Unique ID for every machine created for the instance, for example eb-ek73d-1, eb-ek73d-2. Some instances like AWS S3 don’t generate machines. In these cases, the Service ID also serves as the Service Instance ID.
Service ID ID for the type of service deployed from the provider, for example eb-ek73d.
User email Email of the user who deployed the instance.
User ID A unique ID to identify the ElasticBox user.
Workspace ID Unique workspace ID where the instance was deployed.
Workspace name Name of the workspace the instance was deployed from.

Applying Tags for Your Organization

Only ElasticBox users in the administrator role can apply tags. Follow these steps to apply one.

Applying Tags

Steps

  1. Log in to ElasticBox.

  2. From the menu drop-down on the top right, select the Admin Console.

  3. Click Providers > Tags.

  4. Enter a key and value for the tag.
    • To enter a preset value, click the Custom Value drop-down to select one.
    • To enter a custom value, simply type in the Custom Value field.

    Note: The maximum length is 125 characters for the key and 250 characters for the value. Tags that contain unicode non-ASCII characters (ex: +=*&!@#) are ignored. Such tags are not applied to the instance in Google Cloud and OpenStack.

  5. When done, click (+) to add the tag.

Note: At this time, you can’t modify an existing tag, but you can remove and create another in its place. To remove a tag, go the admin console and under Providers > Tags, click (-) and the tick mark against it.

Reporting on ElasticBox Tags

One of the chief benefits of tagging is that you can report and analyze how ElasticBox resources are consumed throughout your organization. Currently, the reporting capabilities depend on what your cloud provider natively supports.

Refer to the following sections to view or manage the tags applied on a box instance launched in a specific cloud provider.

AWS

In addition to preset and custom tags, ElasticBox tags instances with CloudFormation labels. Tags currently don’t apply to S3, Elastic Block Store, and Virtual Private Cloud instances. To report on tagged instances deployed in AWS, see this article.

Steps

  1. Log in to the AWS console as your IAM user.

  2. Select the region where your instance is deployed.

  3. Click Services > EC2 > Instances.

  4. Select an instance and click the Tags tab to manage the applied tags.

    Managing Tags in AWS

Google Cloud

Steps

  1. Log in to the Google Cloud Console.

  2. Under projects, select the project where ElasticBox instances are deployed.

  3. Under Compute Engine, click VM instances and manage the tags applied under Custom metadata.

    Managing Tags in Google Cloud

OpenStack

Steps

  1. Log in to your OpenStack dashboard.

  2. Select the project to which ElasticBox instances are deployed.

  3. Under Instances, select the instance whose tags you want to view. The tags are listed under Meta.

    Managing Tags in OpenStack

vSphere

Steps

  1. Log in to your VMware vSphere thin client for vCenter 5.0 or later.

  2. Locate the virtual machine launched through ElasticBox in vSphere. Use the Service ID of the instance in ElasticBox to find it.

  3. Under Custom Fields, the tags applied to the instance are listed.

    Managing Tags in vSphere

CloudStack

Steps

  1. Log in to your CloudStack management console.

  2. Under Instances, select the instance launched through ElasticBox. Use its ElasticBox Service ID to find it.

  3. In the instance Details tab, scroll down to see the tags applied.

    Managing Tags in CloudStack