Skip to content

Commit 3262b60

Browse files
committed
Add 3 images for docker
Update links to docker.md
1 parent 68e1ac8 commit 3262b60

3 files changed

Lines changed: 74 additions & 8 deletions

File tree

docs/docker/docker-enable-pg-stat-monitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For more information on this extension, see [pg_stat_monitor :octicons-link-exte
66

77
## Enable pg_stat_monitor {.power-number}
88

9-
1. Start the container as shown in [Run in Docker](docker.md#1-start-the-container-power-number), adding the following option to the `docker run` command:
9+
1. Start the container as shown in [Run in Docker](docker.md#start-container), adding the following option to the `docker run` command:
1010

1111
```{.bash data-prompt="$"}
1212
-c shared_preload_libraries=pg_stat_monitor

docs/docker/docker-enable-pg-tde.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For more information, see the [pg_tde documentation :octicons-link-external-16:]
66

77
## Enable pg_tde {.power-number}
88

9-
1. Start the container as shown in [Run in Docker](docker.md#1-start-the-container-power-number), adding the following option to the `docker run` command:
9+
1. Start the container as shown in [Run in Docker](docker.md#start-container), adding the following option to the `docker run` command:
1010

1111
```{.bash data-prompt="$"}
1212
-c shared_preload_libraries=pg_tde

docs/docker/docker.md

Lines changed: 72 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For more information about using Docker, see the [Docker Docs :octicons-link-ext
1010

1111
By default, Docker pulls the image from Docker Hub if it is not available locally.
1212

13-
## 1. Start the container {.power-number}
13+
## 1. Start the container { #start-container .power-number }
1414

1515
Start a Percona Distribution for PostgreSQL container as follows:
1616

@@ -21,7 +21,7 @@ docker run --name container-name -e POSTGRES_PASSWORD=secret -d percona/percona-
2121
Where:
2222

2323
* `container-name` is the name you assign to your container
24-
* `POSTGRES_PASSWORD` is the superuser password
24+
* `POSTGRES_PASSWORD` is the superuser password
2525
* `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (amd64 or arm64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/).
2626

2727
!!! tip
@@ -95,14 +95,15 @@ The Docker image of Percona Distribution for PostgreSQL includes the following c
9595
| `percona-postgresql{{pgversion}}-server` | The PostgreSQL server package. |
9696
| `percona-postgresql-common` | PostgreSQL database-cluster manager. It provides a structure under which multiple versions of PostgreSQL may be installed and/or multiple clusters maintained at one time.|
9797
| `percona-postgresql-client-common`| The manager for multiple PostgreSQL client versions.|
98-
| `percona-postgresql{{pgversion}}-contrib` | A collection of additional PostgreSQLcontrib extensions |
98+
| `percona-postgresql{{pgversion}}-contrib` | A collection of additional PostgreSQLcontrib extensions |
9999
| `percona-postgresql{{pgversion}}-libs`| Libraries for use with PostgreSQL.|
100-
| `percona-pg-stat-monitor{{pgversion}}` | A Query Performance Monitoring tool for PostgreSQL. |
101-
| `percona-pgaudit{{pgversion}}` | Provides detailed session or object audit logging via the standard PostgreSQL logging facility. |
100+
| `percona-pg-stat-monitor{{pgversion}}` | A Query Performance Monitoring tool for PostgreSQL. |
101+
| `percona-pgaudit{{pgversion}}` | Provides detailed session or object audit logging via the standard PostgreSQL logging facility. |
102102
| `percona-pgaudit{{pgversion}}_set_user`| An additional layer of logging and control when unprivileged users must escalate themselves to superuser or object owner roles in order to perform needed maintenance tasks.|
103-
| `percona-pg_repack{{pgversion}}`| rebuilds PostgreSQL database objects.|
103+
| `percona-pg_repack{{pgversion}}`| rebuilds PostgreSQL database objects.|
104104
| `percona-wal2json{{pgversion}}` | a PostgreSQL logical decoding JSON output plugin.|
105105
| `percona-pgvector` | A vector similarity search for PostgreSQL|
106+
| `percona-pg_tde` | An extension to provides data-at-rest encryption for PostgreSQL|
106107
107108
## Connect to Percona Distribution for PostgreSQL from an application in another Docker container
108109
@@ -132,3 +133,68 @@ where:
132133
* `container-name` is the name of your container that you will use to connect to the database container using the `psql` command line client
133134
* `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image.
134135
* `address` is the network address where your database container is running. Use 127.0.0.1, if the database container is running on the local machine/host.
136+
137+
## Run the PostgreSQL with PostGIS image
138+
139+
The `postgres-gis` image includes everything in the standard Percona Distribution for PostgreSQL image plus the [PostGIS :octicons-link-external-16:](https://postgis.net/) extension for storing and manipulating spatial data.
140+
141+
!!! note
142+
PostGIS is licensed under [GNU GPLv2 :octicons-link-external-16:](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). Review the license terms before using this image in your environment.
143+
144+
???+ admonition "Additional image contents"
145+
146+
| Component name | Description |
147+
|---|---|
148+
| `percona-postgis` | Spatial and geographic objects for PostgreSQL |
149+
150+
Start a `postgres-gis` container as follows: to be tested - placeholders
151+
152+
```{.bash data-prompt="$"}
153+
docker run --name container-name -e POSTGRES_PASSWORD=secret -d percona/percona-distribution-postgresql:<!-- to be added: confirm postgres-gis image tag, e.g. ppg17.x-postgres-gis-x.x.x -->
154+
```
155+
156+
Where:
157+
158+
* `container-name` is the name you assign to your container
159+
* `POSTGRES_PASSWORD` is the superuser password
160+
* The image tag identifies the PostGIS-enabled variant. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/) and filter for `gis`.
161+
162+
For more information on deploying and using PostGIS, see [Spatial data handling](../solutions/postgis.md).
163+
164+
## Run the PgBouncer image
165+
166+
[PgBouncer :octicons-link-external-16:](https://www.pgbouncer.org/) is a lightweight connection pooler for PostgreSQL. The Percona PgBouncer image is available separately from the PostgreSQL image and is intended for use alongside it.
167+
168+
Start a PgBouncer container as follows: to be tested - placeholders
169+
170+
```{.bash data-prompt="$"}
171+
docker run --name pgbouncer \
172+
-v /path/to/pgbouncer.ini:/etc/pgbouncer/pgbouncer.ini \
173+
-d percona/percona-pgbouncer:<!-- TBD: confirm pgbouncer image tag, e.g. 1.25.0-1 -->
174+
```
175+
176+
Where:
177+
178+
* `pgbouncer.ini` is your PgBouncer configuration file, mounted into the container. It defines the connection settings to your PostgreSQL instance.
179+
* The image tag specifies the PgBouncer version. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-pgbouncer/tags/).
180+
181+
For more information on configuring PgBouncer, see the [PgBouncer documentation :octicons-link-external-16:](https://www.pgbouncer.org/config.html).
182+
183+
## Run the pgBackRest image
184+
185+
[pgBackRest :octicons-link-external-16:](https://pgbackrest.org/) is a backup and restore solution for PostgreSQL, supporting full, differential, and incremental backups as well as point-in-time recovery. The Percona pgBackRest image is available separately from the PostgreSQL image.
186+
187+
Start a pgBackRest container as follows: to be tested - placeholders
188+
189+
```{.bash data-prompt="$"}
190+
docker run --name pgbackrest \
191+
-v /path/to/pgbackrest.conf:/etc/pgbackrest/pgbackrest.conf \
192+
-d percona/percona-pgbackrest:<!-- TBD: confirm pgbackrest image tag, e.g. 2.57.0-1 -->
193+
```
194+
195+
Where:
196+
197+
* `pgbackrest.conf` is your pgBackRest configuration file, mounted into the container. It defines the connection to your PostgreSQL instance and your backup repository settings.
198+
* The image tag specifies the pgBackRest version. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-pgbackrest/tags/).
199+
200+
For more information on configuring pgBackRest with Percona Distribution for PostgreSQL, see [Backup and disaster recovery](../solutions/backup-recovery.md).

0 commit comments

Comments
 (0)