Skip to content

Commit 713f631

Browse files
RahulSrivastav14rajlearner17dboeke
committed
Add > Guide > Upgrade AWS Redis OSS Cache to Valkey (#359)
Co-authored-by: raj <raj@turbot.com> Co-authored-by: David Boeke <david@boeke.com>
1 parent 3af27f9 commit 713f631

File tree

15 files changed

+161
-44
lines changed

15 files changed

+161
-44
lines changed

docs/guides/hosting-guardrails/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@ The Guardrails Enterprise installation is highly customizable, allowing you to d
2020
| [Monitoring Guides](guides/hosting-guardrails/monitoring) | How to proactively monitor your Guardrails infrastructure.
2121
| [Recovery Guides](guides/hosting-guardrails/disaster-recovery) | How to recover a Guardrails environment from backup.
2222
| [Troubleshooting Guides](guides/hosting-guardrails/troubleshooting) | How to assess and fix common hosting issues.
23+
| [Updating Guardrails](guides/hosting-guardrails/updating-stacks) | How to keep your Guardrails infrastructure up to date.
24+
25+

docs/guides/hosting-guardrails/installation/install-ted/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ Choose to **Use Elasticache** and select the desired values for **ElastiCache Ve
123123

124124
![Cache](/images/docs/guardrails/guides/hosting-guardrails/installation/install-ted/service-catalog-ted-parameter-cache.png)
125125

126+
### Upgrade to Valkey cache
127+
128+
As part of the TED infrastructure, Redis has previously been the default caching engine. We now recommend moving to [Valkey](https://aws.amazon.com/elasticache/what-is-valkey/), a community-driven alternative to Redis.
129+
130+
For customers currently using Redis OSS cache, [here is how to update to Valkey](/guardrails/docs/guides/hosting-guardrails/updating-stacks/upgrade-to-valkey-cache).
131+
126132
## Step 16: Configure Advanced - Foundation Parameters and Overrides
127133

128134
The Foundation Parameters allow the TED stack to use SSM parameters defined in the TEF stack. You should only change these values if you did not use the default Resource Name Prefix (turbot) in the TEF stack.
291 KB
Loading

docs/guides/hosting-guardrails/updating-stacks/general-purpose-gp3/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ or the TE version could be different from case to case.
7070

7171
* Storage Throughput: 0
7272

73-
![gp3-baseline](/images/docs/guardrails/gp3-baseline.png)
73+
![gp3-baseline](./gp3-baseline.png)
7474

7575
If the Allocated Storage is 400GB or higher:
7676

@@ -80,7 +80,7 @@ or the TE version could be different from case to case.
8080

8181
* Storage Throughput: 500
8282

83-
![gp3-baseline-custom](/images/docs/guardrails/gp3-baseline-custom.png)
83+
![gp3-baseline-custom](./gp3-baseline-custom.png)
8484

8585
* Scroll to the bottom of the page and click on "Update" to make the above changes to the provisioned product.
8686

docs/guides/hosting-guardrails/updating-stacks/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,10 @@ stack will be updated in tandem with the TE stack and is never deleted.
1818
- [Update the TEF stack](guides/hosting-guardrails/updating-stacks/update-tef)
1919
- [Update the TED stack](guides/hosting-guardrails/updating-stacks/update-ted)
2020
- [Update the TE stack and custom workspace](guides/hosting-guardrails/updating-stacks/update-workspace)
21+
- [Upgrade to Valkey Cache](guides/hosting-guardrails/updating-stacks/upgrade-to-valkey-cache)
22+
23+
- [Update Guardrails Domain Name](guides/hosting-guardrails/updating-stacks/domain-update)
24+
- [Upgrade to General Purpose (gp3) EBS Volumes](guides/hosting-guardrails/updating-stacks/general-purpose-gp3)
25+
2126

2227
Head over to the [Releases](/guardrails/changelog) section for release notes for TEF, TED and the TE stacks.

docs/guides/hosting-guardrails/updating-stacks/update-ted/index.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,74 +25,80 @@ TED is the database layer of a Turbot Guardrails Enterprise deployment. Creates
2525
2626
Open the AWS Console and navigate to the RDS service in the region where TED is deployed.
2727

28-
![Access RDS Console](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/rds-console-access.png)
28+
![Access RDS Console](./rds-console-access.png)
2929

3030
## Step 2: Find RDS Instance
3131

32-
![Find RDS Instance](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/rds-find-instance.png)
32+
![Find RDS Instance](./rds-find-instance.png)
3333

3434
## Step 3: Check RDS Instance Status
3535

3636
Check the DB instance `Status` in `Available` state.
3737

38-
![RDS Instance Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/rds-instance-status-available.png)
38+
![RDS Instance Status](./rds-instance-status-available.png)
3939

4040
## Step 4: Access AWS Service Catalog
4141

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

44-
![AWS Console Home Page](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/aws-service-catalog-console.png)
44+
![AWS Console Home Page](./aws-service-catalog-console.png)
4545

4646
## Step 5: Navigate Provisioned Products
4747

4848
Choose **Provisioned Products** from the left navigation menu.
4949

50-
![Provisioned Products](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-provisioned-products.png)
50+
![Provisioned Products](./service-catalog-provisioned-products.png)
5151

5252
## Step 6: View Provisioned Products
5353

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

56-
![Access Filter](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-select-access-filter.png)
56+
![Access Filter](./service-catalog-select-access-filter.png)
5757

5858
## Step 7: Find Provisioned Product
5959

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

62-
![Find TED](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-find-provisioned-product-ted.png)
62+
![Find TED](./service-catalog-find-provisioned-product-ted.png)
6363

6464
From the **Actions** menu, select **Update**
6565

66-
![Select Update](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-actions-update.png)
66+
![Select Update](./service-catalog-actions-update.png)
6767

6868
## Step 8: Find Version
6969

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

72-
![Find TED Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-find-ted-product-versions.png)
72+
![Find TED Version](./service-catalog-find-ted-product-versions.png)
7373

7474
## Step 9: Select Version
7575

7676
Select the desired TED version under **Product Versions**.
7777

78-
![Select TED Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-select-ted-version.png)
78+
![Select TED Version](./service-catalog-select-ted-version.png)
7979

8080
## Step 10: Verify Parameters
8181

8282
The values of the parameters will initially be set to match previous run of the product. Review the [release notes](https://turbot.com/guardrails/changelog?tag=ted) 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.
8383

84-
![Parameters Verification](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-ted-verify-parameters.png)
84+
![Parameters Verification](./service-catalog-ted-verify-parameters.png)
8585

8686
> [!CAUTION]
8787
> 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.
8888
> 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.
8989
> To ensure cost-efficiency, review and update instance types and ElastiCache Versions at least annually to align with the latest supported options.
9090
91+
### Upgrade to Valkey cache
92+
93+
As part of the TED infrastructure, Redis has previously been the default caching engine. We now recommend moving to [Valkey](https://aws.amazon.com/elasticache/what-is-valkey/), a community-driven alternative to Redis.
94+
95+
For customers currently using Redis OSS cache, [here is how to update to Valkey](/guardrails/docs/guides/hosting-guardrails/updating-stacks/upgrade-to-valkey-cache).
96+
9197
## Step 11: Update TED
9298

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

95-
![Select Update](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-ted-update-action.png)
101+
![Select Update](./service-catalog-ted-update-action.png)
96102

97103
## Step 12: Monitor Update
98104

@@ -103,21 +109,21 @@ You have initiated the installation of the new TED version. This triggers an upd
103109
104110
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.
105111

106-
![Navigate ](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-update-ted-navigate-to-cfn.png)
112+
![Navigate ](./service-catalog-update-ted-navigate-to-cfn.png)
107113

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

110-
![Update Progress ](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/cfn-ted-update-progress.png)
116+
![Update Progress ](./cfn-ted-update-progress.png)
111117

112118
## Step 13: Review
113119

114120
- [ ] The TED CloudFormation stack status should change to `UPDATE_COMPLETE` indicating the update completed successfully.
115121

116-
![Verify Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/cfn-ted-update-complete.png)
122+
![Verify Status](./cfn-ted-update-complete.png)
117123

118124
- [ ] The TED `Provisioned product` status should change to `Available`.
119125

120-
![TED Provisioned Product Complete Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-ted/service-catalog-ted-update-complete.png)
126+
![TED Provisioned Product Complete Status](./service-catalog-ted-update-complete.png)
121127

122128
## Next Steps
123129

291 KB
Loading

docs/guides/hosting-guardrails/updating-stacks/update-tef/index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,77 +22,77 @@ The TEF CloudFormation stack creates and manages the networking and compute comp
2222

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

25-
![AWS Console Home Page](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/aws-service-catalog-console.png)
25+
![AWS Console Home Page](./aws-service-catalog-console.png)
2626

2727
## Step 2: Navigate Provisioned Products
2828

2929
Choose **Provisioned Products** from the left navigation menu.
3030

31-
![Provisioned Product](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-provisioned-products.png)
31+
![Provisioned Product](./service-catalog-provisioned-products.png)
3232

3333
## Step 3: View Provisioned Products
3434

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

37-
![Access Filter](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-select-access-filter.png)
37+
![Access Filter](./service-catalog-select-access-filter.png)
3838

3939
## Step 4: Select Provisioned Product
4040

4141
Select the TEF provisioned product from the list.
4242

43-
![Select TEF](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-find-provisioned-product-tef.png)
43+
![Select TEF](./service-catalog-find-provisioned-product-tef.png)
4444

4545
Select **Actions** menu, select **Update**
4646

47-
![Select Update](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-actions-update.png)
47+
![Select Update](./service-catalog-actions-update.png)
4848

4949
## Step 5: Find Version
5050

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

53-
![Sort TEF Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-find-tef-product-versions.png)
53+
![Sort TEF Version](./service-catalog-find-tef-product-versions.png)
5454

5555
## Step 6: Select Version
5656

5757
Select the desired TEF version under **Product Versions**.
5858

59-
![Select TEF Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-select-tef-version.png)
59+
![Select TEF Version](./service-catalog-select-tef-version.png)
6060

6161
## Step 7: Verify Parameters
6262

6363
The values of the parameters will initially be set to match previous run of the product. Review the [release notes](https://turbot.com/guardrails/changelog?tag=tef) for the TEF 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.
6464

6565
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.
6666

67-
![Parameters Verification](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-tef-verify-parameters.png)
67+
![Parameters Verification](./service-catalog-tef-verify-parameters.png)
6868

6969
## Step 8: Update TEF
7070

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

73-
![Select Update](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-tef-update-action.png)
73+
![Select Update](./service-catalog-tef-update-action.png)
7474

7575
## Step 9: Monitor Update
7676

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

7979
Select the TEF Provisioned Product, click the `Outputs` tab, and use the `CloudFormationStackARN` link to navigate to CloudFormation and monitor the update progress.
8080

81-
![Navigate To CFN](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-update-tef-navigate-to-cfn.png)
81+
![Navigate To CFN](./service-catalog-update-tef-navigate-to-cfn.png)
8282

8383
- [ ] Verify TEF stack status transitions to `UPDATE_IN_PROGRESS` upon modification and review the Events tab for expected parameter/resource updates.
8484

85-
![Verify CFN Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/cfn-tef-update-progress.png)
85+
![Verify CFN Status](./cfn-tef-update-progress.png)
8686

8787
## Step 10: Review
8888

8989
- [ ] The TEF CloudFormation stack status should change to `UPDATE_COMPLETE` indicating the update completed successfully.
9090

91-
![CFN Update Complete](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/cfn-tef-update-complete.png)
91+
![CFN Update Complete](./cfn-tef-update-complete.png)
9292

9393
- [ ] The TEF Provisioned Product status should change to `Available`.
9494

95-
![TEF Provisioned Product Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-tef/service-catalog-tef-update-complete.png)
95+
![TEF Provisioned Product Status](./service-catalog-tef-update-complete.png)
9696

9797
## Next Steps
9898

docs/guides/hosting-guardrails/updating-stacks/update-workspace/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,65 +20,65 @@ A Guardrails [Workspace](/guardrails/docs/reference/glossary#workspace) is updat
2020

2121
Open the AWS Console and navigate to the CloudFormation service in the region where your workspace is deployed.
2222

23-
![AWS Console Home Page](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/aws-cloudformation-console.png)
23+
![AWS Console Home Page](./aws-cloudformation-console.png)
2424

2525
## Step 2: Select Stack
2626

2727
From the left navigation menu choose **Stacks**.
2828

29-
![Stacks Selection](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-stacks.png)
29+
![Stacks Selection](./cfn-stacks.png)
3030

3131
Search for the stack named **workspace**.
3232

33-
![Workspace Stack](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-select-workspace-stack.png)
33+
![Workspace Stack](./cfn-select-workspace-stack.png)
3434

3535
Select **Update**
3636

37-
![Update Stack](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-workspace-stack-select-update.png)
37+
![Update Stack](./cfn-workspace-stack-select-update.png)
3838

3939

4040
## Step 3: Update Stack
4141

4242
Choose **Use existing template** and select **Next**.
4343

44-
![Select Existing Template](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-stack-use-existing-template.png)
44+
![Select Existing Template](./cfn-stack-use-existing-template.png)
4545

4646
Modify the version to match the new TE version number used in the TE stack (e.g., 5.45.4), then select **Next**.
4747

48-
![Select Existing Template](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-stack-specify-te-version.png)
48+
![Select Existing Template](./cfn-stack-specify-te-version.png)
4949

5050
## Step 4: Specify TE Version
5151

52-
![Specify TE Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-stack-specify-te-version.png)
52+
![Specify TE Version](./cfn-stack-specify-te-version.png)
5353

5454
Scroll down to **Advanced options**, leave the entire section as default and select **Next**
5555

56-
![Advanced Option as Default TE Version](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-stack-advanced-option-as-default.png)
56+
![Advanced Option as Default TE Version](./cfn-stack-advanced-option-as-default.png)
5757

5858

5959
## Step 5: Submit Changes
6060

6161
In **Configure stack options**, review changes under **Changeset Preview** and select **Submit**.
6262

63-
![Submit Changeset](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-worksapce-stack-select-submit-changes.png)
63+
![Submit Changeset](./cfn-worksapce-stack-select-submit-changes.png)
6464

6565
## Step 6: Monitor Update
6666

6767
You have initiated the update of a new TE version in the Guardrails workspace. This triggers an update of several nested CloudFormation stacks.
6868

6969
- [ ] The workspace CloudFormation stack status should change to `UPDATE_IN_PROGRESS` indicating the update process is in progress.
7070

71-
![Verify Status](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-workspace-stack-update-progress.png)
71+
![Verify Status](./cfn-workspace-stack-update-progress.png)
7272

7373
## Step 7: Review
7474

7575
- [ ] The workspace CloudFormation stack status should change to `UPDATE_COMPLETE` indicating the update completed successfully.
7676

77-
![Update Complete](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/cfn-workspace-stack-update-complete.png)
77+
![Update Complete](./cfn-workspace-stack-update-complete.png)
7878

7979
- [ ] Updated TE version should reflect in Guardrails `Workspace Admin` panel.
8080

81-
![Guardrails Console Admin Panel](/images/docs/guardrails/guides/hosting-guardrails/updating-stacks/update-workspace/guardrails-console-verify-version.png)
81+
![Guardrails Console Admin Panel](./guardrails-console-verify-version.png)
8282

8383
## Next Steps
8484

123 KB
Loading

0 commit comments

Comments
 (0)