Skip to content

Commit 56609bb

Browse files
RahulSrivastav14rajlearner17
RahulSrivastav14
and
rajlearner17
authored
Add > Guide > Enable PgBouncer in Turbot Guardrails and Update links for troubleshooting permission issues across multiple guides to ensure consistency and accuracy. (#364)
Co-authored-by: raj <raj@turbot.com>
1 parent 95dfa66 commit 56609bb

File tree

22 files changed

+205
-23
lines changed

22 files changed

+205
-23
lines changed

‎docs/guides/hosting-guardrails/installation/delete-te/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,5 @@ Please see the following resources to learn more about Turbot Guardrails Enterpr
9393

9494
| Issue | Description | Guide |
9595
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
96-
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators) |
96+
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](guides/hosting-guardrails/installation/pre-installation/admin-permissions) |
9797
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

‎docs/guides/hosting-guardrails/installation/install-te/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,5 @@ Please see the following resources to learn more about Turbot Guardrails Enterpr
9494

9595
| Issue | Description | Guide |
9696
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
97-
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators) |
97+
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](guides/hosting-guardrails/installation/pre-installation/admin-permissions) |
9898
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,20 @@ As part of the TED infrastructure, Redis has previously been the default caching
129129

130130
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).
131131

132-
## Step 16: Configure Advanced - Foundation Parameters and Overrides
132+
## Step 16: Enable Pg Bouncer
133+
134+
To improve database connection management and performance, we now recommend enabling PgBouncer, a lightweight connection pooler for PostgreSQL.
135+
For setup instructions, learn how to [Enable PgBouncer](/guardrails/docs/guides/hosting-guardrails/updating-stacks/update-pgbouncer).
136+
137+
## Step 17: Configure Advanced - Foundation Parameters and Overrides
133138

134139
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.
135140

136141
![Foundation Parameters](/images/docs/guardrails/guides/hosting-guardrails/installation/install-ted/service-catalog-ted-parameter-adavanced-foundation-parameters.png)
137142

138143
The Foundation Overrides allow you to override values defined in the TEF stack. You will likely want to leave these blank.
139144

140-
## Step 17: Advanced - Infrastructure
145+
## Step 18: Advanced - Infrastructure
141146

142147
Select a **Resource Name Prefix** which will be added to all Turbot Guardrails resources. Because this prefix will be used across many resource types and different resource types have different name restrictions, you should avoid special characters and uppercase letters. This prefix should match the name prefix you used in the TEF stack.
143148

@@ -146,21 +151,21 @@ Select a **Resource Name Prefix** which will be added to all Turbot Guardrails r
146151
147152
![Advanced Infrastructure](/images/docs/guardrails/guides/hosting-guardrails/installation/install-ted/service-catalog-ted-parameter-advanced-infrastructure.png)
148153

149-
## Step 18: Launch Product
154+
## Step 19: Launch Product
150155

151156
Select **Launch product**.
152157

153158
![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-ted/service-catalog-ted-launch-product-action.png)
154159

155-
## Step 19: Monitor Installation
160+
## Step 20: Monitor Installation
156161

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

159164
The TED stack should be in the **CREATE_IN_PROGRESS** status.
160165

161166
![Under Change Status](/images/docs/guardrails/guides/hosting-guardrails/installation/install-ted/cfn-ted-create-progress.png)
162167

163-
## Step 20: Review
168+
## Step 21: Review
164169

165170
- [ ] The TEF CloudFormation stack status should change to `CREATE_COMPLETE` indicating the installation completed successfully.
166171

@@ -181,5 +186,5 @@ Please see the following resources to learn more about Turbot Guardrails Enterpr
181186

182187
| Issue | Description | Guide |
183188
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
184-
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators) |
189+
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](guides/hosting-guardrails/installation/pre-installation/admin-permissions) |
185190
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

‎docs/guides/hosting-guardrails/installation/install-ted/service-catalog-ted-update-valkey-parameters.png‎

-291 KB
Binary file not shown.

‎docs/guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc/index.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,26 @@ By default, support is provided for the `Instance Type for EC2 ECS host` and `AM
121121
122122
You can modify the rest of the parameters as needed, or leave them at their default values.
123123

124-
## Step 11: Launch Product
124+
## Step 11: Enable Pg Bouncer
125+
126+
To improve database connection management and performance, we now recommend enabling PgBouncer, a lightweight connection pooler for PostgreSQL.
127+
For setup instructions, learn how to [Enable PgBouncer](/guardrails/docs/guides/hosting-guardrails/updating-stacks/update-pgbouncer).
128+
129+
## Step 12: Launch Product
125130

126131
Select **Launch product**.
127132

128133
![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc/service-catalog-tef-launch-product-action.png)
129134

130-
## Step 12: Monitor Installation
135+
## Step 13: Monitor Installation
131136

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

134139
The TEF provisioned product should be in the **Under Change** status.
135140

136141
![Under Change Status](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc/service-catalog-tef-under-change.png)
137142

138-
## Step 13: Enable Termination Protection
143+
## Step 14: Enable Termination Protection
139144

140145
> [!IMPORTANT]
141146
> To ensure that the TEF stack is not accidentally deleted, it is strongly recommend that termination protection is enabled.
@@ -156,7 +161,7 @@ Choose `Termination protection` as **Activated** and select **Save**.
156161

157162
![Termination Protection Activated](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc/cfn-stack-edit-termination-protection-activated.png)
158163

159-
## Step 14: Review
164+
## Step 15: Review
160165

161166
- [ ] The TEF CloudFormation stack status should change to `CREATE_COMPLETE` indicating the installation completed successfully.
162167

@@ -177,5 +182,5 @@ Please see the following resources to learn more about Turbot Guardrails Enterpr
177182

178183
| Issue | Description | Guide |
179184
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
180-
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators) |
185+
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](guides/hosting-guardrails/installation/pre-installation/admin-permissions) |
181186
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

‎docs/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/index.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,21 +118,26 @@ By default, support is provided for the `Instance Type for EC2 ECS host` and `AM
118118
119119
You can modify the rest of the parameters as needed, or leave them at their default values.
120120

121-
## Step 11: Launch Product
121+
## Step 11: Enable Pg Bouncer
122+
123+
To improve database connection management and performance, we now recommend enabling PgBouncer, a lightweight connection pooler for PostgreSQL.
124+
For setup instructions, learn how to [Enable PgBouncer](/guardrails/docs/guides/hosting-guardrails/updating-stacks/update-pgbouncer).
125+
126+
## Step 12: Launch Product
122127

123128
Select **Launch product**.
124129

125130
![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-launch-product-action.png)
126131

127-
## Step 12: Monitor Installation
132+
## Step 13: Monitor Installation
128133

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

131136
The TEF provisioned product should be in the **Under Change** status.
132137

133138
![Under Change Status](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-under-change.png)
134139

135-
## Step 13: Enable Termination Protection
140+
## Step 14: Enable Termination Protection
136141

137142
> [!IMPORTANT]
138143
> To ensure that the TEF stack is not accidentally deleted, it is strongly recommend that termination protection is enabled.
@@ -153,7 +158,7 @@ Choose `Termination protection` as **Activated** and select **Save**.
153158

154159
![Termination Protection Activated](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/cfn-stack-edit-termination-protection-activated.png)
155160

156-
## Step 14: Review
161+
## Step 15: Review
157162

158163
- [ ] The TEF CloudFormation stack status should change to `CREATE_COMPLETE` indicating the installation completed successfully.
159164

@@ -174,5 +179,5 @@ Please see the following resources to learn more about Turbot Guardrails Enterpr
174179

175180
| Issue | Description | Guide |
176181
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
177-
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators) |
182+
| Permission Issues | If the current logged-in user lacks permission to modify, update, or create resources in the stack, or if IAM roles or SCPs have changed, preventing built-in roles from accessing needed configuration settings. | [Troubleshoot Permission Issues](guides/hosting-guardrails/installation/pre-installation/admin-permissions) |
178183
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ stack will be updated in tandem with the TE stack and is never deleted.
2222

2323
- [Update Guardrails Domain Name](guides/hosting-guardrails/updating-stacks/domain-update)
2424
- [Upgrade to General Purpose (gp3) EBS Volumes](guides/hosting-guardrails/updating-stacks/general-purpose-gp3)
25+
- [Enable PgBouncer Connection Pooling](guides/hosting-guardrails/updating-stacks/update-pgbouncer)
2526

2627

2728
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-pgbouncer/aws-select-ted-version.png‎

178 KB
Loading

‎docs/guides/hosting-guardrails/updating-stacks/update-pgbouncer/aws-select-tef-version.png‎

175 KB
Loading

‎docs/guides/hosting-guardrails/updating-stacks/update-pgbouncer/aws-ted-pgbouncer-params-1.png‎

302 KB
Loading

0 commit comments

Comments
 (0)