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 its extensions to identify and map AWS MemoryDB for Redis resources within your cloud environment. This enables automatic population and updating of Configuration Management Database (CMDB) records related to MemoryDB clusters and nodes, enhancing cloud resource visibility and management.
Show less
To leverage this functionality, ensure you have the latest Discovery and Service Mapping Patterns application installed from the ServiceNow Store, as new patterns are released quarterly.
Prerequisites
- AWS Credentials Configuration: Set up valid AWS Credentials in your ServiceNow instance to authenticate and authorize discovery API calls.
- AWS Service Account Setup: Configure an AWS service account with permissions valid for your instance.
- User Permissions: Grant user permissions to execute key AWS MemoryDB for Redis API operations, specifically
DescribeClustersandListTagsactions, enabling discovery of cluster details and associated tags. - Cloud Discovery Schedule: Create and enable a cloud application discovery schedule set to Cloud discovery to automate periodic scanning of AWS datacenters.
- REST API Permissions Verification: Utilize the Cloud Discovery patterns spreadsheet to review and assign necessary permissions and understand pattern details. Testing AWS REST APIs with tools like Postman is supported to validate access.
Data Collected During Discovery
The discovery process collects detailed information about AWS MemoryDB for Redis clusters and their nodes, which is stored in the CMDB in two main tables:
- Cloud DataBase [cmdbciclouddatabase]: Contains node-level data including Amazon Resource Name (ARN), node name, Fully Qualified Domain Name (FQDN), TCP port, and database type (set as memorydb).
- Cloud DataBase Cluster [cmdbciclouddbcluster]: Captures cluster-level data such as cluster ARN, name, FQDN, and TCP port.
CI Relationships and Tagging
The discovery pattern establishes key relationships between discovered Configuration Items (CIs) to accurately represent the AWS MemoryDB for Redis architecture:
- Cluster of Node Relationship: Links individual database nodes to their parent cluster.
- Hosted on Relationship: Connects clusters to the hosting AWS datacenter.
Additionally, the pattern collects AWS tags associated with MemoryDB clusters and stores them in the Key Value [cmdbkeyvalue] table, enhancing classification and filtering capabilities within the CMDB.
Benefits for ServiceNow Customers
- Automates discovery and CMDB population for AWS MemoryDB for Redis, reducing manual data entry and improving accuracy.
- Provides comprehensive visibility into MemoryDB clusters and nodes, facilitating better asset and service management.
- Enables relationship mapping and tag collection, supporting impact analysis, compliance, and governance.
- Supports ongoing maintenance with scheduled discovery and regular pattern updates from the ServiceNow Store.
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 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. |