From aff4efed68b087e4e5a39b1c3f30048cae97cc98 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 23 Mar 2023 04:40:07 +0000 Subject: [PATCH 1/2] quickstart link fixes, TPA option change --- product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx | 5 +++-- product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx | 8 ++++---- product_docs/docs/pgd/5/tpa.mdx | 2 +- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx b/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx index adebaff3aa0..f48da5555c4 100644 --- a/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx +++ b/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx @@ -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 diff --git a/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx b/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx index d33dfd44568..187fdab4b4e 100644 --- a/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx +++ b/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx @@ -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 diff --git a/product_docs/docs/pgd/5/tpa.mdx b/product_docs/docs/pgd/5/tpa.mdx index 0a846f0a337..dc13a0b6d11 100644 --- a/product_docs/docs/pgd/5/tpa.mdx +++ b/product_docs/docs/pgd/5/tpa.mdx @@ -51,7 +51,7 @@ The available configuration options include: | `--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) | | `--enable-camo` | Sets up CAMO pair in each location. This only works with 2 data node per location. | From 520e08a807214e1b220d9c6d9505e273ec8b88c4 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 23 Mar 2023 17:37:33 +0000 Subject: [PATCH 2/2] Add add'l required options to tpa deployment topic --- product_docs/docs/pgd/5/tpa.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pgd/5/tpa.mdx b/product_docs/docs/pgd/5/tpa.mdx index dc13a0b6d11..6eebed73561 100644 --- a/product_docs/docs/pgd/5/tpa.mdx +++ b/product_docs/docs/pgd/5/tpa.mdx @@ -48,12 +48,14 @@ The available configuration options include: | Flags | Description | | ------------------ | ----------- | | `--architecture` | Required. Set to `PGD-Always-ON` for EDB Postgres Distributed deployments. | +| `–-postgresql `
or
`--edb-postgres-advanced `
or
`--edb-postgres-extended ` | 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. | -| `--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 | +| `--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,