Skip to content

Commit

Permalink
Update index.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
drothery-edb committed May 19, 2022
1 parent 3e8a1e5 commit 24ae207
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions product_docs/docs/pgd/4/deployments/tpaexec/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,18 @@ TPAexec packages are only available to EDB customers with an active BDR subscrip
### Configuration
The `tpaexec configure` command generates a simple YAML configuration file to describe a cluster, based on the options you select. The configuration is ready for immediate use, and you can modify it to better suit your needs. Editing the configuration file is the usual way to make any configuration changes to your cluster, both before and after it's created.

The configuration options include:
The syntax is:

```
tpaexec configure <cluster_dir> --architecture <architecture_name> --layout <layout> --bdr-version <bdr_version> --<postgresql_flavour> --2Q-repositories <repositories_to_be_used> --extra-packages edb-livecompare edb-lasso --platform <platform>
```

The primary configuration options include:

| Flags | Description |
| ---------------------------- | ----------- |
| --architecture BDR-Always-ON | Required. Set to 'BDR-Always-ON' for EDB Postgres Distributed deployments |
| --layout layoutname | Required. Specify one of the four supported architectures: bronze, silver, gold, and platinum. See [Choosing your architecture][/pgd/4/architectures] for more information. |

| --harp-consensus-protocol | Required. `bdr` is recommended if your layout is bronze or silver. `etcd` is recommended if your layout is gold or platinum. See [Choosing your DCS]/pgd/4/dcs] for more information. |
| --bdr-node-group groupname | Optional. Set the name of the BDR node group. The default is `bdrgroup`. |
| --bdr-database dbname | Optional. Set the name of the database with BDR enabled. The default is `bdrdb`. |
Expand Down

0 comments on commit 24ae207

Please sign in to comment.