Skip to content

Commit a31dab0

Browse files
nastena1606nastena1606
committed
DISTPG-114 Doc changes for PG 13
1 parent 9af9a45 commit a31dab0

18 files changed

+180
-209
lines changed

‎source/.res/important.postgresql.uninstall.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
.. important::
33

44
On Debian and other systems that use the apt package manager, such as Ubuntu,
5-
components of Percona Distribution for PostgreSQL 12 can only be installed
6-
together with the server shipped by Percona (percona-postgresql-12). If you
7-
wish to use Percona Distribution for PostgreSQL uninstall the PostgreSQL
8-
package provided by your distribution (postgresql-12) and then install the
5+
components of Percona Distribution for PostgreSQL 13 can only be installed
6+
together with the server shipped by Percona (percona-postgresql-13). If you
7+
wish to use Percona Distribution for PostgreSQL, uninstall the PostgreSQL
8+
package provided by your distribution (postgresql-13) and then install the
99
chosen components from Percona Distribution for PostgreSQL.

‎source/.res/pdp-major-ugrade-swap-ports.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. code-block:: bash
22

3-
$ sudo vim /etc/postgresql/12/main/postgresql.conf
3+
$ sudo vim /etc/postgresql/13/main/postgresql.conf
44
$ port = 5433 # Change to 5432 here
5-
$ sudo vim /etc/postgresql/11/main/postgresql.conf
5+
$ sudo vim /etc/postgresql/12/main/postgresql.conf
66
$ port = 5432 # Change to 5433 here

‎source/.res/pdp-major-upgrade-check-rpm.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. code-block:: bash
2+
3+
$ /usr/pgsql-13/bin/pg_upgrade \
4+
--old-bindir /usr/pgsql-12/bin \
5+
--new-bindir /usr/pgsql-13/bin \
6+
--old-datadir /var/lib/pgsql/12/data \
7+
--new-datadir /var/lib/pgsql/13/data \
8+
--link --check
9+
10+
11+
The ``--check`` flag here instructs ``pg_upgrade`` to only check the upgrade without changing any data.

‎source/.res/pdp-major-upgrade-check.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.. code-block:: bash
22

3-
$ /usr/lib/postgresql/12/bin/pg_upgrade
4-
--old-datadir=/var/lib/postgresql/11/main \
5-
--new-datadir=/var/lib/postgresql/12/main \
6-
--old-bindir=/usr/lib/postgresql/11/bin \
7-
--new-bindir=/usr/lib/postgresql/12/bin \
8-
--old-options '-c config_file=/etc/postgresql/11/main/postgresql.conf' \
9-
--new-options '-c config_file=/etc/postgresql/12/main/postgresql.conf' \
3+
$ /usr/lib/postgresql/13/bin/pg_upgrade
4+
--old-datadir=/var/lib/postgresql/12/main \
5+
--new-datadir=/var/lib/postgresql/13/main \
6+
--old-bindir=/usr/lib/postgresql/12/bin \
7+
--new-bindir=/usr/lib/postgresql/13/bin \
8+
--old-options '-c config_file=/etc/postgresql/12/main/postgresql.conf' \
9+
--new-options '-c config_file=/etc/postgresql/13/main/postgresql.conf' \
1010
--check
1111

1212
The ``--check`` flag here instructs ``pg_upgrade`` to only check the upgrade without changing any data.

‎source/.res/pdp-major-upgrade-rpm.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. code-block:: bash
2+
3+
$ /usr/pgsql-13/bin/pg_upgrade \
4+
--old-bindir /usr/pgsql-12/bin \
5+
--new-bindir /usr/pgsql-13/bin \
6+
--old-datadir /var/lib/pgsql/12/data \
7+
--new-datadir /var/lib/pgsql/13/data \
8+
--link
9+
10+
The ``--link`` flag creates hard links to the files on the old version cluster so you don't need to copy data.
11+
If you don't wish to use the ``--link`` option, make sure that you have enough disk space to store 2 copies of files for both old version and new version clusters.

‎source/.res/pdp-major-upgrade.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.. code-block:: bash
22

3-
$ /usr/lib/postgresql/12/bin/pg_upgrade
4-
--old-datadir=/var/lib/postgresql/11/main \
5-
--new-datadir=/var/lib/postgresql/12/main \
6-
--old-bindir=/usr/lib/postgresql/11/bin \
7-
--new-bindir=/usr/lib/postgresql/12/bin \
8-
--old-options '-c config_file=/etc/postgresql/11/main/postgresql.conf' \
9-
--new-options '-c config_file=/etc/postgresql/12/main/postgresql.conf' \
3+
$ /usr/lib/postgresql/13/bin/pg_upgrade
4+
--old-datadir=/var/lib/postgresql/12/main \
5+
--new-datadir=/var/lib/postgresql/13/main \
6+
--old-bindir=/usr/lib/postgresql/12/bin \
7+
--new-bindir=/usr/lib/postgresql/13/bin \
8+
--old-options '-c config_file=/etc/postgresql/12/main/postgresql.conf' \
9+
--new-options '-c config_file=/etc/postgresql/13/main/postgresql.conf' \
1010
--link
1111

1212
The ``--link`` flag creates hard links to the files on the old version cluster so you don't need to copy data.

‎source/.res/replace.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. |percona| replace:: Percona
33
.. |percona-postgresql| replace:: :program:`percona-postgresql`
4-
.. |percona-platform-postgresql-11| replace:: :program:`percona-postgresql-11`
4+
.. |percona-platform-postgresql-13| replace:: :program:`percona-postgresql-13`
55
.. |percona-platform-postgresql-12| replace:: :program:`percona-postgresql-12`
66
.. |postgresql| replace:: PostgreSQL
77
.. |postgres| replace:: PostgreSQL
@@ -17,7 +17,9 @@
1717
.. |debian| replace:: Debian
1818
.. |ubuntu| replace:: Ubuntu
1919
.. |sudo| replace:: :program:`sudo`
20-
.. |apt-install| replace:: :program:`apt install`
20+
.. |apt-get-install| replace:: :program:`apt-get install`
2121
.. |yum-install| replace:: :program:`yum install`
2222
.. |percona-release| replace:: :program:`percona-release`
2323
.. |rhel| replace:: Red Hat Enterprise Linux
24+
.. |SLA| replace:: `SLA (Service License Agreement)`
25+
.. |GA| replace:: `GA (General Availability)`

‎source/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@
5555
# built documents.
5656
#
5757
# The short X.Y version.
58-
version = '12'
58+
version = '13'
5959
# The full version, including alpha/beta/rc tags.
60-
release = '.'.join([version, '4'])
60+
release = '.'.join([version, '0'])
6161

6262
# The language for content autogenerated by Sphinx. Refer to documentation
6363
# for a list of supported languages.
@@ -118,7 +118,7 @@
118118

119119
# The name for this set of Sphinx documents. If None, it defaults to
120120
# "<project> v<release> documentation".
121-
#html_title = 'Percona Distribution for PostgreSQL 12 Documentation'
121+
#html_title = 'Percona Distribution for PostgreSQL 13 Documentation'
122122
html_title = '' .join ([project, version, 'Documentation'])
123123

124124
# A shorter title for the navigation bar. Default is the same as html_title.
@@ -132,7 +132,7 @@
132132
html_context = {
133133
'repo_name': '/percona/postresql-docs',
134134
'repo_url': 'https://github.com/percona/postgresql-docs',
135-
'edit_uri': 'edit/12/source'
135+
'edit_uri': 'edit/13/source'
136136
}
137137

138138
# The name of an image file (within the static path) to use as favicon of the
@@ -190,7 +190,7 @@
190190
#html_file_suffix = None
191191

192192
# Output file base name for HTML help builder.
193-
htmlhelp_basename = 'PerconaDistributionForPostgreSQL12doc'
193+
htmlhelp_basename = 'PerconaDistributionForPostgreSQL13doc'
194194

195195

196196
# -- Options for LaTeX output --------------------------------------------------
@@ -204,7 +204,7 @@
204204
# Grouping the document tree into LaTeX files. List of tuples
205205
# (source start file, target name, title, author, documentclass [howto/manual]).
206206
latex_documents = [
207-
('index', 'PerconaDistributionForPostgreSQL-12.tex', u'Percona Distribution for PostgreSQL Documentation',
207+
('index', 'PerconaDistributionForPostgreSQL-13.tex', u'Percona Distribution for PostgreSQL Documentation',
208208
u'Percona LLC and/or its affiliates 2009-2020', 'manual'),
209209
]
210210

@@ -242,7 +242,7 @@
242242
# One entry per manual page. List of tuples
243243
# (source start file, name, description, authors, manual section).
244244
man_pages = [
245-
('index', 'perconadistributionforpostgresql12', u'Percona Distribution for PostgreSQL 12 Documentation',
245+
('index', 'perconadistributionforpostgresql13', u'Percona Distribution for PostgreSQL 13 Documentation',
246246
[u'Percona LLC and/or its affiliates 2009-2020'], 1)
247247
]
248248

‎source/index.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ extensions that enable solving essential practical tasks efficiently:
1616
|postgresql|
1717
- `Patroni <https://patroni.readthedocs.io/en/latest/>`_ is an :abbr:`HA (High
1818
Availability)` solution for |postgresql|.
19+
- `pg_stat_monitor <https://github.com/percona/pg_stat_monitor>`_ (Tech Preview Feature [#]_) collects and aggregates statistics for |postgresql| and provides histogram information.
1920
- A collection of `additional PostgreSQL contrib extensions
20-
<https://www.postgresql.org/docs/12/contrib.html>`_
21+
<https://www.postgresql.org/docs/13/contrib.html>`_
2122

2223
.. seealso::
2324

@@ -26,9 +27,10 @@ extensions that enable solving essential practical tasks efficiently:
2627
<https://www.percona.com/blog/2019/05/10/pgbackrest-a-great-backup-solution-and-a-wonderful-year-of-growth/>`_
2728
- `Securing PostgreSQL as an Enterprise-Grade Environment
2829
<https://www.percona.com/blog/2018/09/21/securing-postgresql-as-an-enterprise-grade-environment/>`_
30+
- `Announcing pg_stat_monitor Tech Preview: Get Better Insights Into Query Performance in PostgreSQL <https://www.percona.com/blog/2020/10/14/announcing-pg_stat_monitor-tech-preview-get-better-insights-into-query-performance-in-postgresql/>`_
2931

3032
|pdp| is also shipped with the `libpq
31-
<https://www.postgresql.org/docs/12/libpq.html>`_ library. It contains "a set of
33+
<https://www.postgresql.org/docs/13/libpq.html>`_ library. It contains "a set of
3234
library functions that allow client programs to pass queries to the PostgreSQL
3335
backend server and to receive the results of these queries." [#]_
3436

@@ -61,7 +63,8 @@ Release Notes
6163

6264
release-notes
6365

64-
.. [#] https://www.postgresql.org/docs/12/libpq.html
66+
.. [#] Tech Preview Features are not yet ready for enterprise use and are not included in support via |SLA|. They are included in this release so that users can provide feedback prior to the full release of the feature in a future |GA| release (or removal of the feature if it is deemed not useful). This functionality can change (APIs, CLIs, etc.) from tech preview to GA.
67+
.. [#] https://www.postgresql.org/docs/13/libpq.html
6568
6669
6770
.. include:: .res/replace.txt

‎source/installing.rst

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Installing |pdp|
66
Using repositories provided by |percona| is the recommended way of installing
77
|pdp|.
88

9-
There are two repositories available for |pdp|. We recommend to install |pdp| from the *Major Release repository* (e.g. ``ppg-12``) as it includes the latest version packages. Whenever a package is updated, the package manager of your operating system detects that and prompts you to update. As long as you update all Distribution packages at the same time, you can ensure that the packages you're using have been tested and verified by |percona|.
9+
There are two repositories available for |pdp|. We recommend to install |pdp| from the *Major Release repository* (e.g. ``ppg-13``) as it includes the latest version packages. Whenever a package is updated, the package manager of your operating system detects that and prompts you to update. As long as you update all Distribution packages at the same time, you can ensure that the packages you're using have been tested and verified by |percona|.
1010

11-
The *Minor Release repository* includes a particular minor release of the database and all of the packages that were tested and verified to work with that minor release (e.g. ``ppg-12.4``). You may choose to install |pdp| from the Minor Release repository if you have decided to standardize on a particular release which has passed rigorous testing procedures and which has been verified to work with your applications. This allows you to deploy to a new host and ensure that you'll be using the same version of all the Distribution packages, even if newer releases exist in other repositories.
11+
The *Minor Release repository* includes a particular minor release of the database and all of the packages that were tested and verified to work with that minor release (e.g. ``ppg-13.0``). You may choose to install |pdp| from the Minor Release repository if you have decided to standardize on a particular release which has passed rigorous testing procedures and which has been verified to work with your applications. This allows you to deploy to a new host and ensure that you'll be using the same version of all the Distribution packages, even if newer releases exist in other repositories.
1212

1313
The disadvantage of using a Minor Release repository is that you are locked in this particular release. When potentially critical fixes are released in a later minor version of the database, you will not be prompted for an upgrade by the package manager of your operating system. You would need to change the configured repository in order to install the upgrade.
1414

@@ -24,19 +24,19 @@ Like many other |percona| products, |pdp| is installed from |Percona| repositori
2424
of |percona-release| for details.
2525

2626
As soon as |percona-release| is up-to-date, *set up* the
27-
|pdp| product (``ppg-12``).
27+
|pdp| product (``ppg-13``).
2828

2929
.. code-block:: bash
3030
31-
$ sudo percona-release setup ppg-12
31+
$ sudo percona-release setup ppg-13
3232
3333
.. hint::
3434

3535
The command to set up a minor version product is the following:
3636

3737
.. code-block:: bash
3838
39-
$ sudo percona-release setup ppg-12.4
39+
$ sudo percona-release setup ppg-13.0
4040
4141
Install |pdp| using the commands of your package manager (the procedure differs
4242
depending on the package manager of your operating system).
@@ -55,25 +55,27 @@ The following platforms are supported:
5555
On Debian 9 (stretch), you need to `enable the llvm repository
5656
<https://apt.llvm.org/>`_
5757

58-
Install the |percona-platform-postgresql-12| package using |apt-install|.
58+
Install the |percona-platform-postgresql-13| package using |apt-get-install|.
5959

6060
.. code-block:: bash
6161
62-
$ sudo apt install percona-postgresql-12
62+
$ sudo apt-get install percona-postgresql-13
6363
6464
Note that this package will not install the components. To install these
6565
components use the appropriate packages:
6666

6767
.. code-block:: bash
6868
6969
$ # To install pg_repack
70-
$ sudo apt-get install percona-postgresql-12-repack
70+
$ sudo apt-get install percona-postgresql-13-repack
7171
$ # To Install pgaudit
72-
$ sudo apt-get install percona-postgresql-12-pgaudit
72+
$ sudo apt-get install percona-postgresql-13-pgaudit
7373
$ # To install pgBackRest
7474
$ sudo apt-get install percona-pgbackrest
7575
$ # To install Patroni
7676
$ sudo apt-get install percona-patroni
77+
$ # To install pg_stat_monitor
78+
$ sudo apt-get install percona-pg-stat-monitor13
7779
$ # To install PostgreSQL contrib extensions
7880
$ sudo apt-get install percona-postgresql-contrib
7981
@@ -99,40 +101,42 @@ The following platforms are supported:
99101
$ sudo yum -y install epel-release
100102
$ sudo yum repolist
101103
102-
Install the |percona-platform-postgresql-12| package using |yum-install|.
104+
Install the |percona-platform-postgresql-13| package using |yum-install|.
103105

104106
.. code-block:: bash
105107
106-
$ sudo yum install percona-postgresql12-server
108+
$ sudo yum install percona-postgresql13-server
107109
108110
Note that this package will not install the components. To install these
109111
components use the appropriate packages:
110112

111113
.. code-block:: bash
112114
113115
$ # To install pg_repack
114-
$ sudo yum install percona-pg_repack12
116+
$ sudo yum install percona-pg_repack13
115117
$ # To Install pgaudit
116118
$ sudo yum install percona-pgaudit
117119
$ # To install pgBackRest
118120
$ sudo yum install percona-pgbackrest
119121
$ # To install Patroni
120122
$ sudo yum install percona-patroni
123+
$ # To install pg_stat_monitor
124+
$ yum install percona-pg-stat-monitor13
121125
$ # To install PostgreSQL contrib extensions
122-
$ sudo yum install percona-postgresql12-contrib
126+
$ sudo yum install percona-postgresql13-contrib
123127
124128
.. admonition:: Starting the service
125129

126130
|pdp| is not automatically started after the installation. To start |pdp|, initialize the cluster using the following command:
127131

128132
.. code-block:: bash
129133
130-
/usr/pgsql-12/bin/postgresql-12-setup initdb
134+
/usr/pgsql-13/bin/postgresql-13-setup initdb
131135
132136
Start the |postgresql| service:
133137

134138
.. code-block:: bash
135139
136-
$ sudo systemctl start postgresql-12
140+
$ sudo systemctl start postgresql-13
137141
138142
.. include:: .res/replace.txt

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy