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.

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

Release/2024-03-18b #5398

Merged
merged 21 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
a70a3bd
BigAnimal - Access key update
nidhibhammar Mar 12, 2024
a1b6713
Fixing indentation and versioning for PEM 8 and 9
gvasquezvargas Mar 12, 2024
76c78bd
updating AllowBatchJobSteps note
gvasquezvargas Mar 12, 2024
67304f0
last edits
gvasquezvargas Mar 13, 2024
868cdb1
Merge pull request #5379 from EnterpriseDB/pem/fixing_indent
gvasquezvargas Mar 13, 2024
f518811
Re-add the missing example tde file.
djw-m Mar 13, 2024
2e8155f
Merge pull request #5386 from EnterpriseDB/docs/check/example-tde
djw-m Mar 13, 2024
2ecb83d
Edits to PGD PR5367
ebgitelman Mar 13, 2024
be5dc28
Edits to PWR PR5380
ebgitelman Mar 13, 2024
f2e77f8
Edits to PGD PR5345
ebgitelman Mar 13, 2024
b152346
Merge pull request #5392 from EnterpriseDB/docs/edits_to_pwr_pr5380
nidhibhammar Mar 14, 2024
6011b9a
Fix broken link upgrade_paths.mdx
djw-m Mar 14, 2024
a2b3877
Merge pull request #5391 from EnterpriseDB/docs/edits_to_pgd_pr5367
nidhibhammar Mar 14, 2024
1b08071
Merge pull request #5393 from EnterpriseDB/docs/edits_to_pgd_pr5345
nidhibhammar Mar 14, 2024
9cd020a
Merge pull request #5373 from EnterpriseDB/content/docs/biganimal/acc…
nidhibhammar Mar 14, 2024
e1b621b
Merge branch 'develop' into djw-m-patch-4
djw-m Mar 14, 2024
41e2587
Missed the bdr
djw-m Mar 14, 2024
f188b1e
Final fix
djw-m Mar 15, 2024
7ab14f0
Merge pull request #5396 from EnterpriseDB/djw-m-patch-4
djw-m Mar 15, 2024
0bdf0ac
Update 06_harp_manager.mdx
matthew123987 Mar 18, 2024
8174833
Merge pull request #5397 from EnterpriseDB/matthew123987-patch-2
matthew123987 Mar 18, 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
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ An access key can be revoked from a user. Revoking the key doesn't affect the ro

To create an access key:
1. Log in to the BigAnimal portal.
1. From the menu next to your organization name in the top right of the portal, select **Access Key**.
1. From the Access Keys page, select **Create New Key**.
1. From the menu next to your organization name in the top right of the portal, select **My Account**.
1. From the My Account page, go to **Access Keys** tab.
1. From the Access Keys tab, select **Create New Key**.
1. Provide the **Access Key Name**.
1. Provide the **Expiry days** in the range of 1 to 365.

Expand Down
20 changes: 10 additions & 10 deletions product_docs/docs/pem/8/installing_pem_agent/windows_agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The PEM agent graphical installer for Windows installs and registers the PEM age
To invoke the PEM agent installer, assume administrator privileges and navigate to the directory that contains the installer. Then, invoke the installer:

```shell
pem_agent-7.<x>.<x>-<x>-platform.exe
pem_agent-8.<x>.<x>-<x>-platform.exe
```

1. The Setup screen opens, welcoming you to the PEM agent installer. Select **Next**.
Expand All @@ -26,18 +26,18 @@ pem_agent-7.<x>.<x>-<x>-platform.exe

1. By default, the PEM agent is installed in the `C:\Program Files (x86)\edb\pem` directory. You can accept the default installation directory. Or you can modify the contents of the **Installation Directory** field, specifying an alternate installation directory for the PEM agent.

- By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file.
- By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file.

- Select **Register now?** to register the newly installed PEM agent with the PEM server.
- Select **Register now?** to register the newly installed PEM agent with the PEM server.

- Select **Next**.
- Select **Next**.

1. Enter the connection details for the PEM server in the PEM Server Installation Details dialog box.

- Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database.
- Specify the name of the database superuser in the **User Name** field.
- Specify the password associated with the database superuser in the **Password** field.
- Specify the port that PostgreSQL is monitoring in the **Port** field.
- Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database.
- Specify the name of the database superuser in the **User Name** field.
- Specify the password associated with the database superuser in the **Password** field.
- Specify the port that PostgreSQL is monitoring in the **Port** field.

1. Select **Next** to continue to pemAgent Service Account. The installer attempts to connect to the server to verify that the details are correct.

Expand Down Expand Up @@ -78,7 +78,7 @@ Before invoking the PEM agent installer in unattended mode, you must:
You need administrator privileges to install the PEM Agent. Use the following command to invoke the PEM agent installer in unattended mode:

```shell
pem-agent-7.<x>.<x>-windows-x64.exe --mode unattended
pem-agent-8.<x>.<x>-windows-x64.exe --mode unattended
--pghost <pem_server_host_address> --pgport <pem_server_port>
--pguser postgres --pgpassword <pguser_password>
--agent_description <agent_name>
Expand All @@ -92,4 +92,4 @@ Where:
- `agent_name` specifies a descriptive name for the PEM agent.

!!! Note
When configuring a shell/batch script run by a Windows agent that has PEM 7.11 or later version installed, set the `AllowBatchJobSteps` parameter to `True` in the `agent.cfg` file. The PEM agent doesn't execute any batch/shell script by default.
When configuring a shell/batch script run by a Windows agent, set the `AllowBatchJobSteps` parameter to `True` in the `agent.cfg` file. The PEM agent doesn't execute any batch/shell script by default.
20 changes: 10 additions & 10 deletions product_docs/docs/pem/9/installing_pem_agent/windows_agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The PEM agent graphical installer for Windows installs and registers the PEM age
To invoke the PEM agent installer, assume administrator privileges and navigate to the directory that contains the installer. Then, invoke the installer:

```shell
pem_agent-7.<x>.<x>-<x>-platform.exe
pem_agent-9.<x>.<x>-<x>-platform.exe
```

1. The Setup screen opens, welcoming you to the PEM agent installer. Select **Next**.
Expand All @@ -25,18 +25,18 @@ pem_agent-7.<x>.<x>-<x>-platform.exe

1. By default, the PEM agent is installed in the `C:\Program Files (x86)\edb\pem` directory. You can accept the default installation directory. Or you can modify the contents of the **Installation Directory** field, specifying an alternate installation directory for the PEM agent.

- By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file.
- By default, the PEM agent installer places a certificate in the Administrator’s `%APPDATA%\pem` directory. Select **Show advanced options** to include a dialog box in the installation process that allows you to specify an alternate path for the certificate file.

- Select **Register now?** to register the newly installed PEM agent with the PEM server.
- Select **Register now?** to register the newly installed PEM agent with the PEM server.

- Select **Next**.
- Select **Next**.

1. Enter the connection details for the PEM server in the PEM Server Installation Details dialog box.

- Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database.
- Specify the name of the database superuser in the **User Name** field.
- Specify the password associated with the database superuser in the **Password** field.
- Specify the port that PostgreSQL is monitoring in the **Port** field.
- Specify the name or IP address of the system where the PEM database server resides in the **Host** field. If the PEM-HTTPD web server and PEM database are hosted on different systems, you must specify the host of the PEM database.
- Specify the name of the database superuser in the **User Name** field.
- Specify the password associated with the database superuser in the **Password** field.
- Specify the port that PostgreSQL is monitoring in the **Port** field.

1. Select **Next** to continue to pemAgent Service Account. The installer attempts to connect to the server to verify that the details are correct.

Expand Down Expand Up @@ -77,7 +77,7 @@ Before invoking the PEM agent installer in unattended mode, you must:
You need administrator privileges to install the PEM Agent. Use the following command to invoke the PEM agent installer in unattended mode:

```shell
pem-agent-7.<x>.<x>-windows-x64.exe --mode unattended
pem-agent-9.<x>.<x>-windows-x64.exe --mode unattended
--pghost <pem_server_host_address> --pgport <pem_server_port>
--pguser postgres --pgpassword <pguser_password>
--agent_description <agent_name>
Expand All @@ -91,4 +91,4 @@ Where:
- `agent_name` specifies a descriptive name for the PEM agent.

!!! Note
When configuring a shell/batch script run by a Windows agent that has PEM 7.11 or later version installed, set the `AllowBatchJobSteps` parameter to `True` in the `agent.cfg` file. The PEM agent doesn't execute any batch/shell script by default.
When configuring a shell/batch script run by a Windows agent, set the `AllowBatchJobSteps` parameter to `True` in the `agent.cfg` file. The PEM agent doesn't execute any batch/shell script by default.
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/4/harp/06_harp_manager.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Other nodes can exist, but they can't to participate as lead or
shadow master roles or any other functionality that requires a HARP Manager.

!!! Important
HARP Manager expects the be used to start and stop the database. Stopping HARP Manager
HARP Manager expects to be used to start and stop the database. Stopping HARP Manager
will stop the database. Starting HARP Manager will start the database if it
isn't already started. If another method is used to stop the database then
HARP Manager will try and restart it.
Expand Down
8 changes: 4 additions & 4 deletions product_docs/docs/pgd/5/durability/commit-scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ COMMIT;

You must set the commit scope before the transaction writes any data.

A commit scope may be set as a default for a group or sub_group using `bdr.alter_node_group_option`
You can set a commit scope as a default for a group or subgroup using `bdr.alter_node_group_option`:

```sql
SELECT bdr.alter_node_group_option(
Expand All @@ -89,7 +89,7 @@ SELECT bdr.alter_node_group_option(
);
```

To completely clear the default for a group of sub-group, set the `default_commit_scope` value to `local`.
To completely clear the default for a group or subgroup, set the `default_commit_scope` value to `local`:

```sql
SELECT bdr.alter_node_group_option(
Expand All @@ -99,13 +99,13 @@ SELECT bdr.alter_node_group_option(
);
```

You can also do make this change using PGD cli:
You can also make this change using PGD CLI:

```
pgd set-group-options example-bdr-group --option default_commit_scope=example_scope
```

And you can clear the default using PGD cli by setting the value to local:
And you can clear the default using PGD CLI by setting the value to `local`:

```
pgd set-group-options example-bdr-group --option default_commit_scope=local
Expand Down
14 changes: 7 additions & 7 deletions product_docs/docs/pgd/5/upgrades/tpa_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you used TPA to install your cluster, you can also use TPA to upgrade it. The
You can read more about the capabilities of TPA upgrades in [Upgrading your cluster](/tpa/latest/tpaexec-upgrade/) in the TPA documentation.

!!! Warning Always test first
If possible, always test upgrade processes in a QA environment first. This should help ensure that there are no unexpected factors that should be taken into account. TPA's ability to reproducibly deploy a PGD configuration makes it much easier to build a test environment to work with.
If possible, always test upgrade processes in a QA environment first. This helps to ensure that there are no unexpected factors to take into account. TPA's ability to reproducibly deploy a PGD configuration makes it much easier to build a test environment to work with.
!!!

## Minor and major PGD upgrades
Expand All @@ -30,18 +30,18 @@ The `reconfigure` command requires settings for architecture (only `PGD_Always_O

* The cluster configuration directory created when TPA deployed your PGD cluster.

* If performing a major version upgrade of PGD, ensure that `tpaexec reconfigure` has been run and [appropriate configuration changes](#minor-and-major-pgd-upgrades) have been made.
* If performing a major version upgrade of PGD, ensure that `tpaexec reconfigure` was run and [appropriate configuration changes](#minor-and-major-pgd-upgrades) were made.


## Upgrading

Run
Run:

```
tpaexec upgrade clustername
```

Where **clustername** is the name of the cluster and the path to the cluster configuration directory. By default, TPA will upgrade each node of the cluster to the latest minor versions of the software the nodes were configured with.
Where `clustername` is the name of the cluster and the path to the cluster configuration directory. By default, TPA upgrades each node of the cluster to the latest minor versions of the software the nodes were configured with.


## TPA's automated rolling upgrade procedure
Expand All @@ -53,9 +53,9 @@ Each node is then isolated from the cluster, upgraded, and returned to operation
### TPA upgrades - step by step

* Checks that all preconditions for upgrading the cluster are met.
* For each instance in the cluster
* Checks that it has the correct repositories configured
* Check that the required Postgres packages are available in those repositories.
* For each instance in the cluster:
* Checks that it has the correct repositories configured.
* Checks that the required Postgres packages are available in those repositories.
* For each BDR node in the cluster, one at a time:
* Fences the node off to ensure that pgd-proxy doesn't send any connections to it.
* Stops, updates, and restarts Postgres.
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/upgrades/upgrade_paths.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ release before upgrading to the latest version 5 release. After upgrading to

Starting with version 3.7.23, you can upgrade directly to version 5.3.0 or later.
For earlier versions, upgrade to 3.7.23 before upgrading to 5.
See [Upgrading within version 3.7](/pgd/3/upgrades/upgrade_paths/#upgrading-within-version-37)
See [Upgrading within version 3.7](/pgd/3.7/bdr/upgrades/supported_paths/#upgrading-within-version-37)
for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
apiVersion: v1
kind: Secret
metadata:
name: tde-key
data:
key: bG9zcG9sbGl0b3NkaWNlbnBpb3Bpb3Bpb2N1YW5kb3RpZW5lbmhhbWJyZWN1YW5kb3RpZW5lbmZyaW8=

---
apiVersion: postgresql.k8s.enterprisedb.io/v1
kind: Cluster
metadata:
name: cluster-example
spec:
instances: 3
imageName: ghcr.io/enterprisedb/edb-postgres-advanced:16
postgresql:
epas:
tde:
enabled: true
secretKeyRef:
name: tde-key
key: key

bootstrap:
initdb:
redwood: true

storage:
size: 1Gi
14 changes: 7 additions & 7 deletions product_docs/docs/pwr/1/configuring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@ To reduce the number of command-line arguments needed when executing `pwr`, you

## Configuration file locations

Postgres Workload Report looks for a configuration file in the following places, and uses the first one found:
Postgres Workload Report looks for a configuration file in the following places and uses the first one found:

1. The file named in the `--config` command-line option, if given.
2. The file named in the `PWR_CONFIG_FILE` environment variable, if set.
3. `~/.pwr.conf`.
4. `/etc/pwr.conf`.

The installation package creates a template for the configuration file in `/etc/pwr.conf.templ`. We recommend copying this file to one of the
two places where Postgres Workload Report looks for a configuration file by default (locations #3 or #4 in the previous list), and editing the options in the template as necessary.
two places where Postgres Workload Report looks for a configuration file by default (`~/.pwr.conf` and `/etc/pwr.conf`), and editing the options in the template as necessary.

!!! Note
If no configuration file is found, Postgres Workload Report assumes the default value for all options, which can still be overriden via the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options.
If no configuration file is found, Postgres Workload Report assumes the default value for all options, which you can still override using the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options.
!!!

## Configuration file options

### `input_dir`

An existing directory where the `edb_wait_states` portion of a Lasso report are located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)).
An existing directory where the `edb_wait_states` portion of a Lasso report is located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)).

### `output_dir`

Location of the directory where Postgres Workload Report writes report files. Executing `pwr` will create this directory if it doesn't exist.
Location of the directory where Postgres Workload Report writes report files. Executing `pwr` creates this directory if it doesn't exist.

### `report_name`

The name of the report files generated. Usually, you would specify this option on the command line because different reports typically have different names.
The name of the report files generated. Usually, you specify this option on the command line because different reports typically have different names.

Don't include a file extension; an appropriate extension will be added will be added based on the output format(s) specified on the command line (`--pdf` adds `.pdf`, `--html` adds `.html`, and so on).
Don't include a file extension. An appropriate extension is added based on the output formats specified on the command line (that is, `--pdf` adds `.pdf`, `--html` adds `.html`, and so on).

### `log_file`

Expand Down
Loading