Skip to content

Commit b153118

Browse files
authored
PG-2209 - Update Quickstart Guide (#925)
This PR updates the quick start guide, rewriting it to include information for new users and 2 minute installations, as well as providing hooks for the user to continue to explore PPG or PG.
1 parent 88c2d43 commit b153118

5 files changed

Lines changed: 139 additions & 20 deletions

File tree

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Part of the solution, Percona Operator for PostgreSQL, makes it easy to orchestr
2020

2121
<div data-grid markdown><div data-banner markdown>
2222

23-
### :material-progress-download: Installation guides { .title }
23+
### :material-progress-download: Quickstart guide { .title }
2424

25-
Get started quickly with the step-by-step installation instructions.
25+
Get started quickly with these step-by-step installation instructions.
2626

27-
[Quickstart guides :material-arrow-right:](installing.md){ .md-button }
27+
[Quickstart guide :material-arrow-right:](quick-start.md){ .md-button }
2828

2929
</div><div data-banner markdown>
3030

docs/installing.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
# Quickstart guide
1+
# Installation overview
22

3-
Percona Distribution for PostgreSQL is the Percona server for PostgreSQL with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. [Read more](index.md).
3+
Percona Distribution for PostgreSQL packages PostgreSQL together with a curated set of open source extensions and tools that are tested to work together reliably.
44

5-
This document aims to guide database application developers and DevOps engineers in getting started with Percona Distribution for PostgreSQL. Upon completion of this guide, you’ll have Percona Distribution for PostgreSQL installed and operational, and you’ll be able to:
5+
This section explains how to install Percona Distribution for PostgreSQL on supported platforms.
66

7-
* Connect to PostgreSQL using the `psql` interactive terminal
8-
* Interact with PostgreSQL with basic psql commands
9-
* Manipulate data in PostgreSQL
10-
* Understand the next steps you can take as a database application developer or administrator to expand your knowledge of Percona Distribution for PostgreSQL
7+
Choose the installation method that best fits your environment:
118

12-
## Install Percona Distribution for PostgreSQL
13-
14-
You can select from multiple easy-to-follow installation options, however **we strongly recommend using a Package Manager** for a convenient and quick way to try the software first.
9+
- Package manager, **recommended** for most Linux systems
10+
- Docker, for quick evaluations or development
11+
- Kubernetes, for production Kubernetes environments
12+
- Tarballs, manual installation for custom environments (**not recommended** for mission-critical environments)
1513

1614
=== ":octicons-terminal-16: Package manager"
1715

18-
Percona provides installation packages in `DEB` and `RPM` format for 64-bit Linux distributions. Find the full list of supported platforms and versions on the [Percona Software and Platform Lifecycle page :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle#pgsql).
16+
Percona provides installation packages in `DEB` and `RPM` format for 64-bit Linux distributions. See the [Percona Software and Platform Lifecycle page :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle#pgsql) for the full list of supported platforms and versions.
1917

2018
If you are on Debian or Ubuntu, use `apt` for installation.
2119

@@ -26,15 +24,15 @@ You can select from multiple easy-to-follow installation options, however **we s
2624

2725
=== ":simple-docker: Docker"
2826

29-
Get our image from Docker Hub and spin up a cluster on a Docker container for quick evaluation.
27+
Run Percona Distribution for PostgreSQL in a Docker container for quick evaluation or development.
3028

3129
Check below to get access to a detailed step-by-step guide.
3230

3331
[Run in Docker :material-arrow-right:](docker.md){.md-button}
3432

3533
=== ":simple-kubernetes: Kubernetes"
3634

37-
**Percona Operator for Kubernetes** is a controller introduced to simplify complex deployments that require meticulous and secure database expertise.
35+
Use the Percona Operator for Kubernetes to deploy and manage PostgreSQL clusters on Kubernetes.
3836

3937
Check below to get access to a detailed step-by-step guide.
4038

@@ -49,4 +47,5 @@ You can select from multiple easy-to-follow installation options, however **we s
4947
!!! note
5048

5149
This method is **not recommended** for mission-critical environments.
52-
[Install from tarballs :material-arrow-right:](tarball.md){.md-button}
50+
51+
[Install from tarballs :material-arrow-right:](tarball.md){.md-button}

docs/postgresql-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ These enhancements serve as the foundation for Percona-authored extensions, such
1313

1414
For details about available extensions, see the [Percona-authored extensions topic](percona-ext.md).
1515

16-
For a broader overview of integrated tooling and deployment guidance, start with the [Percona Distribution for PostgreSQL Quickstart guide](installing.md).
16+
For a broader overview of integrated tooling and deployment guidance, start with the [Percona Distribution for PostgreSQL Quickstart guide](quick-start.md).

docs/quick-start.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Quickstart guide
2+
3+
This guide shows how to install and start Percona Distribution for PostgreSQL on Debian- and RHEL-based Linux systems. After completing this guide, you will have:
4+
5+
- PostgreSQL running locally
6+
- A database named `test`
7+
- A table named `customers`
8+
- One inserted row you can query
9+
10+
## Fast path (2-minute install)
11+
12+
```{.bash data-prompt="$"}
13+
wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb
14+
sudo dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb
15+
sudo percona-release setup ppg-18
16+
sudo apt install percona-postgresql-18
17+
sudo -i -u postgres psql
18+
```
19+
20+
After psql starts, run the following SQL commands:
21+
22+
```sql
23+
CREATE DATABASE test;
24+
\c test
25+
CREATE TABLE customers (first_name VARCHAR(50), last_name VARCHAR(50), email VARCHAR(100));
26+
INSERT INTO customers VALUES ('John','Doe','john.doe@example.com');
27+
SELECT * FROM customers;
28+
\q
29+
```
30+
31+
For a step-by-step explanation, continue below.
32+
33+
## Install on Debian / Ubuntu (APT) {.power-number}
34+
35+
1. Fetch the `percona-release` package:
36+
37+
```{.bash data-prompt="$"}
38+
wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb
39+
sudo dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb
40+
```
41+
42+
2. Enable the repository and install the package:
43+
44+
```{.bash data-prompt="$"}
45+
sudo percona-release setup ppg-18
46+
sudo apt install percona-postgresql-18
47+
```
48+
49+
The installation process automatically initializes and starts the default database.
50+
51+
!!! note
52+
On Debian and Ubuntu systems, the `postgresql` service may show as `active (exited)`. This is expected.
53+
54+
3. Switch to the `postgres` user and open the psql interactive terminal:
55+
56+
```{.bash data-prompt="$"}
57+
sudo -i -u postgres
58+
psql
59+
```
60+
61+
4. Create a database and make a table in the database:
62+
63+
```sql
64+
CREATE DATABASE test;
65+
\c test
66+
CREATE TABLE customers (first_name VARCHAR(50), last_name VARCHAR(50), email VARCHAR(100));
67+
```
68+
69+
5. Insert data in the customers table and query the data insertion:
70+
71+
```sql
72+
INSERT INTO customers (first_name, last_name, email) VALUES ('John', 'Doe', 'john.doe@example.com');
73+
SELECT * FROM customers;
74+
\q
75+
```
76+
77+
Congratulations! Percona Distribution for PostgreSQL is now running and you have created your first database.
78+
79+
For detailed installation steps and further instructions on Debian and Ubuntu, see the [Install Percona Distribution for PostgreSQL on Debian and Ubuntu](apt.md).
80+
81+
For detailed installation steps and further instructions on Red Hat Enterprise Linux and derivatives, see the [Install Percona Distribution for PostgreSQL on Red Hat Enterprise Linux and derivatives](yum.md).
82+
83+
## What's next
84+
85+
Now that your PostgreSQL server is running, you can explore additional capabilities of Percona Distribution for PostgreSQL.
86+
87+
<div data-grid markdown><div data-banner markdown>
88+
89+
### Learn PostgreSQL basics { .title }
90+
91+
Connect with `psql` and run SQL commands, manage users, roles, and configure authentication.
92+
93+
[Manipulate data in PostgreSQL :material-arrow-right:](crud.md){ .md-button }
94+
95+
</div><div data-banner markdown>
96+
97+
### Enable extensions { .title }
98+
99+
Percona Distribution for PostgreSQL includes tested open source extensions, such as `pg_stat_monitor` for query performance monitoring, `pg_tde` for protecting data at rest and more.
100+
101+
[See Extensions :material-arrow-right:](extensions.md){ .md-button }
102+
103+
</div><div data-banner markdown>
104+
105+
### Configure backups { .title }
106+
107+
For production deployments we recommend configuring backups.
108+
109+
[See Backup and disaster recovery in Percona :material-arrow-right:](solutions/backup-recovery.md){.md-button}
110+
</div><div data-banner markdown>
111+
112+
### Configure high availability with Patroni { .title }
113+
114+
Deploy a highly available PostgreSQL cluster using Patroni to prevent service interruptions.
115+
116+
[See High Availability in PostgreSQL :material-arrow-right:](solutions/high-availability.md){.md-button}
117+
118+
</div>
119+
</div>

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ nav:
1717
- 'Home': 'index.md'
1818
- 'Percona Server for PostgreSQL': postgresql-server.md
1919
- get-help.md
20+
- Quickstart guide: quick-start.md
2021
- Get started:
21-
- Quickstart guide: installing.md
22-
- 1. Install:
22+
- 1. Install:
23+
- Overview: installing.md
2324
- Via apt: apt.md
2425
- Via yum: yum.md
2526
- From tarballs: tarball.md

0 commit comments

Comments
 (0)