AWS CodeDeploy Deployment pattern-based discovery
Summarize
Summary of AWS CodeDeploy Deployment pattern-based discovery
The AWS CodeDeploy Deployment pattern-based discovery enables ServiceNow customers to identify and map AWS CodeDeploy deployments within their cloud environments. This capability is part of the Discovery and Service Mapping Patterns application, which requires specific prerequisites and configuration steps to function effectively.
Show less
Key Features
- Prerequisites and Setup: Customers must verify AWS discovery prerequisites and ensure that CodeDeploy resources are not on the Resource Inclusion List to prevent duplicate discoveries.
- Pattern Activation: The AWS CodeDeploy Deployment discovery pattern is disabled by default and must be enabled by the user. Pattern activation status is preserved across application upgrades without being treated as a customization.
- Data Population: The discovery process populates data into both CMDB and non-CMDB tables when running the Amazon AWS - CodeDeploy Deployment - Extended Inventory (LP) pattern. Non-CMDB data can be reviewed under the AWS configuration section in the ServiceNow interface.
- CMDB Tables and Fields: Key CI data includes deployment names, deployment group names, deployment IDs, ARNs, operational and install statuses, and resource types. These details are stored in the cmdbawscodedeploydeployment and cmdbcicmpresource tables.
- CI Relationships and References: The pattern establishes relationships such as "Hosted on" connections to AWS datacenters and references between deployment and cloud resource records to support comprehensive mapping.
- AWS Tag Discovery: Tags associated with CodeDeploy deployments are collected and stored in the cmdbkeyvalue table, linked back to the relevant cloud resource records.
Practical Benefits for ServiceNow Customers
- Improved Visibility: Gain detailed visibility into AWS CodeDeploy applications and their deployments within your cloud environment directly in your CMDB.
- Accurate CMDB Data: Ensure your CMDB reflects up-to-date AWS deployment information, including metadata and tags, supporting better service mapping and impact analysis.
- Seamless Integration: Pattern activation and updates are managed smoothly, minimizing manual customization overhead while keeping discovery data current.
- Relationship Mapping: Understand deployment dependencies and hosting environments through automatically created CI relationships, aiding in operational and change management processes.
Discovery and Service Mapping Patterns finds AWS CodeDeploy Deployments on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Pattern-based discovery and mapping requirements
- Verify the AWS discovery prerequisites
- For more information, see the prerequisites section in Amazon AWS Cloud components discovery using patterns.
- Remove resources from the Resource Inclusion List table
- Verify that the relevant resource isn't listed in the Resource Inclusion List [sa_cloud_inventory_resource_whitelist] table to avoid duplicate discovery. For more information on removing resources from the Resource Inclusion List, see Amazon Web Services (AWS) Resource Inventory.
- Enable the relevant pattern
- The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.
Data stored in non-CMDB tables
Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - CodeDeploy Deployment - Extended Inventory (LP) pattern.
You can review the non-CMDB AWS tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Name [name] | Name of the CodeDeploy application associated with the deployment. |
| Object ID [object_id] | Amazon Resource Name (ARN) that uniquely identifies the CodeDeploy application. |
| Deployment Group Name [deployment_group_name] | Name of the deployment group associated with the deployment. |
| Deployment ID [deployment_id] | Unique identifier of the CodeDeploy deployment. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - CodeDeploy Deployment - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Object ID [object_id] | ARN that uniquely identifies the CodeDeploy application. |
| Name [name] | Name of the CodeDeploy application associated with the deployment. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::CodeDeployment::Deployment. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
CI relationships
The Amazon AWS - CodeDeploy Deployment - Extended Inventory (LP) pattern creates the following relationships and references to support AWS CodeDeploy Deployment discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS CodeDeploy Deployment [cmdb_aws_codedeploy_deployment] | Configuration Item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
AWS Tag discovery
The Amazon AWS - CodeDeploy Deployment - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |
| Configuration item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |