From ccd8a160d2139fc0efe042df5052ebef5d9aaee6 Mon Sep 17 00:00:00 2001 From: Matthew Mols Date: Thu, 11 Dec 2025 10:23:20 -0600 Subject: [PATCH 1/4] docs: document major version upgrade support --- docs/index.md | 3 +- docs/using/upgrade-db.md | 117 ++++++++++++++++++++++++++++++++++++--- 2 files changed, 112 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 24afd88c..8887765b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,4 +33,5 @@ The pgEdge Control Plane supports: - distributed node addition via pgBackRest restore. - monitoring database operations through detailed task logs, enabling visibility into deployment progress, troubleshooting, and historical activity tracking. - secure API access with certificate-based authentication. -- performing in-place minor version upgrades of Postgres and supporting components. \ No newline at end of file +- performing in-place minor version upgrades of Postgres and supporting components. +- performing major version upgrades of Postgres using zero downtime node addition. \ No newline at end of file diff --git a/docs/using/upgrade-db.md b/docs/using/upgrade-db.md index ad1c3068..2f1a8f3f 100644 --- a/docs/using/upgrade-db.md +++ b/docs/using/upgrade-db.md @@ -12,7 +12,6 @@ from Postgres 18.0 to 18.1, via the API. The Postgres version is a field in the Before you upgrade, make sure that your desired version is supported by following the [instructions below](#which-versions-are-available). - To upgrade a database, submit a `POST` request to the `/v1/databases/{database_id}` endpoint of any host in the cluster with the new version in the `postgres_version` field. For example: @@ -20,7 +19,7 @@ version in the `postgres_version` field. For example: === "curl" ```sh - curl -X POST http://host-3:3000/v1/databases \ + curl -X POST http://host-3:3000/v1/databases/example \ -H 'Content-Type:application/json' \ --data '{ "id": "example", @@ -51,13 +50,117 @@ Like with all other updates, the Control Plane applies upgrades in a rolling fashion, meaning that it upgrades one node at a time. If a node has both primary and replica instances, the replica instances are upgraded first. +You can also set the `postgres_version` field on a per node basis if you want to gradually roll out minor version updates to different nodes. For example: + +=== "curl" + + ```sh + curl -X POST http://host-3:3000/v1/databases/example \ + -H 'Content-Type:application/json' \ + --data '{ + "id": "example", + "spec": { + "database_name": "example", + "database_users": [ + { + "username": "admin", + "db_owner": true, + "attributes": ["SUPERUSER", "LOGIN"] + } + ], + "port": 5432, + "postgres_version": "18.0", + "nodes": [ + { "name": "n1", "host_ids": ["host-1"] }, + { + "name": "n2", + "host_ids": ["host-2"], + "postgres_version": "18.1" + }, + ] + } + }' + ``` + ## Major Version Upgrades -The Control Plane doesn't currently support major Postgres version upgrades. We -recommend that you [create a new Database](./create-db.md) with your desired -version, and then use -[`pg_dump`](https://www.postgresql.org/docs/current/backup-dump.html) to migrate -your data to the new database. +The Control Plane supports major Postgres version upgrades by leveraging the Spock extension's zero downtime add node capability. With this approach, you can add a new node to your existing Database with the `postgres_version` set to the new version. + +For example, to gradually move a single node Database running Postgres 17.6 to 18.1: + +=== "curl" + + ```sh + curl -X POST http://host-3:3000/v1/databases/example \ + -H 'Content-Type:application/json' \ + --data '{ + "id": "example", + "spec": { + "database_name": "example", + "database_users": [ + { + "username": "admin", + "db_owner": true, + "attributes": ["SUPERUSER", "LOGIN"] + } + ], + "port": 5432, + "postgres_version": "17.6", + "nodes": [ + { "name": "n1", "host_ids": ["host-1"] }, + { + "name": "n2", + "host_ids": ["host-2"], + "postgres_version": "18.1", + "source_node": "n1" + }, + ] + } + }' + ``` + +Once the update operation completes, the newly added node will be running Postgres 18.1, and the existing node remains operational running Postgres 17.6. Both nodes remain writeable during this operation. This allows for easier migration of your applications to the new node. + +Once you are satisfied with the upgraded node, you can perform an additional update to remove the old node from your Database spec, and update the `postgres_version` field across your database to 18.1. For example: + +=== "curl" + + ```sh + curl -X POST http://host-3:3000/v1/databases/example \ + -H 'Content-Type:application/json' \ + --data '{ + "id": "example", + "spec": { + "database_name": "example", + "database_users": [ + { + "username": "admin", + "db_owner": true, + "attributes": ["SUPERUSER", "LOGIN"] + } + ], + "port": 5432, + "postgres_version": "18.1", + "nodes": [ + { "name": "n2", "host_ids": ["host-2"] }, + ] + } + }' + ``` + +!!! tip + + This approach is supported for both single region and distributed deployments. You can also choose to use the same host for the upgraded node, assuming you have the availabile space and compute power to run both instances side by side. + + +Outside of this approach, The Control Plane doesn't currently support other mechanisms for performing in-place major Postgres version upgrades. + +As an alternative to using the zero downtime add node approach, you can also [create a new Database](./create-db.md) with your desired version, and then use [`pg_dump`](https://www.postgresql.org/docs/current/backup-dump.html) to migrate your data to the new database. + +!!! warning + + You should thoroughly test major version upgrade scenarios in a separate environment before proceeding on your production database. In addition, you should review the [Backup and Restore](./backup-restore.md) documentation to ensure you have appropriate backups of your database, and that you are prepared to restore in the event of unforseen problems. + ## Which Versions Are Available From c3bc6a63dac0d97ccf9856827cf1d15b2e247f08 Mon Sep 17 00:00:00 2001 From: Matthew Mols Date: Thu, 11 Dec 2025 10:59:49 -0600 Subject: [PATCH 2/4] update NOTICE.txt --- NOTICE.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NOTICE.txt b/NOTICE.txt index 83ff7dd2..73d1e2de 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -10638,7 +10638,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * Name: go.etcd.io/etcd/client/v3 * Version: v3.6.5 -* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/client/v3.6.5/client/v3/LICENSE) +* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/client/v3.6.5/client/LICENSE) ``` From fc5fc3e3ba23be2ceeeb9451020a254d34104cb7 Mon Sep 17 00:00:00 2001 From: Matthew Mols Date: Thu, 11 Dec 2025 11:04:35 -0600 Subject: [PATCH 3/4] remove duplicate entry in NOTICE.txt, update ignore --- Makefile | 1 - NOTICE.txt | 210 ------------------------------------------------ NOTICE.txt.tmpl | 210 ------------------------------------------------ 3 files changed, 421 deletions(-) diff --git a/Makefile b/Makefile index 0933d3f1..8d026d13 100644 --- a/Makefile +++ b/Makefile @@ -136,7 +136,6 @@ licenses: GOOS=linux $(go-licenses) report ./... \ --ignore github.com/pgEdge/control-plane \ --ignore github.com/eclipse/paho.golang \ - --ignore github.com/etcd-io/etcd \ --template=NOTICE.txt.tmpl > NOTICE.txt .PHONY: licenses-ci diff --git a/NOTICE.txt b/NOTICE.txt index 73d1e2de..b40ef5a8 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -26,216 +26,6 @@ Redistribution and use in source and binary forms, with or without modification, THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ``` -## go.etcd.io/etcd/api/v3 - -* Name: go.etcd.io/etcd/api/v3 -* Version: v3.6.5 -* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/api/v3.6.5/api/LICENSE) - -``` - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - ``` diff --git a/NOTICE.txt.tmpl b/NOTICE.txt.tmpl index 242b2830..e75ee4c9 100644 --- a/NOTICE.txt.tmpl +++ b/NOTICE.txt.tmpl @@ -26,216 +26,6 @@ Redistribution and use in source and binary forms, with or without modification, THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ``` -## go.etcd.io/etcd/api/v3 - -* Name: go.etcd.io/etcd/api/v3 -* Version: v3.6.5 -* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/api/v3.6.5/api/LICENSE) - -``` - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - ``` {{ range . }} From be001a33ef4593fd52b72e1e4c33e30edddcda74 Mon Sep 17 00:00:00 2001 From: Matthew Mols Date: Thu, 11 Dec 2025 11:14:18 -0600 Subject: [PATCH 4/4] incorporate suggestions from feedback Co-authored-by: susan-pgedge <130390403+susan-pgedge@users.noreply.github.com> --- docs/using/upgrade-db.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/using/upgrade-db.md b/docs/using/upgrade-db.md index 2f1a8f3f..70a89ab3 100644 --- a/docs/using/upgrade-db.md +++ b/docs/using/upgrade-db.md @@ -84,9 +84,11 @@ You can also set the `postgres_version` field on a per node basis if you want to ## Major Version Upgrades -The Control Plane supports major Postgres version upgrades by leveraging the Spock extension's zero downtime add node capability. With this approach, you can add a new node to your existing Database with the `postgres_version` set to the new version. -For example, to gradually move a single node Database running Postgres 17.6 to 18.1: +The Control Plane supports major Postgres version upgrades by leveraging the Spock extension's zero downtime add node capability. With this approach, you can add a new node to your existing database with the `postgres_version` set to the new version. + + +For example, to gradually move a single node database running Postgres 17.6 to 18.1: === "curl" @@ -119,9 +121,10 @@ For example, to gradually move a single node Database running Postgres 17.6 to 1 }' ``` -Once the update operation completes, the newly added node will be running Postgres 18.1, and the existing node remains operational running Postgres 17.6. Both nodes remain writeable during this operation. This allows for easier migration of your applications to the new node. +Once the update operation completes, the newly added node will be running Postgres 18.1, and the existing node remains operational, running Postgres 17.6. Both nodes remain writeable during this operation. This allows for easier migration of your applications to the new node. -Once you are satisfied with the upgraded node, you can perform an additional update to remove the old node from your Database spec, and update the `postgres_version` field across your database to 18.1. For example: + +Once you are satisfied with the upgraded node, you can perform an additional update to remove the old node from your database spec, and update the `postgres_version` field across your database to 18.1. For example: === "curl" @@ -150,16 +153,20 @@ Once you are satisfied with the upgraded node, you can perform an additional upd !!! tip - This approach is supported for both single region and distributed deployments. You can also choose to use the same host for the upgraded node, assuming you have the availabile space and compute power to run both instances side by side. + This approach is supported for both single region and distributed deployments. You can also choose to use the same host for the upgraded node, assuming you have the available space and compute power to run both instances side by side. + -Outside of this approach, The Control Plane doesn't currently support other mechanisms for performing in-place major Postgres version upgrades. -As an alternative to using the zero downtime add node approach, you can also [create a new Database](./create-db.md) with your desired version, and then use [`pg_dump`](https://www.postgresql.org/docs/current/backup-dump.html) to migrate your data to the new database. +Outside of this approach, the Control Plane doesn't currently support other mechanisms for performing in-place major version upgrades of Postgres. + +As an alternative to using the zero downtime add node approach, you can also [create a new database](./create-db.md) with your desired version, and then use [`pg_dump`](https://www.postgresql.org/docs/current/backup-dump.html) to migrate your data to the new database. !!! warning - You should thoroughly test major version upgrade scenarios in a separate environment before proceeding on your production database. In addition, you should review the [Backup and Restore](./backup-restore.md) documentation to ensure you have appropriate backups of your database, and that you are prepared to restore in the event of unforseen problems. +You should thoroughly test major version upgrade scenarios in a non-production environment before upgrading your production database. Additionally, we recommend you review the [Backup and Restore](./backup-restore.md) documentation, and take a fresh backup of your database before upgrading to ensure that you are prepared to restore in the event you run into problems. + + ## Which Versions Are Available