diff --git a/product_docs/docs/tpa/23/INSTALL.mdx b/product_docs/docs/tpa/23/INSTALL.mdx index 9a835595db1..95fa9708d61 100644 --- a/product_docs/docs/tpa/23/INSTALL.mdx +++ b/product_docs/docs/tpa/23/INSTALL.mdx @@ -109,6 +109,10 @@ privileges. You may use any other means to run the commands as root. Next, run `tpaexec setup` to create an isolated Python environment and install the correct versions of all required modules. +!!! Note + On Ubuntu versions prior to 20.04, please use `sudo -H tpaexec setup` + (to avoid subsequent permission errors during `tpaexec configure`) + ```bash $ sudo /opt/EDB/TPA/bin/tpaexec setup ``` diff --git a/product_docs/docs/tpa/23/architecture-BDR-Always-ON.mdx b/product_docs/docs/tpa/23/architecture-BDR-Always-ON.mdx index e6d17ca0c7f..4db02d26694 100644 --- a/product_docs/docs/tpa/23/architecture-BDR-Always-ON.mdx +++ b/product_docs/docs/tpa/23/architecture-BDR-Always-ON.mdx @@ -4,9 +4,15 @@ originalFilePath: architecture-BDR-Always-ON.md --- -BDR in an Always-ON configuration, intended for use in production. +EDB Postgres Distributed 4 or below in an Always-ON configuration, +suitable for use in test and production. -In BDR-Always-ON architecture we have four variants, which can be +This architecture requires a subscription to the legacy 2ndQuadrant +repositories, and some options require a subscription to EDB Repos 1.0. +See [How TPA uses 2ndQuadrant and EDB repositories](reference/2q_and_edb_repositories) +for more detail on this topic. + +The BDR-Always-ON architecture has four variants, which can be selected with the `--layout` configure option: 1. bronze: 2×bdr+primary, bdr+witness, barman, 2×harp-proxy diff --git a/product_docs/docs/tpa/23/architecture-M1.mdx b/product_docs/docs/tpa/23/architecture-M1.mdx index 4ce8ebcf2fa..e06007be119 100644 --- a/product_docs/docs/tpa/23/architecture-M1.mdx +++ b/product_docs/docs/tpa/23/architecture-M1.mdx @@ -6,7 +6,19 @@ originalFilePath: architecture-M1.md A Postgres cluster with a primary and a streaming replica, one Barman server, and any number of additional replicas cascaded from the first -one. +one. This architecture is suitable for testing, demonstrating and +learning. We plan to release a production primary/standby architecture +for TPA in the near future. + +In default configuration this architecture uses open source software +only. To use subscription-only EDB software with this architecture +requires credentials for EDB Repos 1.0. If you choose EDB Advanced +Server (EPAS) you will also require credentials for the legacy +2ndQuadrant repos. +See [How TPA uses 2ndQuadrant and EDB repositories](reference/2q_and_edb_repositories) +for more detail on this topic. + +## Default layout By default, the primary has one read-only replica attached in the same location; the replica, in turn, has one cascaded replica attached in a diff --git a/product_docs/docs/tpa/23/architecture-PGD-Always-ON.mdx b/product_docs/docs/tpa/23/architecture-PGD-Always-ON.mdx index 9d1afba5b00..d838f06b1ba 100644 --- a/product_docs/docs/tpa/23/architecture-PGD-Always-ON.mdx +++ b/product_docs/docs/tpa/23/architecture-PGD-Always-ON.mdx @@ -4,9 +4,11 @@ originalFilePath: architecture-PGD-Always-ON.md --- -EDB Postgres Distributed in an Always-ON configuration, intended for use in production. +EDB Postgres Distributed 5 in an Always-ON configuration, +suitable for use in test and production. -This architecture is meant for use with PGD (BDR) version 5 only. +This architecture is valid for use with PGD version 5 only and requires +a subscription to [EDB Repos 2.0](reference/2q_and_edb_repositories). ## Cluster configuration diff --git a/product_docs/docs/tpa/23/misc-troubleshooting.mdx b/product_docs/docs/tpa/23/misc-troubleshooting.mdx index 5d854fec4af..2a22a12de13 100644 --- a/product_docs/docs/tpa/23/misc-troubleshooting.mdx +++ b/product_docs/docs/tpa/23/misc-troubleshooting.mdx @@ -20,7 +20,8 @@ To create a new virtual environment (assuming tpaexec was installed into the def [tpa]$ sudo /opt/EDB/TPA/bin/tpaexec setup ``` -\###Strange AWS errors regarding credentials +### Strange AWS errors regarding credentials + If the time & date of the TPA server isn't correct, you can get AWS errors similar to this during provisioning: ``` diff --git a/product_docs/docs/tpa/23/reference/2q_and_edb_repositories.mdx b/product_docs/docs/tpa/23/reference/2q_and_edb_repositories.mdx index fe97c4635be..a60d14374ec 100644 --- a/product_docs/docs/tpa/23/reference/2q_and_edb_repositories.mdx +++ b/product_docs/docs/tpa/23/reference/2q_and_edb_repositories.mdx @@ -32,6 +32,10 @@ ensure that you have a valid subscription for all the sources used and that you have [exported the token](#authenticating-with-package-sources) before running `tpaexec deploy` or the operation will fail. +!!! Note + EDB is in the process of publishing all software through Repos 2.0, + and will eventually remove the older repositories. + ## Authenticating with package sources To use [EDB Repos 2.0](https://www.enterprisedb.com/repos/) you must @@ -58,15 +62,18 @@ register for access at ## How sources are selected by default -For M1 and BDR-Always-ON architectures, the default source is -2ndQuadrant and the necessary repositories will be added from this -source. For software that is not available from this source (e.g EDB -Advanced Server), repositories will be selected from EDB Repos 1.0. - If the PGD-Always-ON architecture is selected, repositories will be selected from EDB Repos 2.0 and all software will be sourced from these repositories. +For M1 and BDR-Always-ON architectures, the default source is +2ndQuadrant, and the necessary repositories will be added from this +source. In addition, the PGDG repositories will be used for community +packages such as PostgreSQL and etcd as required. +If EDB software not available in the 2ndQuadrant repos is required +(e.g. EDB Advanced Server), repositories will be selected from EDB Repos +1.0. + ## Specifying EDB 2.0 repositories To specify the complete list of repositories from EDB Repos 2.0 to @@ -80,8 +87,8 @@ cluster_vars: - postgres_distributed ``` -This example will install enterprise subscription repository as well as -postgres_distributed giving access to EPAS and BDR4+ products. +This example will configure the `enterprise` and `postgres_distributed` +repositories, giving access to EPAS and PGD5 products. On Debian and Ubuntu systems, it will use the APT repository, and on RedHat systems, it will use the YUM repository. @@ -106,7 +113,7 @@ On Debian and Ubuntu systems, it will use the APT repository, and on RedHat systems, it will use the YUM repository. The `dl/default/release` repository is always installed by default, -unless you +unless you - explicitly set `tpa_2q_repositories: []`, or - have at least one entry in `edb_repositories`. diff --git a/product_docs/docs/tpa/23/reference/barman.mdx b/product_docs/docs/tpa/23/reference/barman.mdx index 2ddd933f568..e53b021dd71 100644 --- a/product_docs/docs/tpa/23/reference/barman.mdx +++ b/product_docs/docs/tpa/23/reference/barman.mdx @@ -1,5 +1,5 @@ --- -title: 'Barman' +title: Barman originalFilePath: barman.md --- diff --git a/product_docs/docs/tpa/23/reference/bdr.mdx b/product_docs/docs/tpa/23/reference/bdr.mdx index 0506a4a5e43..c7c05ddceae 100644 --- a/product_docs/docs/tpa/23/reference/bdr.mdx +++ b/product_docs/docs/tpa/23/reference/bdr.mdx @@ -12,7 +12,7 @@ Access to PGD/BDR packages is through EDB's package repositories only. You must have a valid EDB subscription token to download the packages. This documentation touches on several aspects of BDR configuration, but -we refer you to the [PGD documentation](/pgd/latest) for an authoritative +we refer you to the [PGD documentation](https://enterprisedb.com/docs/pgd/latest/) for an authoritative description of the details. ## Introduction diff --git a/product_docs/docs/tpa/23/reference/edb_repositories.mdx b/product_docs/docs/tpa/23/reference/edb_repositories.mdx index e2d8cd76bf4..9134f76a031 100644 --- a/product_docs/docs/tpa/23/reference/edb_repositories.mdx +++ b/product_docs/docs/tpa/23/reference/edb_repositories.mdx @@ -4,10 +4,10 @@ originalFilePath: edb_repositories.md --- -This page explains how to configure EDB Repos 2.0 package repositories +This page explains how to configure EDB Repos 2.0 package repositories on any system. -For more details on the EDB and 2ndQuadrant package sources used by +For more details on the EDB and 2ndQuadrant package sources used by TPA see [this page](2q_and_edb_repositories). To specify the complete list of repositories from EDB Repos 2.0 to @@ -21,8 +21,8 @@ cluster_vars: - postgres_distributed ``` -This example will install enterprise subscription repository as well as -postgres_distributed giving access to EPAS and BDR4+ products. +This example will install the enterprise subscription repository as well +as postgres_distributed giving access to EPAS and PGD5 products. On Debian and Ubuntu systems, it will use the APT repository, and on RedHat systems, it will use the YUM repository. diff --git a/product_docs/docs/tpa/23/reference/git-credentials.mdx b/product_docs/docs/tpa/23/reference/git-credentials.mdx index b40b83a4616..f2d47c145cb 100644 --- a/product_docs/docs/tpa/23/reference/git-credentials.mdx +++ b/product_docs/docs/tpa/23/reference/git-credentials.mdx @@ -23,6 +23,11 @@ disk on the target instance: `export TPA_GIT_CREDENTIALS=username:token` in your environment before running `tpaexec deploy`. +!!! Note + When deploying to Docker on macOS, you should use only `https://` + repository URLs because Docker containers cannot be accessed by ssh + from the host in this environment. + ## SSH key authentication If you are cloning an SSH repository and have an SSH keypair