Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-edit of PGD - third set of edits #5784

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Re-edit of PGD - third set of edits #5784

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
05a91c3
Re-edit of PGD - third set of edits
ebgitelman Jun 19, 2024
2d1ea00
Apply suggestions from code review
ebgitelman Jun 19, 2024
2aa5935
Update product_docs/docs/pgd/5/durability/camo.mdx
ebgitelman Jun 25, 2024
3cfaff5
Update 02-deploying.mdx
djw-m Jun 26, 2024
9aa210c
Fixed links
djw-m Jun 26, 2024
cb264f7
Update product_docs/docs/pgd/5/durability/camo.mdx
djw-m Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions product_docs/docs/pgd/5/deploy-config/deploy-biganimal/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ EDB BigAnimal is a fully managed database-as-a-service with built-in Oracle comp
This section covers how to work with EDB Postgres Distributed when deployed on BigAnimal.

* [Creating a distributed high-availability cluster](/biganimal/latest/getting_started/creating_a_cluster/creating_a_dha_cluster/) in the BigAnimal documentation works through the steps needed to:
* Prepare your cloud environment for a distributed high-availability cluster
* Sign in to BigAnimal
* Prepare your cloud environment for a distributed high-availability cluster.
* Sign in to BigAnimal.
* Create a distributed high-availability cluster, including:
* Creating and configuring a data group
* Optionally creating and configuring a second data group in a different region
* Creating and configuring a data group.
* Optionally creating and configuring a second data group in a different region.
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/deploy-config/deploy-kubernetes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ EDB Postgres Distributed for Kubernetes is a Kubernetes operator designed, devel

This section covers how to deploy and configure EDB Postgres Distributed using the Kubernetes operator.

* A [Quickstart](/postgres_distributed_for_kubernetes/latest/quickstart) in the PGD for Kubernetes documentation works through the steps needed to:
* [Quick start](/postgres_distributed_for_kubernetes/latest/quickstart) in the PGD for Kubernetes documentation works through the steps needed to:
* Create a Kind/Minikube cluster.
* Install Helm and the Helm chart for PGD for Kubernetes.
* Create a simple configuration file for a PGD cluster.
Expand Down
9 changes: 4 additions & 5 deletions product_docs/docs/pgd/5/deploy-config/deploy-tpa/deploying/01-configuring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ tpaexec configure <cluster_dir> --architecture <architecture_name> [options]
| `--redwood` or `--no-redwood` | Required when `--edb-postgres-advanced` flag is present. Specifies whether Oracle database compatibility features are desired. |
| `--location-names l1 l2 l3` | Required. Specifies the names of the locations to deploy PGD to. |
| `--data-nodes-per-location N` | Specifies the number of data nodes per location. Default is 3. |
| `--add-witness-node-per-location` | For an even number of data nodes per location, adds witness nodes to allow for local consensus. 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. |
| `--pgd-proxy-routing global\|local` | Whether PGD Proxy routing is handled on a global or local (per-location) basis. |
| `--add-witness-node-per-location` | For an even number of data nodes per location, adds witness nodes to allow for local consensus. Enabled by default for 2-data-node locations. |
| `--add-proxy-nodes-per-location` | Specifies 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. |
| `--pgd-proxy-routing global\|local` | Specifies whether PGD Proxy routing is handled on a global or local (per-location) basis. |
| `--add-witness-only-location loc` | Designates one of the cluster locations as witness-only (no data nodes are present in that location). |
| `--enable-camo` | Sets up a CAMO pair in each location. Works only with 2 data nodes per location. |

Expand All @@ -48,7 +48,7 @@ The first argument must be the cluster directory, for example, `speedy` or `~/cl

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 the values that are supported for the configuration options in this architecture.

In the example, the options select:
In the example, the options select:

- An AWS deployment (`--platform aws`)
- EDB Postgres Advanced Server, version 16 and Oracle compatibility (`--edb-postgres-advanced 16` and `--redwood`)
Expand Down Expand Up @@ -135,4 +135,3 @@ Specify `--hostnames-pattern` to restrict hostnames to those matching the egrep
By default, `tpaexec configure` uses the names first, second, and so on for any locations used by the selected architecture.

Specify `--location-names` to provide more meaningful names for each location.

3 changes: 2 additions & 1 deletion product_docs/docs/pgd/5/deploy-config/deploy-tpa/deploying/02-deploying.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `tpaexec provision` command creates instances and other resources required b

For example, given AWS access with the necessary privileges, TPA provisions EC2 instances, VPCs, subnets, routing tables, internet gateways, security groups, EBS volumes, elastic IPs, and so on.

You can also provision existing servers by selecting the `bare` platform and providing connection details. Whether these are bare metal servers or those provisioned separately on a cloud platform, they can be used as if they were created by TPA.
You can also provision existing servers by selecting the `bare` platform and providing connection details. Whether these are bare metal servers or those provisioned separately on a cloud platform, you can use them as if they were created by TPA.

You aren't restricted to a single platform. You can spread your cluster out across some AWS instances in multiple regions and some on-premises servers or servers in other data centres, as needed.

Expand All @@ -25,6 +25,7 @@ At the end of the provisioning stage, you will have the required number of insta
## Deploy
The `tpaexec deploy` command installs and configures Postgres and other software on the provisioned servers. TPA can create the servers, but it doesn't matter who created them so long as SSH and sudo access are available. This includes setting up replication, backups, and so on.
Copy link
Contributor Author

@ebgitelman ebgitelman Jun 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@djw-m I couldn't trace what "This" means in the last sentence. Can you clarify?



At the end of the deployment stage, EDB Postgres Distributed is up and running.

## Test
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/deploy-config/deploy-tpa/deploying/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ At the highest level, using TPA to deploy PGD involves the following steps:

&nbsp;&nbsp;&nbsp;1: [Use TPA to create a configuration](01-configuring) for your PGD cluster.

&nbsp;&nbsp;&nbsp;2: [Provision, Deploy and Test](02-deploying) your PGD cluster.
&nbsp;&nbsp;&nbsp;2: [Provision, deploy, and test](02-deploying) your PGD cluster.
10 changes: 5 additions & 5 deletions product_docs/docs/pgd/5/deploy-config/deploy-tpa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ both self-hosted and in the cloud (with AWS EC2).

If you want to run on your own Linux systems or VMs, you can use also use TPA to [deploy EDB Postgres Distributed directly to your own Linux hosts](/pgd/latest/quickstart/quick_start_linux)
djw-m marked this conversation as resolved.
Show resolved Hide resolved

This section of the manual covers how to use TPA to deploy and administer EDB Postgres Distributed.
This section covers how to use TPA to deploy and administer EDB Postgres Distributed.

* [Deploying with TPA](deploying) works through the steps needed to:
* Installing TPA
* Using TPA to create a configuration
* Deploying the configuration with TPA
* Install TPA.
* Use TPA to create a configuration.
* Deploy the configuration with TPA.

The installing section provides an example cluster which will be used in future examples.
The installing section provides an example cluster that will be used in future examples.

You can also [perform a rolling major version upgrade](../../upgrades/upgrading_major_rolling) with PGD administered by TPA.
8 changes: 4 additions & 4 deletions product_docs/docs/pgd/5/deploy-config/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ This section covers how to deploy EDB Postgres Distributed and how to configure

There are four main ways to deploy PGD:

* [Manual deployment and administration](deploy-manual): How to manually deploy and configure EDB Postgres Distributed on a set of servers.
* [Manual deployment and administration](deploy-manual) describes how to manually deploy and configure EDB Postgres Distributed on a set of servers.


* [Trusted Postgres Architect (TPA)](deploy-tpa): How to use TPA to deploy and configure EDB Postgres Distributed to a Docker environment, Linux hosts, or AWS.
* [Trusted Postgres Architect (TPA)](deploy-tpa) describes how to use TPA to deploy and configure EDB Postgres Distributed to a Docker environment, Linux hosts, or AWS.


* [EDB Postgres Distributed for Kubernetes](deploy-kubernetes): How to deploy and configure EDB Postgres Distributed to a Kubernetes environment.
* [EDB Postgres Distributed for Kubernetes](deploy-kubernetes) describes how to deploy and configure EDB Postgres Distributed to a Kubernetes environment.


* [EDB BigAnimal](deploy-biganimal): How to deploy and configure EDB Postgres Distributed on the EDB BigAnimal service.
* [EDB BigAnimal](deploy-biganimal) describes how to deploy and configure EDB Postgres Distributed on the EDB BigAnimal service.
5 changes: 2 additions & 3 deletions product_docs/docs/pgd/5/durability/administering.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Administering
navTitle: Administering
---

When running a PGD cluster with Group Commit, there are some things you need to
be aware of when administering the system, such as how to safely shut down and
When running a PGD cluster with Group Commit, you need to
be aware of some things when administering the system, such as how to safely shut down and
restart nodes.

## Planned shutdown and restarts
Expand All @@ -19,4 +19,3 @@ lead to loss of data, as if both nodes failed.
To ensure the apply queue gets flushed to disk, use either
[`smart` or `fast` shutdown](https://www.postgresql.org/docs/current/server-shutdown.html) for maintenance tasks. This approach maintains the
required synchronization level and prevents loss of data.

Loading