DynamoDB table configuration

Itential Automation Gateway (IAG) supports Amazon DynamoDB as a database storage option. You need a DynamoDB or etcd database if you plan to run IAG in a distributed execution cluster or with highly available controller nodes. For more information on supported data store options, see Store Variables.

Step 1: Set IAG configuration variables for DynamoDB

To connect your IAG deployment to DynamoDB, set the following configuration variables:

• GATEWAY_STORE_BACKEND=dynamodb
• GATEWAY_STORE_DYNAMODB_TABLE_NAME=<table-name>
  • If you do not specify a table name, IAG uses the default value itential.gateway5.store.

Step 2: Create your DynamoDB table

Next, create the DynamoDB table that IAG will connect to. The following procedures demonstrate how to create a DynamoDB table using the AWS Management Console. For more information on creating tables, see Create a table in the Amazon DynamoDB Developer Guide.

1. Sign into the AWS Management Console and open the DynamoDB console.
2. In the left navigation pane, choose Tables.
3. Choose Create table.
4. Enter the Table details as follows:
   • For Table name, enter the table name you specified for GATEWAY_STORE_DYNAMODB_TABLE_NAME in Step 1. If you did not specify a table name, enter the default table name itential.gateway5.store.
   • For Partition key, enter namespace.
   • For Sort key, enter key.
5. For Table settings, specify your optimization and billing preferences. To get started, you can keep the default selection Default settings.
6. (Optional) Enter any tags that align with your standard AWS deployment strategy.
7. Choose Create table to create the table.

Step 3: Configure AWS variables

Next, configure your AWS region and credentials. IAG uses the default region and credential loaders that AWS provides. This means that IAG reads this information using standard methods for AWS-connected applications.

For more information on specifying the AWS Region and your Credentials, see the “Configure the SDK” topic in the AWS SDK documentation of your choice. For example, Configure the SDK in the AWS SDK for Go v2 Developer Guide demonstrates how to configure regions and specify credentials using environment variables.

Use the AWS_REGION environment variable to explicitly set the AWS region on your IAG instance.