In this article:
- Preset or Custom Tags
- Applying Tags for Your Organization
- Reporting on Cloud Application Manager Tags
- Reporting on AWS
- Reporting on Google Cloud
- Reporting on OpenStack
- Reporting on vSphere
- Reporting on CloudStack
- Contacting Cloud Application Manager Support
Tags give information about an instance deployed through Cloud Application Manager. They let you report on provider resources consumed by Cloud Application Manager users. They inform what box, provider, user, workspace, and such from Cloud Application Manager were involved in deploying an instance.
As an Cloud Application Manager administrator, you get to apply 10 tags for your organization. From the Settings, 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 Cloud Application Manager resources are spread across your organization. Use them to identify usage patterns and optimize resources for your teams and users.
Cloud Application Manager supports tagging in the Enterprise Edition (SaaS & Virtual Appliance) for AWS, Google Cloud, OpenStack, CloudStack, and vSphere.
In the Settings for your organization, you can add tags under Settings > Tags.
All users with Cloud Application Manager organization administrator access.
Access to Cloud Application Manager, Management site.
The user must be an Administrator of the organization in Cloud Application Manager.
The user should be at the organization level scope to access the Settings option in the left side menu.
Preset or Custom Tags
A tag consists of a key and a value. You can tag with a custom or preset value.
- 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.
|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 Cloud Application Manager, for example, i-extwmf.|
|Provider name||Provider defined in Cloud Application Manager 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.|
|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 Cloud Application Manager 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 Cloud Application Manager users in the administrator role can apply tags. Follow these steps to apply one.
From the menu drop-down on the top right, select Organizations > Your Org Name
Click Settings and scroll to the Tags section.
Click Add and 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.
When done, click Save 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 Settings and under Tags, click (x) and the tick mark against it.
Reporting on Cloud Application Manager Tags
One of the chief benefits of tagging is that you can report and analyze how Cloud Application Manager 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.
Reporting on AWS
In addition to preset and custom tags, Cloud Application Manager tags instances with CloudFormation labels. Tags currently don’t apply to Elastic Block Store, and Virtual Private Cloud instances. To report on tagged instances deployed in AWS, see this article.
Log in to the AWS console as your IAM user.
Select the region where your instance is deployed.
Click Services > EC2 > Instances.
Select an instance and click the Tags tab to manage the applied tags.
Reporting on Google Cloud
Under projects, select the project where Cloud Application Manager instances are deployed.
Under Compute Engine, click VM instances and manage the tags applied under Custom metadata.
Reporting on OpenStack
Log in to your OpenStack dashboard.
Select the project to which Cloud Application Manager instances are deployed.
Under Instances, select the instance whose tags you want to view. The tags are listed under Meta.
Reporting on vSphere
Log in to your VMware vSphere thin client for vCenter 5.0 or later.
Locate the virtual machine launched through Cloud Application Manager in vSphere. Use the Service ID of the instance in Cloud Application Manager to find it.
Under Custom Fields, the tags applied to the instance are listed.
Reporting on CloudStack
Log in to your CloudStack management console.
Under Instances, select the instance launched through Cloud Application Manager. Use its Cloud Application Manager Service ID to find it.
In the instance Details tab, scroll down to see the tags applied.
Contacting Cloud Application Manager Support
For issues related to API calls, send the request body along with details related to the issue.
In the case of a box error, share the box in the workspace that your organization and Cloud Application Manager can access and attach the logs.
- Linux: SSH and locate the log at /var/log/elasticbox/elasticbox-agent.log
- Windows: RDP into the instance to locate the log at ProgramDataElasticBoxLogselasticbox-agent.log