Skip to content

Commit 53645ea

Browse files
authored
Merge pull request #49 from nastena1606/DISTPG-165-Doc-installation-improvements-13
DISTPG-165 Doc:Enhanced install instructions
2 parents 5f94b52 + 52e052b commit 53645ea

File tree

1 file changed

+90
-30
lines changed

1 file changed

+90
-30
lines changed

source/installing.rst

Lines changed: 90 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,52 +3,74 @@
33
Installing |pdp|
44
********************************************************************************
55

6-
Using repositories provided by |percona| is the recommended way of installing
7-
|pdp|.
6+
.. contents::
7+
:local:
88

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|.
9+
Percona provides installation packages in ``DEB`` and ``RPM`` format for 64-bit Linux distributions. Find the full list of supported platforms on the `Percona Software and Platform Lifecycle page <https://www.percona.com/services/policies/percona-software-support-lifecycle#pgsql>`_.
10+
11+
Like many other |percona| products, we recommend installing |pdp| from Percona repositories by using the |percona-release| utility. The |percona-release| utility automatically enables the required repository for you so you can easily install and update |pdp| packages and their dependencies through the package manager of your operating system.
12+
13+
The installation process includes the following steps:
14+
15+
1. Install |percona-release|
16+
2. Enable the repository
17+
3. Install the packages
18+
4. Start the ``postgresql`` service
19+
5. Connect to the server
20+
21+
.. _repo-overview:
22+
23+
Repositories overview
24+
======================
25+
26+
There are two repositories available for |pdp|. We recommend installing |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|.
1027

1128
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.1``). 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.
1229

1330
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.
1431

15-
-------
32+
.. _install-percona-release:
1633

17-
Like many other |percona| products, |pdp| is installed from |Percona| repositories by using the |percona-release| utility.
34+
Install |percona-release|
35+
===========================
36+
Install |percona-release| utility. If you have installed it before, update it to the latest version. Refer to `Percona repositories documentation <https://www.percona.com/doc/percona-repo-config/percona-release.html>`_ for installation / update instructions.
1837

19-
.. important::
38+
.. _enable-repo:
39+
40+
Enable the repository
41+
=====================
2042

21-
Before you attempt to install |pdp|, update |percona-release| to
22-
its latest version. `See the documentation
23-
<https://www.percona.com/doc/percona-repo-config/percona-release.html#percona-release-update-latest-version>`_
24-
of |percona-release| for details.
43+
As soon as |percona-release| is installed or up-to-date, enable the repository for |pdp| (``ppg-13``). We recommend using the *set up* command as it enables the specified repository and updates the platform's package manager database.
2544

26-
As soon as |percona-release| is up-to-date, *set up* the
27-
|pdp| product (``ppg-13``).
45+
To install the *latest* version of |pdp|, enable the Major Release repository using the following command:
2846

2947
.. code-block:: bash
3048
3149
$ sudo percona-release setup ppg-13
3250
33-
.. hint::
51+
To install a *specific minor version* of |pdp|, enable the Minor release repository. For example, to install |pdp| 13.1, enable the ``ppg-13.1`` repository using the following command:
3452

35-
The command to set up a minor version product is the following:
53+
.. code-block:: bash
3654
37-
.. code-block:: bash
38-
39-
$ sudo percona-release setup ppg-13.1
40-
41-
Install |pdp| using the commands of your package manager (the procedure differs
42-
depending on the package manager of your operating system).
55+
$ sudo percona-release setup ppg-13.1
4356
44-
Using the |deb| Format
45-
================================================================================
57+
Install |pdp| packages
58+
======================
4659

47-
.. include:: .res/important.postgresql.uninstall.txt
60+
After you've :ref:`installed percona-release <install-percona-release>` and :ref:`enabled the desired repository <enable-repo>`, install |pdp| using the commands of your package manager (the procedure differs
61+
depending on the package manager of your operating system).
4862

49-
The following platforms are supported:
63+
On Debian and Ubuntu
64+
-----------------------------
65+
66+
.. important::
5067

51-
.. include:: .res/list.supported-platform.deb.txt
68+
On Debian and other systems that use the ``apt`` package manager, such as Ubuntu,
69+
components of Percona Distribution for PostgreSQL 13 can only be installed
70+
together with the server shipped by Percona (percona-postgresql-13). If you
71+
wish to use Percona Distribution for PostgreSQL, uninstall the PostgreSQL
72+
package provided by your distribution (postgresql-13) and then install the
73+
chosen components from Percona Distribution for PostgreSQL.
5274

5375
.. admonition:: Platform Specific Notes
5476

@@ -79,12 +101,18 @@ components use the appropriate packages:
79101
$ # To install PostgreSQL contrib extensions
80102
$ sudo apt-get install percona-postgresql-contrib
81103
104+
.. admonition:: Starting the service
105+
106+
The installation process automatically initializes the default database. Thus, to start |pdp|, use the following command:
107+
108+
.. code-block:: bash
109+
110+
$ sudo pg_ctlcluster 13 main start
82111
83-
Using the |rpm| Format
84-
================================================================================
85-
The following platforms are supported:
112+
Next steps: :ref:`connect to PostgreSQL <server-connect>`.
86113

87-
.. include:: .res/list.supported-platform.rpm.txt
114+
On |rhel| and CentOS
115+
------------------------
88116

89117
.. admonition:: Platform Specific Notes
90118

@@ -127,7 +155,7 @@ components use the appropriate packages:
127155
128156
.. admonition:: Starting the service
129157

130-
|pdp| is not automatically started after the installation. To start |pdp|, initialize the cluster using the following command:
158+
After the installation, the default database storage is not automatically initialized. To complete the installation and start |pdp|, initialize the database using the following command:
131159

132160
.. code-block:: bash
133161
@@ -139,4 +167,36 @@ components use the appropriate packages:
139167
140168
$ sudo systemctl start postgresql-13
141169
170+
.. _server-connect:
171+
172+
Connect to the PostgreSQL server
173+
=================================
174+
175+
By default, ``postgres`` user and ``postgres`` database are created in PostgreSQL upon its installation and initialization. This allows you to connect to the database as the ``postgres`` user.
176+
177+
.. code-block:: bash
178+
179+
$ sudo su postgres
180+
181+
Open the PostgreSQL interactive terminal:
182+
183+
.. code-block:: bash
184+
185+
$ psql
186+
187+
.. hint::
188+
189+
You can connect to ``psql`` as the ``postgres`` user in one go:
190+
191+
.. code-block:: bash
192+
193+
$ sudo su postgres psql
194+
195+
To exit the ``psql`` terminal, use the following command:
196+
197+
.. code-block:: bash
198+
199+
$ \q
200+
201+
142202
.. 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