AWS MemoryDB for Redis discovery with Patterns
Summarize
Summary of AWS MemoryDB for Redis discovery with Patterns
The Discovery application in ServiceNow uses the Amazon AWS MemoryDB pattern and associated extensions to identify and map AWS MemoryDB for Redis resources within your cloud environment. This capability helps populate the Configuration Management Database (CMDB) with detailed information about MemoryDB clusters and nodes.
Show less
To utilize this feature effectively, ensure you have the latest Discovery and Service Mapping Patterns application from the ServiceNow Store, as pattern updates are released quarterly.
Prerequisites
- AWS Credentials: Configure AWS service account credentials in your ServiceNow instance to authenticate AWS API calls.
- User Permissions: Grant the necessary permissions to execute AWS MemoryDB for Redis API calls, specifically for describing clusters and listing tags.
- Cloud Discovery Schedule: Set up a cloud application schedule with Discovery mode set to Cloud Discovery to automate resource discovery.
- REST API Permissions Verification: Use the Cloud Discovery patterns spreadsheet to verify and assign required user permissions, and test AWS REST APIs via tools like Postman.
Data Collected During Discovery
When running the AWS MemoryDB pattern, the following key data is collected and stored in the CMDB:
- Cloud DataBase [cmdbciclouddatabase]: Details about individual nodes, including Amazon Resource Name (ARN), node name, fully qualified domain name (FQDN), TCP port, and database type (set as memorydb).
- Cloud DataBase Cluster [cmdbciclouddbcluster]: Details about the overall cluster, including ARN, cluster name, FQDN, and TCP port.
CI Relationships and References
The discovery patterns establish relationships to model the AWS MemoryDB environment accurately:
- Clusters are linked to their constituent nodes (Cluster of::Cluster).
- Clusters are hosted on AWS Datacenters.
- References connect configuration items without creating explicit relationships in the CI Relationship table.
AWS Tag Discovery
The pattern also collects AWS tags associated with MemoryDB clusters and stores them in the Key Value [cmdbkeyvalue] table. Tags are linked to their corresponding Cloud DataBase Cluster records, enabling enhanced filtering, reporting, and management based on AWS tagging.
Practical Benefits for ServiceNow Customers
- Automated and accurate discovery of AWS MemoryDB for Redis resources enhances CMDB completeness and accuracy.
- Visibility into cluster and node configurations supports better operational management and troubleshooting.
- Tag collection enables alignment with AWS governance and cost management strategies.
- Establishing relationships between clusters, nodes, and datacenters supports impact analysis and service mapping.
The ® Discovery application uses the Amazon AWS MemoryDB pattern and extensions to find AWS MemoryDB for Redis. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Prerequisites
- Configured AWS Credentials
- On your instance, configure credentials of type AWS Credentials. For more information, see Access setup for AWS service accounts.
- Configured Cloud service account
- Configure the AWS service account valid in the ServiceNow instance. For more information, see Set up AWS service accounts.
- Configured user permissions to execute the list AWS MemoryDB for Redis API calls
- Provide the user permission to run the following API:
- https://memory-db.{region}.amazonaws.com?Action=DescribeClusters&ShowShardDetails=true
- https://memory-db.{region}.amazonaws.com? Action=ListTags&ResourceArn={arn}
- Configured Cloud Discovery schedule
- Create a cloud application schedule for discovering AWS datacenters. Set Discovery to Cloud discovery. For more information, see: Create schedules for discovering cloud resources in Cloud Discovery Workspace
Verify the REST API Permissions
Download the Cloud Discovery patterns spreadsheet so you can grant user permissions required for running the Discovery patterns. In addition to permissions, the spreadsheet also includes useful information such as pattern names, types, CI Classes, and links to vendor documentation. New patterns are available quarterly, so check periodically to be sure you have the latest version of the spreadsheet.
Data collected during AWS MemoryDB for Redis horizontal discovery
Discovery populates the data in the CMDB when running the Amazon AWS MemoryDB pattern.
| Field | Description |
|---|---|
| Object ID [object_id] | The Amazon Resource Name of a single node in the cluster. |
| Name [name] | The name of a single node in the cluster. |
| Fully qualified domain name [fqdn] | The Fully Qualified Domain Name of each node in the cluster. |
| TCP port(s) [tcp_port] | The TCP port that a single node in the cluster is getting traffic from. |
| Type [type] | The type of database. Value is set to memorydb. |
| Field | Description |
|---|---|
| Cluster ID [cluster_id] | The Amazon Resource Name of the cluster. |
| Name [name] | The name of the cluster. |
| Fully qualified domain name [fqdn] | The Fully Qualified Domain Name of the cluster. |
| TCP port(s) [tcp_port] | The TCP port that the cluster is getting traffic from. |
CI relationships
The AWS MemoryDB for Redis pattern creates the following relationships and references to support AWS MemoryDB for Redis discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud DataBase Cluster [cmdb_ci_cloud_db_cluster] | Cluster of::Cluster | Cloud DataBase [cmdb_ci_cloud_database] |
| Cloud DataBase Cluster [cmdb_ci_cloud_db_cluster] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud DataBase Cluster [cmdb_ci_cloud_db_cluster] |
AWS tag discovery
The AWS MemoryDB for Redis 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 DataBase Cluster [cmdb_ci_cloud_db_cluster] table. |