Release: 2024-01-18

advocacy_docs/pg_extensions/advanced_storage_pack/index.mdx

@@ -17,7 +17,7 @@ EnterpriseDB offers three TAMs in the Advanced Storage Pack.
 
 ## Bluefin
 
-Bluefin is designed to provide data compaction and delta compression, which makes it particularly useful for storing time-series data, common in IoT and monitoring use cases.
+Bluefin is designed to provide data compaction and delta compression, which makes it particularly useful for storing time-series data, common in IoT and monitoring use cases. Delta compression is a way of storing data in the form of differences (deltas) between datasets between consecutive tuples. This reduces the amount of data that needs to be stored or transmitted, especially when there are small or constant changes between data tuples.
 
 In its design, UPDATE and DELETE operations aren't permitted. This design allows for a much smaller tuple header. It also allows for tuples to be stored as compressed deltas of other tuples and eagerly freezing of pages as soon as the page is full. The result is that Bluefin tables accept only INSERTs, but they are able to reach a much higher density of tuples per page. This ability leads to faster reads on such append-only tables.
 

advocacy_docs/pg_extensions/wait_states/index.mdx

@@ -3,7 +3,9 @@ title: EDB Wait States
 indexCards: none
 directoryDefaults:
   product: EDB Wait States
-
+navigation:
+  - installing
+  - using
 ---
 
 EDB Wait States is a tool for analyzing performance and tuning by allowing the collection and querying of wait event data. Wait events, introduced in PostgreSQL 9.6, are recorded alongside other session activity and provide a snapshot of whether a session is waiting for I/O, CPU, IPC, locks, or timeouts. Snapshots of this information are gathered by the EDB Wait States background worker (BGW) at regular intervals. 

advocacy_docs/pg_extensions/wait_states/installing.mdx

@@ -3,12 +3,41 @@ title: Installing EDB Wait States
 navTitle: Installing
 ---
 
-## On Linux 
+## On all Linux systems except Debian and Ubuntu
 
-To install EDB Wait States on a Linux system:
+To install EDB Wait States on any Linux operating system except Debian or Ubuntu:
 
-1.  Install EDB Wait States with the `edb-asxx-server-edb_wait_states` RPM package, where `xx` is the EDB Postgres Advanced Server version number.
+1.  Enter the following command:
 
+  ```shell
+  sudo <package-manager> -y install <install-package-name>
+  ```
+
+  Where: 
+
+    - `<package-manager>`is the package manager used with your operating system:
+
+      | Package manager | Operating system     |
+      | --------------- | -------------------------------- |
+      | dnf             | RHEL 8/9 and derivatives         |
+      | yum             | RHEL 7 and derivatives, CentOS 7 |
+      | zypper          | SLES                             |
+
+    - `<install-package-name>` is the name of the Postgres distribution you're using. In the package names `<version>` is the version of the Postgres distribution. 
+
+      | Type of Postgres distribution | Install command                             |
+      | ----------------------------- | ------------------------------------------- |
+      | PostgreSQL                    | postgresql`<version>`-edb_wait_states       |
+      | EDB Postgres Advanced Server  | edb-as`<version>`-server-edb_wait_states    |
+      | EDB Postgres Extended Server  | edb-postgresextended`<version>`-wait-states |
+
+
+  For example, to install EDB Wait States for EDB Postgres Advanced Server 16 on a RHEL 9 platform:
+
+  ```shell
+  sudo dnf -y install edb-as16-server-edb_wait_states
+  ```
+
 1. To launch the worker, register it in the `postgresql.conf` file using the `shared_preload_libraries` parameter. For example:
 
   ```ini
@@ -23,13 +52,51 @@ To install EDB Wait States on a Linux system:
   CREATE EXTENSION edb_wait_states;
   ```
 
-1. To terminate the EDB Wait States worker, remove `$libdir/edb_wait_states` from the `shared_preload_libraries` parameter, and restart the database server.
+## On Debian and Ubuntu
 
-## On Windows
+To install EDB Wait States on Debian or Ubuntu:
+
+1.  Enter the following command:
+
+  ```shell
+  sudo apt-get -y install <install-package-name>
+  ```
+
+  Where: 
+
+  `<install-package-name>` is the name of the Postgres distribution you're using. In the package names `<version>` is the version of the Postgres distribution. 
+
+  | Type of Postgres distribution | Install command                              |
+  | ----------------------------- | -------------------------------------------- |
+  | PostgreSQL                    | postgresql`<version>`-edb-wait-states        |
+  | EDB Postgres Advanced Server  | edb-as`<version>`-server-edb-wait-states     |
+  | EDB Postgres Extended Server  | edb-postgresextended-wait-states-`<version>` |
+
+  For example, to install EDB Wait States for EDB Postgres Advanced Server 16 on a Debian 11 platform:
+
+  ```shell
+  sudo apt-get -y install edb-as16-server-edb-wait-states
+  ```
+
+
+1. To launch the worker, register it in the `postgresql.conf` file using the `shared_preload_libraries` parameter. For example:
+
+  ```ini
+  shared_preload_libraries = '$libdir/edb_wait_states'
+  ```
+
+1.  Restart the database server. After a successful restart, the background worker begins collecting data.
 
-To install EDB Wait States on a Windows system:
+1. To review the data, create the following extension:
 
-1.  To install the EDB Wait States module with the `EDB Modules` installer, invoke the StackBuilder Plus utility. Follow the onscreen instructions to finish installing the `EDB Modules`.
+  ```sql
+  CREATE EXTENSION edb_wait_states;
+  ```
+
+
+## On Windows
+
+An EDB Postgres Advanced Server installation includes support for EDB Wait States. After installing EDB Postgres Advanced Server, some additional steps are necessary to activate EDB Wait States.
 
 1. To register the worker, modify the `postgresql.conf` file to include the EDB Wait States library in the `shared_preload_libraries` configuration parameter. The parameter value must include:
 
@@ -40,9 +107,11 @@ To install EDB Wait States on a Windows system:
   The EDB Wait States installation places the `edb_wait_states.dll` library file in the following path:
 
   ```text
-  C:\Program Files\edb\as14\lib\
+  C:\Program Files\edb\as<xx>\lib\
   ```
 
+  where `<xx>` is the EDB Postgres Advanced Server version, such as `as16`.
+
 1. Restart the database server to make the changes take effect. After a successful restart, the background worker starts and begins collecting the data.
 
 1. To view the data, create the following extension:
@@ -62,5 +131,7 @@ C:\Program Files\edb\as14\share\extension
 To uninstall EDB Wait States:
 
 1.  Use the `DROP EXTENSION` command to drop the `edb_wait_states` extension. 
-1.  Modify the `postgresql.conf` file, removing `$libdir/edb_wait_states.dll` from the `shared_preload_libraries` parameter. 
-1.  To apply your changes, restart the database server.
+1.  Modify the `postgresql.conf` file, removing `$libdir/edb_wait_states` (for Linux) or `$libdir/edb_wait_states.dll` (for Windows) from the `shared_preload_libraries` parameter. 
+1.  To apply your changes, restart the database server.
+
+

gatsby-config.js

@@ -366,7 +366,7 @@ module.exports = {
         id: process.env.GTM_ID,
       },
     },
-    {
+    process.env.FATHOM_SITE_ID && {
       resolve: "@raae/gatsby-plugin-fathom",
       options: {
         site: process.env.FATHOM_SITE_ID,
@@ -406,5 +406,5 @@ module.exports = {
         skipIndexing: process.env.INDEX_ON_BUILD !== "true",
       },
     },
-  ],
+  ].filter((p) => !!p),
 };

install_template/templates/products/edb-postgres-extended-server/base.njk

@@ -1,5 +1,6 @@
 {% extends "platformBase/" + platformBaseTemplate + '.njk' %}
 {% set packageName = packageName or 'edb-postgresextended<xx>-server edb-postgresextended<xx>-contrib' %}
+{% set packageName = packageName | replace('<xx>', product.version) %}
 {% import "platformBase/_deploymentConstants.njk" as deploy %}
 {% block frontmatter %}
 {# 
@@ -12,6 +13,94 @@ redirects:
 {% endblock frontmatter %}
 {% block installCommand %}
 {{super()}}
-Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version {{ product.version }}, the package name would be {{packageName | replace('<xx>', product.version)}}.
+{% endblock installCommand %}
+{% block postinstall %}
 
-{% endblock installCommand %}
+## Initial configuration
+{% block debian_ubuntu %}
+Getting started with your cluster involves logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. 
+
+First, you need to initialize and start the database cluster. The `edb-pge-{{ product.version | replace(".", "") }}-setup` script creates a cluster.
+
+```shell
+sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/pge{{ product.version }}/bin/edb-pge-{{ product.version | replace(".", "") }}-setup initdb
+
+sudo systemctl start edb-pge-{{ product.version }}
+```
+{% endblock debian_ubuntu %}
+
+To work in your cluster, log in as the postgres user. Connect to the database server using the psql command-line client. Alternatively, you can use a client of your choice with the appropriate connection string. 
+
+```shell
+sudo -iu postgres
+
+psql postgres
+```
+
+The server runs with the `peer` or `ident` permission by default. You can change the authentication method by modifying the `pg_hba.conf` file.
+
+{# this is kinda awful, but gotta deal with the reorg somehow... --jh #}
+Before changing the authentication method, assign a password to the database superuser, postgres. For more information on changing the authentication, see [Modifying the pg_hba.conf file](../../administration/01_setting_configuration_parameters/#modifying-the-pg_hbaconf-file).
+
+```sql
+ALTER ROLE postgres with PASSWORD 'password';
+```
+
+## Experiment
+
+Now you're ready to create and connect to a database, create a table, insert data in a table, and view the data from the table. 
+
+First, use psql to create a database named `hr` to hold human resource information.
+
+```sql
+# running in psql 
+CREATE DATABASE hr;
+__OUTPUT__
+CREATE DATABASE
+```
+
+Connect to the `hr` database inside psql:
+
+```
+\c hr
+__OUTPUT__
+You are now connected to database "hr" as user "postgres".
+```
+
+Create columns to hold department numbers, unique department names, and locations:
+
+```
+CREATE TABLE public.dept (deptno numeric(2) NOT NULL CONSTRAINT dept_pk
+PRIMARY KEY, dname varchar(14) CONSTRAINT dept_dname_uq UNIQUE, loc
+varchar(13));
+__OUTPUT__
+CREATE TABLE
+```
+
+Insert values into the `dept` table:
+
+```
+INSERT INTO dept VALUES (10,'ACCOUNTING','NEW YORK');
+__OUTPUT__
+INSERT 0 1
+```
+
+```
+INSERT into dept VALUES (20,'RESEARCH','DALLAS');
+__OUTPUT__
+INSERT 0 1
+```
+
+View the table data by selecting the values from the table:
+
+```
+SELECT * FROM dept;
+__OUTPUT__
+deptno  |   dname    |   loc
+--------+------------+----------
+10      | ACCOUNTING | NEW YORK
+20      | RESEARCH   | DALLAS
+(2 rows)
+```
+
+{% endblock postinstall %}

install_template/templates/products/edb-postgres-extended-server/debian-10.njk

@@ -5,7 +5,4 @@
 ```shell
 sudo {{ packageManager }} {{ packageManagerNoninteractive }} install {{ packageName }}
 ```
-
-Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version 15, the package name would be `edb-postgresextended-15`.
-
 {% endblock installCommand %}

install_template/templates/products/edb-postgres-extended-server/debian-11.njk

@@ -5,7 +5,4 @@
 ```shell
 sudo {{ packageManager }} {{ packageManagerNoninteractive }} install {{ packageName }}
 ```
-
-Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version 15, the package name would be `edb-postgresextended-15`.
-
 {% endblock installCommand %}

install_template/templates/products/edb-postgres-extended-server/debian.njk

@@ -1,4 +1,13 @@
 {% extends "products/edb-postgres-extended-server/base.njk" %}
-{% block debian_ubuntu %}This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
+{% block debian_ubuntu %}
+This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
 
-```shell{% endblock debian_ubuntu %}
+First, you need to initialize and start the database cluster. The `edb-pge-{{ product.version | replace(".", "") }}-setup` script creates a cluster.
+
+```shell
+sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/lib/edb-pge/{{ product.version }}/bin/edb-pge-{{ product.version | replace(".", "") }}-setup initdb
+
+sudo systemctl start edb-pge-{{ product.version }}
+```
+
+{% endblock debian_ubuntu %}

install_template/templates/products/edb-postgres-extended-server/ubuntu-22.04.njk

@@ -1,4 +1,4 @@
 {% extends "products/edb-postgres-extended-server/ubuntu.njk" %}
 {% set platformBaseTemplate = "ubuntu-22.04" %}
-{% set packageName %}edb-postgresextended-<xx> edb-postgresextended-<xx>-contrib{% endset %}
+{% set packageName %}edb-postgresextended-<xx>{% endset %}
 

install_template/templates/products/edb-postgres-extended-server/ubuntu.njk

@@ -1 +1,13 @@
 {% extends "products/edb-postgres-extended-server/base.njk" %}
+{% block debian_ubuntu %}
+This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
+
+First, you need to initialize and start the database cluster. The `edb-pge-{{ product.version | replace(".", "") }}-setup` script creates a cluster.
+
+```shell
+sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/lib/edb-pge/{{ product.version }}/bin/edb-pge-{{ product.version | replace(".", "") }}-setup initdb
+
+sudo systemctl start edb-pge-{{ product.version }}
+```
+
+{% endblock debian_ubuntu %}

product_docs/docs/biganimal/release/getting_started/index.mdx

@@ -9,5 +9,6 @@ navigation:
  - 02_connecting_to_your_cloud
  - activating_regions
  - creating_a_cluster
+ - managing_cluster
 ---
 

product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx

@@ -0,0 +1,33 @@
+---
+title: "Managing a cluster"
+description: Describes options for managing clusters
+---
+
+## Pausing and resuming clusters
+
+Pausing a cluster allows you to save on compute costs without losing data or cluster configuration settings. There is no additional cost for paused clusters, although you must still pay for any disk and object storage that the paused cluster requires.  
+
+Pausing a cluster drops all existing connections, blocks future actions such as editing the cluster, and stops monitoring. While paused, you can't make or maintain connections, or read, write, or edit cluster settings. Automatic backups are paused. However, backups taken while the cluster was running remain until their retention period expires. 
+
+!!! Note
+    If you have defined the backup retention period for a cluster to be less that the duration of the pause, it is possible that write-ahead logs (WALs) may be deleted from the backup object store and resumption could fail.
+
+While paused, clusters are not upgraded or patched, but upgrades are applied when the cluster resumes. Pausing a high availability or Postgres Distributed cluster shuts down all cluster nodes. 
+
+After seven days, single node and high availability clusters automatically resume. Resuming a cluster applies any pending maintenance upgrades. Monitoring begins again.  
+
+### Pausing a cluster
+
+1.  Go to the [Clusters](https://portal.biganimal.com/clusters) page in the [BigAnimal portal](https://portal.biganimal.com). 
+2.  To pause the cluster, do one of the following:
+    -   In the row for the cluster, at right, select the ellipsis icon and then select **Pause Cluster**.
+    -   Select the cluster you want to pause. From **Quick Actions** on the cluster details page, select **Pause Cluster**.
+3.  Confirm that you want to pause the cluster. When the process finishes, the cluster status will show as Paused.
+
+### Resuming a cluster
+
+1.  Go to the [Clusters](https://portal.biganimal.com/clusters) page in the [BigAnimal portal](https://portal.biganimal.com). 
+2.  To resume the cluster, do one of the following:
+    -   In the row for the cluster, at right, select the ellipsis icon and then select **Resume Cluster**.
+    -   Select the cluster you want to resume. From **Quick Actions** on the cluster details page, select **Resume Cluster**.
+3.  Confirm that you want to resume the cluster. The process may take a few minutes. When it finishes, the cluster status will show as Healthy.