Skip to content

Commit

Permalink
Merge pull request #3838 from EnterpriseDB/docs/pgd/link-fixes-and-tp…
Browse files Browse the repository at this point in the history
…a-option-updates

PGD Quickstart link fixes, TPA option change
  • Loading branch information
drothery-edb authored Mar 23, 2023
2 parents b8da223 + 520e08a commit efbbabe
Showing 3 changed files with 13 additions and 10 deletions.
5 changes: 3 additions & 2 deletions product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx
Original file line number Diff line number Diff line change
@@ -134,7 +134,7 @@ tpaexec configure democluster \
```

We specify the PGD-Always-ON architecture (`--architecture PGD-Always-ON`): this sets up the configuration for [PGD 5's Always On architectures](/pgd/latest/architectures/). As part of the default architecture,
this configures our cluster with three data nodes, co-hosting three [PGD Proxy](routing/proxy/) servers, along with a [Barman](backup#physical-backup) node for backup.
this configures our cluster with three data nodes, co-hosting three [PGD Proxy](../routing/proxy/) servers, along with a [Barman](../backup#physical-backup) node for backup.

We specify using AWS (`--platform aws`) and eu-west-1 as the region (`--region eu-west-1`).

@@ -169,7 +169,8 @@ less democluster/config.yml
```shell
tpaexec configure --architecture PGD-Always-ON --help
```
- More details on PGD-Always-ON configuration options in [Deploying with TPA](tpa)
- More details on PGD-Always-ON configuration options in [Deploying with TPA](../tpa)
- [PGD-Always-ON](/tpa/latest/architecture-PGD-Always-ON/) in the Trusted Postgres Architect documentation
- [`tpaexec configure`](/tpa/latest/tpaexec-configure/) in the Trusted Postgres Architect documentation
- [AWS platform](/tpa/latest/platform-aws/) in the Trusted Postgres Architect documentation

8 changes: 4 additions & 4 deletions product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx
Original file line number Diff line number Diff line change
@@ -160,8 +160,8 @@ tpaexec configure democluster \
--hostnames-unsorted
```

We specify the PGD-Always-ON architecture (`--architecture PGD-Always-ON`): this sets up the configuration for [PGD 5's Always On architectures](/pgd/latest/architectures/). As part of the default architecture,
this configures our cluster with three data nodes, co-hosting three [PGD Proxy](routing/proxy/) servers, along with a [Barman](backup#physical-backup) node for backup.
We specify the PGD-Always-ON architecture (`--architecture PGD-Always-ON`): this sets up the configuration for [PGD 5's Always On architectures](../architectures/). As part of the default architecture,
this configures our cluster with three data nodes, co-hosting three [PGD Proxy](../routing/proxy/) servers, along with a [Barman](../backup#physical-backup) node for backup.

We specify using Docker (`--platform docker`). By default, TPA configures Rocky Linux as the default image for all nodes.

@@ -189,8 +189,8 @@ less democluster/config.yml
```shell
tpaexec configure --architecture PGD-Always-ON --help
```
- More details on PGD-Always-ON configuration options in [Deploying with TPA](tpa)
- [PGD-Always-ON](architecture-PGD-Always-ON/) in the Trusted Postgres Architect documentation
- More details on PGD-Always-ON configuration options in [Deploying with TPA](../tpa)
- [PGD-Always-ON](/tpa/latest/architecture-PGD-Always-ON/) in the Trusted Postgres Architect documentation
- [`tpaexec configure`](/tpa/latest/tpaexec-configure/) in the Trusted Postgres Architect documentation
- [Docker platform](/tpa/latest/platform-docker/) in the Trusted Postgres Architect documentation

10 changes: 6 additions & 4 deletions product_docs/docs/pgd/5/tpa.mdx
Original file line number Diff line number Diff line change
@@ -48,12 +48,14 @@ The available configuration options include:
| Flags | Description |
| ------------------ | ----------- |
| `--architecture` | Required. Set to `PGD-Always-ON` for EDB Postgres Distributed deployments. |
| `–-postgresql <version>` <br/> or <br/> `--edb-postgres-advanced <version>` <br/> or <br/> `--edb-postgres-extended <version>` | Required. Specifies the distribution and version of Postgres to use. For more details, see [Cluster configuration: Postgres flavour and version](/tpa/latest/tpaexec-configure/#postgres-flavour-and-version). |
| `--redwood` or `--noredwood` | Required when `--edb-postgres-advanced` flag is present. Specifies whether Oracle database compatibility features are desired. |
| `--location-names l1 l2 l3` | Required. Specifies the number and name of the locations PGD will be deployed to. |
| `--data-nodes-per-location N` | Specifies number of data nodes per location. Default 3. |
| `--add-witness-node-per-location` | For even number of data nodes per location, this will add witness node to allow for local consensus. This is enabled by default for 2 data node locations. |
| `--cohost-proxies` | Whether to put PGD-Proxies to data nodes. By default proxies are installed to separate hosts |
| `--add-proxy-nodes-per-location` | Whether to separate PGD-Proxies from data nodes, and how many to configure. By default one proxy is configured and cohosted for each data node. |
| `--active-locations l2 l3` | Which locations should have local connection routing configured. By default global routing is configured. |
| `--add-witness-only-location loc` | This designates one of the cluster location as witness only (no data nodes will be present in that location) |
| `--add-witness-only-location loc` | This designates one of the cluster location as witness only (no data nodes will be present in that location). |
| `--enable-camo` | Sets up CAMO pair in each location. This only works with 2 data node per location. |

More configuration options are listed in the TPA documentation for [PGD-Always-ON](/tpa/latest/architecture-PGD-Always-ON/).
@@ -70,7 +72,7 @@ For example:

The first argument must be the cluster directory, for example, `speedy` or `~/clusters/speedy` (the cluster is named `speedy` in both cases). We recommend that you keep all your clusters in a common directory, for example, `~/clusters`. The next argument must be `--architecture` to select an architecture, followed by options.

The command creates a directory named ~/clusters/speedy and generates a configuration file named `config.yml` that follows the layout of the PGD-Always-ON architecture. You can use the `tpcaexec info` command to see what values are supported for the configuration options based on what you specified when running the configure command.
The command creates a directory named ~/clusters/speedy and generates a configuration file named `config.yml` that follows the layout of the PGD-Always-ON architecture. You can use the `tpaexec configure --architecture PGD-Always-ON --help` command to see what values are supported for the configuration options in this architecture.

### Common configuration options

@@ -125,7 +127,7 @@ Optionally, use `--edb-repositories repository …` to specify EDB repositories


### Software versions
By default TPA uses the latest major version of Postgres. Specify `--postgres-version` to install an earlier supported major version.
By default TPA uses the latest major version of Postgres. Specify `--postgres-version` to install an earlier supported major version, or specify both version and distribution via one of the flags described under [Configure](#configure), above.

By default, TPA always installs the latest version of every package. This is usually the desired behavior, but in some testing scenarios, it may be necessary to select specific package versions. For example,

1 comment on commit efbbabe

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.