-
Notifications
You must be signed in to change notification settings - Fork 471
Update Managed postgres settings page for Beta. #6285
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+18
−30
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
afd999a
Update Managed postgres settings page for Beta.
achudnovskij ef20abd
Updated wording
achudnovskij c6e9221
Fixed links, completed moving IP filters to security page
achudnovskij f6d349f
minor fixes
achudnovskij fd69e86
Apply suggestion from @dhtclk
achudnovskij 872bcd5
Fix documentation wording for parameter modification
achudnovskij File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,28 +3,19 @@ | |
| sidebar_label: 'Settings' | ||
| title: 'Settings' | ||
| description: 'Configure PostgreSQL and PgBouncer parameters and manage instance settings for Managed Postgres' | ||
| keywords: ['postgres configuration', 'postgresql settings', 'pgbouncer', 'ip filters'] | ||
| keywords: ['postgres configuration', 'postgresql settings', 'pgbouncer'] | ||
| doc_type: 'guide' | ||
| --- | ||
|
|
||
| import BetaBadge from '@theme/badges/BetaBadge'; | ||
| import Image from '@theme/IdealImage'; | ||
| import postgresParameters from '@site/static/images/managed-postgres/postgres-parameters.png'; | ||
| import serviceActions from '@site/static/images/managed-postgres/service-actions.png'; | ||
| import ipFilters from '@site/static/images/managed-postgres/ip-filters.png'; | ||
|
|
||
| <BetaBadge link="https://clickhouse.com/cloud/postgres" galaxyTrack={true} galaxyEvent="docs.managed-postgres.settings-beta" /> | ||
|
|
||
| You can modify configuration parameters and manage instance settings for your Managed Postgres instance through the **Settings** tab in the sidebar. | ||
|
|
||
| ## Changing configuration parameters {#changing-configuration} | ||
|
|
||
| <Image img={postgresParameters} alt="Postgres parameters configuration" size="md" border/> | ||
|
|
||
| To modify a parameter, select the **Edit parameters** button. Select the parameters you need to modify and change their values accordingly. Once you're satisfied with your changes, press the **Save Changes** button. | ||
|
|
||
| All changes made to the configuration parameters are typically persisted to the instance within one minute. Some parameters require a database restart to take effect. These changes will be applied after the next restart, which you can trigger manually from the **Service actions** toolbar. | ||
|
|
||
| ## Service actions and scaling {#service-actions} | ||
|
|
||
| <Image img={serviceActions} alt="Service actions and scaling" size="md" border/> | ||
|
|
@@ -35,27 +26,15 @@ | |
| - **Restart**: Restart the database instance (only when the instance is `Running`) | ||
| - **Delete**: Delete the instance | ||
|
|
||
| The **Scaling** section allows you to change the instance types of your primary and standbys to increase or decrease computing resources and storage capacity. Behind the scenes, new instances will be provisioned and then take over after they've caught up with the current primary. The failover process will interrupt all current connections and lead to brief downtime. | ||
| The **Scaling** section allows you to change the instance types of your primary and standbys to increase or decrease computing resources and storage capacity. | ||
| See [scaling page](/cloud/managed-postgres/scaling) for more details. | ||
|
|
||
| :::tip | ||
| For safety reasons, you may not be able to switch to instance types whose storage is close to your current used storage capacity. Always opt for instance types with headroom over your current used capacity to avoid any issues. | ||
| ::: | ||
|
|
||
| ## IP filters {#ip-filters} | ||
|
|
||
| IP filters control which source IP addresses are permitted to connect to your Managed Postgres instance. | ||
|
|
||
| <Image img={ipFilters} alt="IP Access List configuration" size="md" border/> | ||
| ## Changing configuration parameters {#changing-configuration} | ||
|
|
||
|
Comment on lines
+29
to
33
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please fix this broken link before merging.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Already fied. |
||
| To configure IP filters: | ||
| <Image img={postgresParameters} alt="Postgres parameters configuration" size="md" border/> | ||
|
|
||
| 1. Navigate to the **Settings** tab | ||
| 2. Under **IP Filters**, click **Edit** | ||
| 3. Add IP addresses or CIDR ranges that should be allowed to connect | ||
| 4. Click **Save** to apply the changes | ||
| To modify a parameter, select the **Edit parameters** button. Select the parameters you need to modify and change their values accordingly. Once you're satisfied with your changes, press the **Save Changes** button. | ||
|
|
||
| You can specify individual IP addresses or use CIDR notation for IP ranges (e.g., `192.168.1.0/24`). You can also select **Anywhere** or **Nowhere** as a shortcut for fully opening or closing the instance to the world. | ||
| All changes made to the configuration parameters are typically persisted to the instance within one minute. Some parameters require a database restart to take effect. These changes will be applied after the next restart, which you can trigger manually from the **Service actions** toolbar. | ||
|
|
||
| :::note | ||
| If no IP filters are configured, connections from all IP addresses are permitted. For production workloads, we recommend restricting access to known IP addresses. | ||
| ::: | ||
| Refer to the official [documentation](https://www.postgresql.org/docs/current/runtime-config.html) on the configuration parameters. The list of parameters available to set will be extended soon. In the meantime, contact [support](https://clickhouse.com/support/program) to request a parameter not currently supported. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.