Update Turbot Guardrails Enterprise Database (TED)

In this guide, you will:

• Use AWS Service Catalog to update Turbot Guardrails Enterprise Database (TED).
• Monitor and troubleshoot the TED update process.

Turbot Guardrails Enterprise Database (TED) is an AWS Service Catalog product that provides automated configuration and management of the infrastructure needed to run the enterprise version of Turbot Guardrails in your AWS account.

TED is the database layer of a Turbot Guardrails Enterprise deployment. Creates and manages the Guardrails database infrastructure Hive, which defines physical database and caching resources shared by multiple workspaces.

Prerequisites

• Access to the Guardrails AWS account with Administrator Privileges.
• Familiarity with AWS Console, Service Catalog and CloudFormation services.

Step 1: Access RDS Service

Caution

Before initiating the TED update involving RDS changes, ensure that the RDS instance is in the Available status. Any other status may result in potential errors or delays during the TED stack update for the RDS instance.

Open the AWS Console and navigate to the RDS service in the region where TED is deployed.

Step 2: Find RDS Instance

Step 3: Check RDS Instance Status

Check the DB instance Status in Available state.

Step 4: Access AWS Service Catalog

Open the AWS Console and navigate to the Service Catalog service in the region where TED is deployed.

Step 5: Navigate Provisioned Products

Choose Provisioned Products from the left navigation menu.

Step 6: View Provisioned Products

Change the Access Filter in AWS Service Catalog from User to Account to view all TED provisioned products across the entire account.

Step 7: Find Provisioned Product

The TED provisioned product is identifiable by a postfix that matches the database Hive name.

From the Actions menu, select Update

Step 8: Find Version

Sort the Product versions section by Created time (descending) to see the latest available version.

Step 9: Select Version

Select the desired TED version under Product Versions.

Step 10: Verify Parameters

The values of the parameters will initially be set to match previous run of the product. Review the release notes for the TED versions between the existing version and the version you are updating to, and identify any new parameters that require a decision about how they will be set. Generally, new parameters will be created in a way to have the least disruption on an existing environment, but care should still be taken to understand these and read any new parameter descriptions to understand their impact.

Caution

A frequent issue arises when databases employ auto-scaling storage. Discrepancies in storage figures between the stack and the product can occur if the database has expanded since installation. Upgrading to a major version can introduce significant changes and potential risks. You should not upgrade to a new major version without first consulting with Turbot Support. To ensure cost-efficiency, review and update instance types and ElastiCache Versions at least annually to align with the latest supported options.

Step 11: Update TED

After verifying any changes to existing parameters, select Update at the bottom of the screen.

Step 12: Monitor Update

You have initiated the installation of the new TED version. This triggers an update of several nested CloudFormation stacks.

Note

Depending on the changes selected, the database resource can remain in an updating state for an extended period of time. Viewing the state of the RDS instance(s) in the RDS web console can often provide some context about what is happening at any given time.

Select the TED Provisioned Product, select the Outputs tab, and use the CloudFormationStackARN Value link to navigate to the CloudFormation stack and monitor the update progress.

The TED CloudFormation stack status should change to UPDATE_IN_PROGRESS indicating the update process is in progress.

Step 13: Review

• The TED CloudFormation stack status should change to UPDATE_COMPLETE indicating the update completed successfully.

• The TED Provisioned product status should change to Available.

Next Steps

Please see the following resources to learn more about Turbot Guardrails Enterprise:

• Learn more about Turbot Guardrails Enterprise - Architecture.
• Learn about TED Installation

Troubleshooting