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-01-30a #5203

Merged
merged 27 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
07b2cd4
Update 03-quick_start.mdx
yuki-tei Aug 8, 2023
bf8ab4c
Added notes on what to set pg-verrsion-force to.
djw-m Sep 19, 2023
59d390f
Update poolers.mdx
kunliuedb Jan 2, 2024
8f5e9e4
Update poolers.mdx
kunliuedb Jan 2, 2024
de18e39
BigAnimal - Dedicated Wal storage
nidhibhammar Jan 9, 2024
d74999a
Install procedures for sslutils and index advisor
dwicinas Jan 15, 2024
b0c1894
Edits done as per suggestion from Amrita
nidhibhammar Jan 16, 2024
31071ca
updated the note as per discussion with Simon on PEM-4665
nidhibhammar Jan 22, 2024
2b92b26
BigAnimal - Third-party integrations as per UPM-27644
nidhibhammar Jan 16, 2024
7869897
Added more content
nidhibhammar Jan 17, 2024
55670d6
Updated content as per review commentes from Craig and Amrita
nidhibhammar Jan 23, 2024
bfdaa6d
Verbiage for Costs and Metrics for Datadog and New Relic
dwicinas Jan 23, 2024
08b7440
minor fix as per the review comments
nidhibhammar Jan 24, 2024
b86480c
Merge pull request #5121 from EnterpriseDB/kunliuedb-patch-1
nidhibhammar Jan 29, 2024
8ecfed3
Merge branch 'main' into develop
djw-m Jan 29, 2024
dec27db
Added a point as per feedback from dhilipkumar
nidhibhammar Jan 30, 2024
4e7138e
Merge pull request #4587 from yuki-tei/yuki-tei-patch-1
nidhibhammar Jan 30, 2024
f89d04c
Merge pull request #5131 from EnterpriseDB/content/docs/biganimal/ded…
djw-m Jan 30, 2024
13c86d2
Merge pull request #5154 from EnterpriseDB/content/docs/biganimal/thi…
nidhibhammar Jan 30, 2024
abeb200
Merge pull request #5151 from EnterpriseDB/docs/epas/ssutils-index-ad…
nidhibhammar Jan 30, 2024
d438b2c
First commit of release notes generator
djw-m Jan 30, 2024
8e52d72
Fixes for filename handling
djw-m Jan 30, 2024
186fae8
First release of bareleasenotes updater with releasenotes
djw-m Jan 30, 2024
d03acd8
Merge pull request #5202 from EnterpriseDB/DOCS-87-Create-a-release-n…
djw-m Jan 30, 2024
a4328ef
pgd: fixes for bdr.join_node_group() reference documentation
ibarwick Jan 30, 2024
4a63051
Moved the note to a warning (to be more precise and to avoid two note…
djw-m Jan 30, 2024
d1f708f
Merge pull request #5200 from EnterpriseDB/pgd/BDR-4555-bdr_join_node…
djw-m Jan 30, 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 @@ -25,22 +25,25 @@ For **EDB Postgres Advanced Server**:

```ini
[global]
repo1-path=/var/lib/edb/as13/backups
repo1-path=/var/lib/edb/as15/backups

[demo]
pg1-path=/var/lib/edb/as13/data
pg1-path=/var/lib/edb/as15/data
pg1-user=enterprisedb
pg1-port=5444
pg-version-force=15
```

The `pg-version-force` value should be set to the same major version number as the server reports when using `show server_version_num;` in PSQL. Only the first two digits are the major version. For example, 15000 is major version 15.

For **PostgreSQL**:

```ini
[global]
repo1-path=/var/lib/pgsql/13/backups
repo1-path=/var/lib/pgsql/15/backups

[demo]
pg1-path=/var/lib/pgsql/13/data
pg1-path=/var/lib/pgsql/15/data
pg1-user=postgres
pg1-port=5432
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,12 @@ The following options aren't available when creating your cluster:
!!!tip
To maximize your disk size for AWS, select R5b as your instance and then io2 Block Express as your storage to get a maximum disk size of 64 TB and 256,000 IOPS.

1. In the **Storage** section, from the **Volume Type** list, select your volume type.
1. In the **Storage** section:

By default, the **Database Storage** volume stores the Postgres data and the Write-Ahead (WAL) Logs together. If you want to improve write performance for WAL files, you can allocate separate storage volume for the WAL files. To allocate separate storage volume for WAL files, select the check-box before **Use a separate storage volume for Write-Ahead Logs**. Then select the Volume Type, Size, IOPS, and Disk Throughput separately for **Database Storage** and **Write-Ahead Logs Storage**. If you allocate separate storage volume for the WAL files, you have to pay cloud infrastructure costs for the second volume. Once separate storage volume is allocated for WAL files, it can't be removed from the cluster settings later on.

From the **Volume Type** list, select your volume type.

- For Azure, in **Volume Type**, select **Premium SSD** or **Ultra Disk**. Compared to Premium SSD volumes, ultra disks offer lower-latency, high-performance options and direct control over your disk's input/output operations per second (IOPS). For BigAnimal, we recommend using ultra disks for workloads that require the most demanding performance. See [Using Azure ultra disks](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd?tabs=azure-portal) for more information.

- For Premium SSD, in **Volume Properties**, select the type and amount of storage needed for your cluster. See [Azure Premium SSD storage types](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information.
Expand All @@ -118,7 +123,7 @@ The following options aren't available when creating your cluster:

In **Volume Properties**, select the disk size for your cluster, and configure the IOPS.


2. ##### Network, Logs, & Telemetry section

In **Connectivity Type**, specify whether to use private or public networking. Networking is set to **Public** by default. Public means that any client can connect to your cluster’s public IP address over the internet. Optionally, you can limit traffic to your public cluster by specifying an IP allowlist, which allows access only to certain blocks of IP addresses. To limit access, add one or more classless inter-domain routing (CIDR) blocks in the **IP Allowlists** section. CIDR is a method for allocating IP addresses and IP routing to a whole network or subnet. If you have any CIDR block entries, access is limited to those IP addresses. If none are specified, all network traffic is allowed.
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/biganimal/release/overview/poolers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ EDB PgBouncer can manage your connections to Postgres databases and help your wo
BigAnimal provisions up to three instances per EDB PgBouncer-enabled cluster to ensure that performance is unaffected, so each availability zone receives its own instance of EDB PgBouncer.

!!!Note
Currently, you can't enable EDB PgBouncer when using BigAnimal's cloud account or when creating a distributed high-availability cluster using your cloud account.
Currently, you can't enable EDB PgBouncer when creating a distributed high-availability cluster.

If you want to deploy and manage PgBouncer outside of BigAnimal, see the [How to configure EDB PgBouncer with BigAnimal cluster](https://support.biganimal.com/hc/en-us/articles/4848726654745-How-to-configure-PgBouncer-with-BigAnimal-Cluster) knowledge-base article.

Expand Down
2 changes: 2 additions & 0 deletions product_docs/docs/biganimal/release/release_notes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: BigAnimal release notes
navTitle: Release notes
navigation:
- jan_2024_rel_notes
- dec_2023_rel_notes
- nov_2023_rel_notes
- oct_2023_rel_notes
Expand All @@ -20,6 +21,7 @@ The BigAnimal documentation describes the latest version of BigAnimal, including

| Month |
| ------------------------------------ |
| [January 2024](jan_2024_rel_notes) |
| [December 2023](dec_2023_rel_notes) |
| [November 2023](nov_2023_rel_notes) |
| [October 2023](oct_2023_rel_notes) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: BigAnimal January 2024 release notes
navTitle: January 2024
---

BigAnimal's January 2024 includes the following enhancements and bugfixes:

| Type | Description |
|------|-------------|
| Enhancement | BigAnimal has added new integrations with third-party monitoring services. You can now set up monitoring integrations with DataDog and New Relic on your BigAnimal Projects. |
| Enhancement | BigAnimal now supports adding a storage volume to your cluster for the Write-Ahead Log (WAL). Dedicated WAL storage volumes significantly improve write performance for WAL files, boosting the IO of the overall cluster. |
| Enhancement | BigAnimal Terraform provider v0.7.0 is now available. Learn more about what’s new [here](https://github.com/EnterpriseDB/terraform-provider-biganimal/releases/tag/v0.7.0) and download the provider [here](https://registry.terraform.io/providers/EnterpriseDB/biganimal/latest). |
| Enhancement | BigAnimal CLI v3.5.0 is now available. Learn more about what’s new [here](https://cli.biganimal.com/versions/v3.5.0/). |
| Enhancement | BigAnimal now supports pausing and resuming clusters on demand. You can now pause clusters when you aren’t using them without losing your data or configurations, giving you more control over your cluster operations as well as helping you save on compute costs. |


Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Datadog"
---

Datadog integration is based on the OpenTelemetry Collector and the Datadog plugin bundled with the OpenTelemetry collector. Once enabled, BigAnimal automatically configures data planes to send the Telemetry to your Datadog account via Datadog's cloud receive endpoint.

## Pre-requisites

A pre-existing Datadog account is required to use this integration.

## Enabling Datadog

To enable the **Datadog** integrations:

1. Select an existing project from the **Projects** page.
2. Go to **Settings** on the left-side navigation.
3. Select **Integrations** from the **Settings** drop down list.
4. Select **Datadog**, a window pops-up to provide the details:
- **Datadog API Key** — Provide an API Key. For more details, see [Datadog API Key](https://docs.datadoghq.com/account_management/api-app-keys/). The API Key is sensitive and can't be retrieved once saved.
- **Datadog Site Name** — Provide the Datadog site name by selecting from the available options in the drop-down list. The telemetry goes to this chosen Datadog site.
- **Datadog Site URL** — The Datadog site URL gets selected automatically based on the Datadog site name you selected.
- **Datadog API Key ID** — Provide the API Key ID, that acts as the name to store an identifier for the key. This identifier is used for future reference to check the configuration details.

Provide all the details and then select **Save**.

Once you enable this integration, it sends BigAnimal telemetry to your Datadog account.

!!! note "Important"
Generate a new API Key in Datadog to enable this integration in BigAnimal. This API key must be specific to this integration and shouldn't be shared. Whenever you disable this integration, revoke the API Key using the Datadog UI. Once revoked, it disables the Datadog ingestion and billable usage from the BigAnimal integration. This doesn't impact the other services using the Datadog API.
!!!

## Metrics

BigAnimal sends a subset of the OpenTelemetry Collector's metrics from the hostmetrics and kubeletstats receivers, plus BigAnimal custom metrics for the monitored Postgres instance.

You can see a list of metrics in the Datadog user interface, along with the tags for each metric.

To see the list of metrics, go to **Metrics > Summary**. Then select a specific metric to see the tags for that metric.

The set of metrics delivered to DataDog is subject to change. Metrics with names that begin with `postgres.preview.` or `biganimal.preview.` are likely to be renamed or removed in a future release. Other metrics may also be renamed, added, or removed to better integrate into the DataDog platform.

## Cost

After enabling the BigAnimal telemetry integration, check your billable Datadog usage and continue to monitor it over time.

Be aware of the following cost considerations:

* *You are responsible for all costs* charged to your Datadog account by telemetry sent by the BigAnimal Datadog integration. Charges are based on usage but they could even result from BigAnimal errors or oversights. If you do not accept this responsibility, do not enable the Datadog integration.
* Datadog bills for each monitored Postgres node (including any replicas) as a "monitored host" in the your Datadog plan. See the [Datadog price list](https://www.datadoghq.com/pricing/list/) for current pricing per monitored host.
* Datadog *may* bill for each Postgres container and monitoring agent container running on each monitored Postgres node. See the [Datadog price list](https://www.datadoghq.com/pricing/list/) for current pricing per monitored container.
* Datadog counts some of the metrics sent by BigAnimal as custom metrics. Datadog plans include a limited number of free unique custom metrics dimensions per host. Additional metrics dimensions above the free limit are billable at a rate set in the Datadog price list. See your [Datadog plan price list](https://www.datadoghq.com/pricing/list/) for details. Although BigAnimal's telemetry integration for Datadog tries to limit custom metrics delivery to minimize additional billable Datadog usage, you should still expect some billable custom metrics usage.

To disable the Datadog integration for BigAnimal and ensure no further costs are incurred on your Datadog account, you must revoke the API key provided to BigAnimal. Disabling the integration on the BigAnimal Portal is not sufficient.

Currently, Datadog does not offer any mechanism for configuring a usage limit or billing cap for monitored hosts, monitored containers, or custom metrics. The Datadog [metrics without limits feature](https://docs.datadoghq.com/metrics/metrics-without-limits/) can limit cardinality-based billing for custom metrics, but it enables ingestion-based billing instead, so the overall price may actually be greater. You must actively monitor and be alert to your Datadog usage-based billing using the Datadog-provided [usage metrics](https://docs.datadoghq.com/account_management/billing/usage_metrics/), such as `datadog.estimated_usage.hosts`, `datadog.estimated_usage.containers`, and `datadog.estimated_usage.metrics.custom`.

For more information, see also:
- [Datadog pricing list](https://www.datadoghq.com/pricing/list/)
- [Custom metrics billing](https://docs.datadoghq.com/account_management/billing/custom_metrics/?tab=countrate#counting-custom-metrics)
- [Usage metrics billing](https://docs.datadoghq.com/account_management/billing/usage_metrics/)
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Third party monitoring integrations"
---

BigAnimal provides support for third-party monitoring integrations for both using your own account and BigAnimal's cloud account.

Monitoring integrations are configured at project level in BigAnimal. It can't be turned on or off for the individual clusters. An Org admin or a Project owner can set up an integration. Only one integration can be set up per project.

By default, all the integrations are disabled. Enable it using the **Integrations** tab after creating the project.

All the metrics collected from all the clusters in the Project are sent to the integrated tool and are displayed in BigAnimal's [**Monitoring and logging** tab using PEMx](../monitoring_using_pemx). The collected logs are exported to the object storage by default.

The third-party integrations available in BigAnimal are:

- [Datadog](./datadog)
- [New Relic](./newrelic)
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "New Relic"
---

The New Relic integration is based on the OpenTelemetry Collector, shipping the metrics over the standard OLTP protocol to the New Relic cloud endpoint.

## Pre-requisites

A pre-existing New Relic account is required to use this integration.

## Enable New Relic

To enable the **New Relic** integration:
1. Select an existing project from the **Projects** page.
2. Go to **Settings** on the left-side navigation.
3. Select **Integrations** from the **Settings** drop down list.
4. Select **New Relic**, a window pops up to provide the details:
- **New Relic API key** - Provide an API Key. For more details, see [New Relic API Key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/). The API Key is sensitive and can't be retrieved once saved.
- **New Relic API Key Name** - Provide the API Key name to store an identifier for the key. This identifier is used for future reference to check the configuration details.
- **New Relic Account ID** - Provide the account ID of New Relic.

Provide all the details and select **Save**.

Once you enable this integration, it sends BigAnimal telemetry to your New Relic account.

!!! note "Important"
Generate a new API License Key in New Relic to enable this integration in BigAnimal. This API key must be specific to this integration and shouldn't be shared. Whenever you disable this integration, revoke the API Key using the New Relic UI. Once revoked, it disables the New Relic ingestion and billable usage from the BigAnimal integration. This doesn't impact the other services using the New Relic API.
!!!

## Metrics

BigAnimal sends a subset of the OpenTelemetry Collector's metrics from the hostmetrics and kubeletstats receivers, plus BigAnimal custom metrics for the monitored Postgres instance.

You can see a list of metrics in the New Relic user interface, along with dimensions for each metric.

To see a list of metrics, go to **Metrics & Events**. Then select a specific metric to see the dimensions sent for that metric.

The set of metrics delivered to New Relic is subject to change. Metrics with names that begin with `postgres.preview.` or `biganimal.preview.` may be renamed or removed in a future release. Other metrics may also be renamed, added, or removed to better integrate into the New Relic platform.

## Cost

After enabling the BigAnimal telemetry integration, check your billable New Relic usage and continue to monitor it over time.

Be aware of the following important cost considerations:

* *You are responsible for all costs* charged to your New Relic account by telemetry sent by the BigAnimal New Relic integration. Charges are based on usage but they could even result from BigAnimal errors or oversights. If you do not accept this responsibility, do not enable the New Relic integration.

* New Relic bills usage by bytes ingested and for data retention. You must monitor and configure alerts on your New Relic data ingestion to reduce the risk of unexpectedly large usage bills. Also check your retention settings.

New Relic has features to limit usage and ingestion. Customers should review their limits before enabling the BigAnimal integration. In the New Relic user interface, see **Administration > Data management > Limits**. Also refer to the following related topics in the New Relic documentation:

* [Understand and manage data ingest](https://docs.newrelic.com/docs/data-apis/manage-data/manage-data-coming-new-relic/)
* [Data ingest: Billing and rules](https://docs.newrelic.com/docs/accounts/accounts-billing/new-relic-one-pricing-billing/data-ingest-billing/)
* [Understand New Relic data limits](https://docs.newrelic.com/docs/data-apis/manage-data/view-system-limits/)
* [Get more detail about your data limits](https://docs.newrelic.com/docs/data-apis/manage-data/query-limits/)

To disable the New Relic integration for BigAnimal and ensure no further costs are incurred on your New Relic account, you must revoke the API key provided to BigAnimal. Disabling the integration on the BigAnimal Portal is not sufficient.
24 changes: 23 additions & 1 deletion product_docs/docs/epas/15/epas_security_guide/04_sslutils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,29 @@ description: "The sslutils Postgres extension provides SSL certificate generatio

## Installing the extension

You install `sslutils` by using the `edb-as<xx>-server-sslutils` RPM package, where `<xx>` is the EDB Postgres Advanced Server version number.
Install `sslutils` using the following command:

```shell
sudo <package-manager> -y install edb-as15-server-sslutils
```

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 |
| apt-get | Debian 10/11 and derivatives |


For example, to install `sslutils` on a RHEL 9 platform:

```shell
sudo dnf -y install edb-as15-server-sslutils
```

Each parameter in the function’s parameter list is described by `parameter n`, where `n` refers to the `nth` ordinal position (for example, first, second, or third) in the function’s parameter list.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: "How to use the Index Advisor utility to help determine the columns
navigation:
- index_advisor_overview
- 05_index_advisor_limitations
- installing_index_advisor
- 02_index_advisor_configuration
- 03_using_index_advisor
- 04_reviewing_the_index_advisor_recommendations
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Installing Index Advisor"
---

Install Index Advisor using the following command:

```shell
sudo <package-manager> -y install edb-as15-server-indexadvisor
```

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 |
| apt-get | Debian 10/11 and derivatives |


For example, to install Index Advisor on a RHEL 9 platform:

```shell
sudo dnf -y install edb-as15-server-indexadvisor
```
!!! Note
Index Advisor is not available on the SLES operating system.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirects:
---

!!! Note "Important"
Index Advisor isn't supported for EDB Postgres Advanced Server and PostgreSQL version 11 and later.
Index Advisor isn't supported for EDB Postgres Advanced Server and PostgreSQL version 16 and later.
!!!

Index Advisor is distributed with EDB Postgres Advanced Server. Index Advisor works with SQL Profiler by examining collected SQL statements and making indexing recommendations for any underlying tables to improve SQL response time. Index Advisor works on all DML (INSERT, UPDATE, DELETE) and SELECT statements that are invoked by a superuser.
Expand Down
Loading
Loading