Skip to content

Commit 591cafe

Browse files
authored
Merge pull request #5955 from EnterpriseDB/DOCS-947-tpa-23-34-update-and-release
TPA 23.34 update
2 parents 55b0418 + aeb2f3a commit 591cafe

26 files changed

+267
-381
lines changed

product_docs/docs/tpa/23/INSTALL.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,6 @@ curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-plan>/setup.de
9797
curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-plan>/setup.rpm.sh' | sudo -E bash
9898
```
9999

100-
Alternatively, you may obtain TPA from the legacy 2ndQuadrant
101-
repository. To do so, login to the EDB Customer Support Portal and
102-
subscribe to the ["products/tpa/release" repository](https://techsupport.enterprisedb.com/software_subscriptions/add/products/tpa/)
103-
by adding a subscription under Support/Software/Subscriptions,
104-
and following the instructions to enable the repository on your system.
105-
106100
Once you have enabled one of these repositories, you may install TPA
107101
as follows:
108102

product_docs/docs/tpa/23/architecture-BDR-Always-ON.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@ originalFilePath: architecture-BDR-Always-ON.md
88
EDB Postgres Distributed 3.7 or 4 in an Always-ON
99
configuration, suitable for use in test and production.
1010

11-
This architecture requires a subscription to the legacy 2ndQuadrant
12-
repositories, and some options require a subscription to EDB Repos 1.0.
13-
See [How TPA uses 2ndQuadrant and EDB repositories](reference/2q_and_edb_repositories/)
14-
for more detail on this topic.
11+
This architecture requires an EDB subscription.
12+
All software will be sourced from [EDB Repos 2.0](reference/edb_repositories/).
1513

1614
The BDR-Always-ON architecture has four variants, which can be
1715
selected with the `--layout` configure option:

product_docs/docs/tpa/23/architecture-M1.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ testing, demonstrating and learning due to its simplicity and ability to
1616
be configured with no proprietary components.
1717

1818
If you select subscription-only EDB software with this architecture
19-
it will be sourced from EDB Repos 2.0 and you will need to provide a token.
20-
See [How TPA uses 2ndQuadrant and EDB repositories](reference/2q_and_edb_repositories/)
21-
for more detail on this topic.
19+
it will be sourced from EDB Repos 2.0 and you will need to
20+
[provide a token](reference/edb_repositories/).
2221

2322
## Application and backup failover
2423

@@ -69,11 +68,11 @@ More detail on the options is provided in the following section.
6968

7069
#### Mandatory Options
7170

72-
| Parameter | Description |
73-
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
74-
| `--architecture` (`-a`) | Must be set to `M1`. |
75-
| Postgres flavour and version (e.g. `--postgresql 15`) | A valid [flavour and version specifier](tpaexec-configure/#postgres-flavour-and-version). |
76-
| One of: * `--failover-manager {efm, repmgr, patroni}` * `--enable-efm` * `--enable-repmgr` * `--enable-patroni` | Select the failover manager from [`efm`](reference/efm/), [`repmgr`](reference/repmgr/) and [`patroni`](reference/patroni/). |
71+
| Parameter | Description |
72+
| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
73+
| `--architecture` (`-a`) | Must be set to `M1`. |
74+
| Postgres flavour and version (e.g. `--postgresql 15`) | A valid [flavour and version specifier](tpaexec-configure/#postgres-flavour-and-version). |
75+
| One of: - `--failover-manager {efm, repmgr, patroni}`- `--enable-efm` - `--enable-repmgr`- `--enable-patroni` | Select the failover manager from [`efm`](reference/efm/), [`repmgr`](reference/repmgr/) and [`patroni`](reference/patroni/). |
7776

7877
<br/><br/>
7978

@@ -90,6 +89,7 @@ More detail on the options is provided in the following section.
9089
| `--enable-haproxy` | 2 additional nodes will be added as a load balancer layer.<br/>Only supported with Patroni as the failover manager. | HAproxy nodes will not be added to the cluster. |
9190
| `--enable-pgbouncer` | PgBouncer will be configured in the Postgres nodes to pool connections for the primary. | PgBouncer will not be configured in the cluster. |
9291
| `--patroni-dcs` | Select the Distributed Configuration Store backend for patroni.<br/>Only option is `etcd` at this time. <br/>Only supported with Patroni as the failover manager. | Defaults to `etcd`. |
92+
| `--efm-bind-by-hostname` | Enable efm to use hostnames instead of IP addresses to configure the cluster `bind.address`. | Defaults to use IP addresses |
9393

9494
<br/><br/>
9595

product_docs/docs/tpa/23/architecture-PGD-Always-ON.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,16 @@ originalFilePath: architecture-PGD-Always-ON.md
55

66
---
77

8+
!!! Note
9+
This architecture is for Postgres Distributed 5 only.
10+
If you require PGD 4 or 3.7 please use [BDR-Always-ON](architecture-BDR-Always-ON/).
11+
!!!
12+
813
EDB Postgres Distributed 5 in an Always-ON configuration,
914
suitable for use in test and production.
1015

11-
This architecture is valid for use with EDB Postgres Distributed 5 only
12-
and requires a subscription to [EDB Repos 2.0](reference/2q_and_edb_repositories/).
16+
This architecture requires an EDB subscription.
17+
All software will be sourced from [EDB Repos 2.0](reference/edb_repositories/).
1318

1419
## Cluster configuration
1520

@@ -81,7 +86,8 @@ this definition makes sense to your use case. For example, AWS
8186
regions, your own data centres, or any other designation to identify
8287
where your servers are hosted.
8388

84-
!!! Note for AWS users
89+
90+
!!! Note Note for AWS users
8591

8692
If you are using TPA to provision an AWS cluster, the locations will
8793
be mapped to separate availability zones within the `--region` you

product_docs/docs/tpa/23/configure-cluster.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ All
6363
options translate to config.yml variables in
6464
some way. A single option may affect several variables (e.g.,
6565
`--bdr-version` could set `postgres_version`,
66-
`tpa_2q_repositories`, `edb_repositories`, `extra_postgres_extensions`, and so on), but
66+
`edb_repositories`, `extra_postgres_extensions`, and so on), but
6767
you can always accomplish with an editor what you could by running the
6868
command.
6969

@@ -112,9 +112,9 @@ be translated directly into group variables in the Ansible inventory:
112112
```yaml
113113
cluster_vars:
114114
postgres_version: 14
115-
tpa_2q_repositories:
116-
- products/bdr3/release
117-
- products/pglogical3/release
115+
edb_repositories:
116+
- enterprise
117+
- postgres_distributed
118118
postgres_conf_settings:
119119
bdr.trace_replay: true
120120
```

product_docs/docs/tpa/23/configure-instance.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ to execute tasks before any package repositories are configured.
3838
- [Configure APT repositories](reference/apt_repositories/)
3939
(for Debian and Ubuntu)
4040

41-
- [Configure 2ndQuadrant and EDB repositories](reference/2q_and_edb_repositories/)
41+
- [Configure EDB repositories](reference/edb_repositories/)
4242
(on any system)
4343

4444
- [Configure a local package repository](reference/local-repo/)
@@ -120,11 +120,11 @@ cluster configuration with a minimum of effort.
120120

121121
- [Run initdb to create the PGDATA directory](reference/initdb/)
122122

123-
- [Configure pg_hba.conf](reference/pg_hba_conf/)
123+
- [Configure pg_hba.conf](reference/pg_hba.conf/)
124124

125-
- [Configure pg_ident.conf](reference/pg_ident_conf/)
125+
- [Configure pg_ident.conf](reference/pg_ident.conf/)
126126

127-
- [Configure postgresql.conf](reference/postgresql_conf/)
127+
- [Configure postgresql.conf](reference/postgresql.conf/)
128128

129129
You can use the
130130
[postgres-config hook](tpaexec-hooks/#postgres-config)

product_docs/docs/tpa/23/reference/2q_and_edb_repositories.mdx

Lines changed: 0 additions & 129 deletions
This file was deleted.

product_docs/docs/tpa/23/reference/edb_repositories.mdx

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
---
2-
description: How to configure EDB Repos 2.0 package repositories on any system.
2+
description: How to configure EDB Repos 2.0 package repositories.
33
title: Configuring EDB Repos 2.0 repositories
44
originalFilePath: edb_repositories.md
55

66
---
77

8-
This page explains how to configure EDB Repos 2.0 package repositories
9-
on any system.
8+
TPA sources EDB software from
9+
[EDB Repos 2.0](https://www.enterprisedb.com/repos/).
10+
To use EDB Repos 2.0 you must `export EDB_SUBSCRIPTION_TOKEN=xxx`
11+
before you run tpaexec.
12+
You can get your subscription token from
13+
[the web interface](https://www.enterprisedb.com/repos-downloads).
1014

11-
For more details on the EDB and 2ndQuadrant package sources used by
12-
TPA see [this page](2q_and_edb_repositories/).
15+
!!!Note
16+
17+
If you create your `config.yml` file using the `tpaexec configure`
18+
command, the `edb_repositories` key will be automatically populated with
19+
the necessary repositories for your selected configuration, so you
20+
shouldn't need to edit it.
21+
!!!
1322

1423
To specify the complete list of repositories from EDB Repos 2.0 to
1524
install on each instance, set `edb_repositories` to a list of EDB
@@ -22,16 +31,8 @@ cluster_vars:
2231
- postgres_distributed
2332
```
2433
25-
This example will install the enterprise subscription repository as well
26-
as postgres_distributed giving access to EPAS and PGD5 products.
34+
This example will install the 'enterprise' subscription repository as
35+
well as 'postgres_distributed' giving access to EPAS and PGD products.
2736
On Debian or Ubuntu systems, it will use the APT repository and on
2837
RedHat or SLES systems, it will use the rpm repositories, through the yum
2938
or zypper frontends respectively.
30-
31-
If any EDB repositories are specified, any 2ndQuadrant repositories
32-
specified will be ignored and no EDB Repos 1.0 will be installed.
33-
34-
To use [EDB Repos 2.0](https://www.enterprisedb.com/repos/) you must
35-
`export EDB_SUBSCRIPTION_TOKEN=xxx` before you run tpaexec. You can get
36-
your subscription token from [the web
37-
interface](https://www.enterprisedb.com/repos-downloads).

product_docs/docs/tpa/23/reference/efm.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ TPA will generate `efm.nodes` and `efm.properties` with the appropriate
1717
instance-specific settings, with remaining settings set to the respective
1818
default values. TPA will also place an `efm.notification.sh` script which
1919
basically contains nothing by default and leaves it up to the user to fill it
20-
in however they want.
20+
in however they want. TPA will override the default settings for
21+
`auto.allow.hosts` and `stable.nodes.file` to simplify adding agents
22+
to the cluster.
2123

2224
See the [EFM documentation](https://www.enterprisedb.com/docs/efm/latest/)
2325
for more details on EFM configuration.
@@ -31,11 +33,8 @@ would appear in `efm.properties`:
3133
```yaml
3234
cluster_vars:
3335
efm_conf_settings:
34-
standby.restart.delay: 1
35-
application.name: quarry
36-
reconfigure.num.sync: true
37-
reconfigure.num.sync.max: 1
38-
reconfigure.sync.primary: true
36+
notification.level=WARNING
37+
ping.server.ip=<well known address in network>
3938
```
4039
4140
If you make changes to values under `efm_conf_settings`, TPA will always

product_docs/docs/tpa/23/reference/patroni.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ DCS config to be sent to the API and stored in the bootstrap section
8181
of the config file:
8282

8383
- TPA vars for `postgres` are loaded into the DCS settings,
84-
see [postgresql.conf.md](postgresql_conf/).
84+
see [postgresql.conf.md](postgresql.conf/).
8585
Some features are not supported, see notes below.
8686
- Patroni defaults for DCS settings
8787
- User supplied defaults in `patroni_dynamic_conf_settings`, if you want

0 commit comments

Comments
 (0)