Enterprise Tag Standard

Standard
This HUIT standard presents a discussion and implementation guide for incorporating enterprise level meta-data on IT resources and infrastructure. Details of the tags can be found in the attached pdf document.
 
enterprise_tag_standard_2_5.pdf438 KB
Authors
  • Raoul Sevier (Enterprise Architecture)
  • Al Pacheco (Hosting)
Version 2.5
Last Revised 6-Jun-2023
Status Released
Document Type Single Topic Guidance
Audience Level
  • IT Director / Manager
  • Solution Architect and Project Manager
  • Application Developer and Designer
  • DevOps Staff
  • Senior IT Engineers
  1. Problem Statement

    Effective management of IT resources requires that various attributes describing the resources be available for cost allocation, cost optimization, reporting, compliance, and security purposes. These attributes must be consistently defined and available across organizational boundaries.

    The general concept of tagging resources applies to cloud and on-premise infrastructure in the server, network, storage and application domains. Cloud based computing environments offer standard tagging mechanisms, but nomenclatures and availability vary by vendor.

    The lack of a consistent set of enterprise level meta-data on IT resources across domains and organizational boundaries currently limits HUIT’s ability to address the above requirements.

  2. Recommendations

    • Define a limited set of tags to be ‘Enterprise’ in scope and specify the naming, meaning and allowed content of the tags
    • Identify a group with the responsibility to maintain and evolve the set of enterprise tags and approve exceptions as appropriate
    • Implement automated mapping or translation processes if needed to convert tags from existing domain systems to the enterprise specification
    • Require all HUIT teams to maintain accurate inventories of IT resources and their appropriate Enterprise tags, in the central Configuration Management Database (CMDB).
    • Encourage all HUIT IT teams to provide the CMDB with additional information about resources which may be deemed important, but without the constraint of consistent naming or value formats.
    • Inform Harvard School IT partners of HUIT’s enterprise tagging policies and processes and use the Cloud Community of Practice to begin an effort to align tagging efforts across the University.
    • Define and document how tags are being used. For example, reporting, backup, patching, configuration, etc. This will help us identify impact of changing a tag value or help us with governance decisions. For example, hosted_by tag was being used for backup and changing the value stopped backups on critical systems. Documenting tag usage will allow us to successfully govern tag usage and minimize unintentional impact.
    • Tag values should be defined as immutable or mutable. For example, environment is an example of a tag that should be mutable as it’s used by customers to identify application environments. An immutable tag example is data_class since it has a defined set of values that cannot be changed.
    • All tag names should follow the same standard whether enterprise or local.
    • All tag values should follow the same format e.g., all lower case, use of camel case, no white space, etc. to simplify usage by automation tools.
    • Tag names should start with domain where relevant to visually denote usage. Some existing examples include backup_policy and patching_policy
    • All enterprise tags that are identified as “M” (mandatory) should include values when that don’t apply to a resource. EG. “ad_domain” is listed as mandatory for AWS, Azure, and VMware but only has values of “fas” and “uni” but not all servers connect to Active Directory. A value of “na” is necessary.
  3. Discussion

    1. The Role of Tags in HUIT

      HUIT, like many IT organizations, is largely organized by IT technical domains. Platform and server teams manage compute resources, network organizations own and operate switches and access points, backup teams manage the resources necessary to store and protect data.

      Each organization’s management of the technologies under their purview is augmented by the use of meta data or tags which hold attribute information about the resources they manage. Examples of tag information include the environment (development, stage, production), owner, cost center as well as technical data.

      Many of the systems, although robust, expect users to conform to specific design and usage conventions limiting their cross-domain value. Differences in the implementation and design of these individual tagging systems currently limit their use in answering broad cross organization questions around usage, cost, dependencies and security. For example, the AWS platform team may use a tag named ‘Environment’ with a value of ‘Production’, while the Azure team may use a tag named ‘State’ with a value of ‘P-1’.

      When IT management review IT resources across different organizations and technical domains, they are faced with inconsistent tag usage. This presents itself both in the names of the tags used by different tools and organizations, as well as the allowed formats and values in those tags. These inconsistencies make aggregate reporting and analysis very difficult.

    2. Standardization of Selected Tags for Enterprise Use

      Requiring adherence to a single monolithic tagging nomenclature is inadvisable. Many of the existing individual systems have developed over time, provide specific domain functionality and cannot be easily changed. Much of the information about IT resources in a technical domain is important, if not essential, to the successful management of the resources by the operators of the domain. For example, AWS administrators need to know the configuration of elastic load-balancers, which style of RDS database is used by an application, and if the virtual server is used for production operation. These systems provide significant value and should continue to operate. Nevertheless, there is a clear need for a relatively small number of tags to be ‘Enterprise’ in scope, with consistent naming conventions, standard content and meaning.

      The primary tool for managing IT service-related data in an ITSM environment is the Configuration Management Data Base (CMDB). The existing ServiceNow based CMDB is the logical container for managing the meta-data held in enterprise level tags as well additional information about resources which may be deemed important but does not require consistent naming or value formats.

    3. Criteria for Enterprise Tags

      From an enterprise management perspective, the non-technical and/or operational attributes of a resource are often the focus of interest.

      Criteria for selecting Enterprise Tags may include:

      • Data necessary to understand
        • Usage
        • State
        • Ownership
        • Cost allocation
        • Service and Applications support by the resource
      • Attribute information that supports operational requirements such as backups and patching
      • Attribute information that describes and supports automated resource creation and management

      These criteria, and others, should be considered when determining the need for an Enterprise Tag. As a practical matter, this process will start organically and stabilize over time.

    4. Mapping of Enterprise Tags Within Resource Domains

      The names and values of tags within each existing resource domain may, or may not, currently conform to the naming of the attribute in the Enterprise CMDB, nor may the values align to the standard created for enterprise level tags.

      Whenever possible, existing tags nomenclatures should be aligned to the standard for enterprise level tags in order to minimize the number of variant names and values of the same attribute across different technical domains. However, as discussed above, this may not always be practical. In these cases, an automated translation or mapping process can be implemented in order to convert the existing local meta-data into the enterprise tag form and content.

    5. Propagation of Tag Information to the Enterprise CMDB

      Where enterprise management identifies attributes in local resource domains that must be propagated to the Enterprise CMDB, it is up to the organization owning the resource domain to craft a means of providing the required information.

      The HUIT organization has procured several tools, such as CloudAware and LogicMonitor, that do resource discovery by looking into platforms, such as AWS and VMWare, and identifying IT resources. This information is aggregated into the tool’s internal database. This is a convenient way of acquiring information about resources. Further these tools often have pre-built connectors that populate Configuration Management tools such as ServiceNow’s CMDB.

      When using tools such as these, it is up to the local resource domain team to ensure the Enterprise Tags and values conform to the Enterprise Tag standard as the information is moved to the CMDB.

      In other situations, there may not be an existing tool that can provide discovery or propagation to a CMDB. In these cases, custom procedures or code may be needed to provision the CMDB with the requisite information.

    6. Use of Automation for Effectiveness and Efficiency

      A central goal of the Enterprise Tag Standard process is the use of automation to the greatest degree possible.

      In principle, tagging of IT resources should take place at the time the resource is created. In the case of resources that are created by Ansible Tower or by SCCM, the scripts used to create the resources should contain the directives that create the tags in the appropriate platforms. For example, an Ansible script to create an AWS virtual machine should also create the tags that identify the server as a production machine using the correct Enterprise Tag name and value.

      Where automated resource management is not available, in principle the tag names and values should be defined as early in the life-cycle as possible, and only once.

    7. Mandatory vs. Optional Enterprise Tags

      Given the great variety of resource domains, it is a given that not all IT resources will be able to support all Enterprise Tags.

      It is up to the organization managing the local resource domain and the team responsible for enterprise tag management to agree which tags will be required for each domain. Once agreed, then the resource domain must provide the agreed tag information in the standard name with standard values.

    8. Tagging Practices at Harvard

      While initially scoped to the HUIT organizations, HUIT routinely manages IT resources belonging to Schools and other organizations. As a practical matter, any IT resources that fall under the management of HUIT organizations must conform to the tagging standard. As HUIT interacts with Schools and other organizations, they must inform them of this approach and take steps to ensure that School and other organization resource information makes its way to the Enterprise CMDB.

      The Cloud Community of Practice can be used as an initial vehicle for discussion of and alignment of enterprise tags with HUIT’s University partners.

  4. Updates, Exceptions, and Waivers

    IT environments undergo continuous change. As a practical matter, it is important to manage that changes with as much automation as possible to maximize both effectiveness and efficiency of IT operations. This means updating the standards as the mix of resources change. Just as important as knowing what a resource should be tagged, is a sense of where exceptions are important, and an inventory of waivers to the standards with the reasons the waivers were given.

    1. Updates to these Standards

      The responsibility for tasks related to maintaining and updating enterprise tags should be clearly defined. Should the scope of change be large enough, an additional round of peer and management review may be required. This material and updates will be cross-published on the EA web site and in the HUIT TPS Confluence wiki site.

    2. Waivers and Exceptions from these Standards

      There may be some circumstances where standards have not yet been defined for a class of resource. Under these circumstances a waiver for that class can be allowed, as long as there is management concurrence. This becomes the basis for updating the standards document. The responsible organization must keep a log of waivers.

      In the event there is an applicable name or tag standard for a resource, but there are compelling reasons to deviate from them, exceptions may be granted. Under these circumstances, the responsible organization must grant the exception in writing. The responsible organization must keep a log of exceptions.

  5. Standard Enterprise Tag Names

    The list of Standard Enterprise Tags identified in this document represents that essential set of information that management needs to conduct cross-organizational and cross-technical domain management. Also, since not all tags are relevant to all technology domains, this section sets out the mandatory and optional tag usage per technology domain.

    Details of the tags can be found in the attached pdf document.

  6. Enteprise Tags Pending Implementation

    The promotion of local domain tags to Enterprise level is a living process that reflects changes in configurations, technologies, and processes. This section addresses tags that are needed, but have not been fully defined, ratified, or implemented. During routine review cycles of the use of tags, some of these will be promoted to the Enterprise Tag list, while others may continue to evolve, or be deprecated.

    Details of the tags can be found in the attached pdf document.

  7. Deprecated Enterprise Tags

    Details of the tags that have been removed from the Enterprise tag list can be found in the attached pdf document.

  8. References

a54d3b3f70a15a25e8eef64048e10d7f