Skip to content

Commit

Permalink
Merge pull request #2793 from EnterpriseDB/release/2022-06-14
Browse files Browse the repository at this point in the history
Release: 2022-06-14
  • Loading branch information
drothery-edb authored Jun 14, 2022
2 parents 19411e0 + 03d4d7f commit c18c31c
Show file tree
Hide file tree
Showing 14 changed files with 251 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ Prior to creating your cluster, make sure you have enough resources. Without eno

1. Select the type of Postgres you want to use in the **Postgres Type** field:

- [*PostgreSQL*](/supported-open-source/postgresql/) is an open-source object-relational database management system.
- **Oracle Compatible** is powered by [EDB Postgres Advanced Server](/epas/latest/). View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility).

- [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system.

- [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility).
2. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information.
2. In the **Provider** section, select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider).
3. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support).
Expand Down
22 changes: 13 additions & 9 deletions product_docs/docs/biganimal/release/reference/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Using the BigAnimal API
---

!!!important "Deprecation notice"
EDB released v2 of BigAnimal API in June 2022. v1 of BigAnimal API goes out of support on Dec 31, 2022. To see the changes in v2, see the [Change log](https://portal.biganimal.com/api/docs/v2migration.html). Update your applications accordingly.
!!!

Use the BigAnimal API to integrate directly with BigAnimal for management activities such as cluster provisioning, de-provisioning, and scaling.

The API reference documentation is available from the [BigAnimal portal](https://portal.biganimal.com). The direct documentation link is <https://portal.biganimal.com/api/docs/>.
Expand All @@ -24,7 +28,7 @@ This call returns the information that either:
- The `get-token` script uses to generate the tokens for you.

```
curl https://portal.biganimal.com/api/v1/auth/provider
curl https://portal.biganimal.com/api/v2/auth/provider
```

The response returns the `clientId`, `freetrialClientId`, `issuerUri`, `scope`, and `audience`. For example:
Expand Down Expand Up @@ -139,7 +143,7 @@ For example:
{
"access_token": "eyJhbGc.......1Qtkaw2fyho",
"id_token": "eyJhbGci.......FBra7tA",
"refresh_token": "v1.MTvuZpu.......sbiionEhtTw",
"refresh_token": "v2.MTvuZpu.......sbiionEhtTw",
"scope": "openid profile email offline_access",
"expires_in": 86400,
"token_type": "Bearer"
Expand All @@ -150,7 +154,7 @@ Store the access token and refresh token in environment variables for future use

```
RAW_ACCESS_TOKEN="eyJhbGc.......1Qtkaw2fyho"
REFRESH_TOKEN="v1.MTvuZpu.......sbiionEhtTw"
REFRESH_TOKEN="v2.MTvuZpu.......sbiionEhtTw"
```

!!!note
Expand All @@ -177,7 +181,7 @@ Use the raw token you obtained in the previous step [Request the raw token using

```
curl -s --request POST \
--url "https://portal.biganimal.com/api/v1/auth/token" \
--url "https://portal.biganimal.com/api/v2/auth/token" \
--header "content-type: application/json" \
--data "{\"token\":\"$RAW_ACCESS_TOKEN\"}"
```
Expand Down Expand Up @@ -211,7 +215,7 @@ To call the BigAnimal API, your application must pass the retrieved access token

```
curl --request GET \
--url "$AUDIENCE/v1/postgres-types" \
--url "$AUDIENCE/v2/postgres-types" \
--header "authorization: Bearer $ACCESS_TOKEN" \
--header "content-type: application/json"
```
Expand All @@ -223,7 +227,7 @@ Example response:
"pgTypesList": [
{
"id": "epas",
"name": "EDB Postgres Advanced Server",
"name": "Oracle Compatible",
"description": "",
"dockerImage": ""
},
Expand Down Expand Up @@ -270,7 +274,7 @@ The response of this API call includes the `access_token`. For example:
"expires_in": 86400,
"scope": "openid offline_access",
"id_token": "eyJ...0NE",
"refresh_token": "v1.Mjv..._2pRs",
"refresh_token": "v2.Mjv..._2pRs",
"token_type": "Bearer"
}
```
Expand All @@ -279,7 +283,7 @@ Store the access token and refresh token in environment variables for future use

```
RAW_ACCESS_TOKEN="eyJhbGc.......1Qtkaw2fyho"
REFRESH_TOKEN="v1.MTvuZpu.......sbiionEhtTw"
REFRESH_TOKEN="v2.MTvuZpu.......sbiionEhtTw"
```

The token you obtain from this step is the raw-access token. You need to exchange this token for a BigAnimal token. See [Exchange for BigAnimal token](#exchange-the-biganimal-token-using-curl) for more information.
Expand Down Expand Up @@ -340,7 +344,7 @@ xxxxxxxxxx
To use the `get-token` script to refresh your token, use the script with the `--refresh <refresh_token>` option. For example:

```
./get-token.sh -o json --refresh v1.MVZ9_xxxxxxxx_FRs
./get-token.sh -o json --refresh v2.MVZ9_xxxxxxxx_FRs
{
"access_token": "xxxxxxxxxx",
"refresh_token": "xxxxxxxxxxxx",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can create a VPC peering connection with a VPC in the same region or a diffe

1. In the confirmation, select **OK**.

1. The VPC peering connection that you created isn't active. To activate it, the owner of the accepter VPC must accept the VPC peering connection request. To enable traffic to be directed to the peer VPC, update your VPC route table. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html).
1. The VPC peering connection that you created isn't active. To activate it, the owner of the accepter VPC must accept the VPC peering connection request. To enable traffic to be directed to the peer VPC, update your VPC route table. There are three route tables created at BigAnimal VPC, all are required to be updated. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html) and [this FAQ article](https://support.biganimal.com/hc/en-us/articles/6935474150425-How-to-connect-BigAnimal-cluster-with-private-connectivity-at-AWS).

## VPC peering connection with another VPC in your account

Expand All @@ -87,7 +87,7 @@ You can create a VPC peering connection with a VPC in the same region or a diffe

In the confirmation, select **Yes, Accept**. A second confirmation appears; select **Modify my route tables now** to go directly to the route tables page, or select **Close** to do this later.

1. Now that your VPC peering connection is active, you must add an entry to your VPC route tables to enable traffic to be directed between the peered VPCs. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html).
1. Now that your VPC peering connection is active, you must add an entry to your VPC route tables to enable traffic to be directed between the peered VPCs. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html). There are three route tables created at BigAnimal VPC, all are required to be updated. For more information, see [this FAQ article](https://support.biganimal.com/hc/en-us/articles/6935474150425-How-to-connect-BigAnimal-cluster-with-private-connectivity-at-AWS).

1. Access the cluster with its domain name from your cluster's connection string. It's accessible from `vpc-client` after peering.

Expand Down Expand Up @@ -128,7 +128,7 @@ You can create a VPC peering connection with a VPC in the same region or a diffe

1. In the confirmation, select **Yes, Accept**. A second confirmation appears; select **Modify my route tables now** to go directly to the route tables page, or select **Close** to do this later.

1. Now that your VPC peering connection is active, you must add an entry to your VPC route tables to enable traffic to be directed between the peered VPCs. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html).
1. Now that your VPC peering connection is active, you must add an entry to your VPC route tables to enable traffic to be directed between the peered VPCs. For more information, see [Update your route tables for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-routing.html). There are three route tables created at BigAnimal VPC, all are required to be updated. For more information, see [this FAQ article](https://support.biganimal.com/hc/en-us/articles/6935474150425-How-to-connect-BigAnimal-cluster-with-private-connectivity-at-AWS).

1. Access the cluster with its domain name from your cluster's connection string. It's accessible from `vpc-client` after peering.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ BigAnimal backs up the data in your PostgreSQL clusters. Depending on the cloud
!!! Note
Backups in AWS do not currently support cross-regional replication.

PostgreSQL clusters in BigAnimal are continuously backed up through a combination of base backups and transaction log (WAL) archiving. When a new cluster is created, an initial "base" backup is taken. After that, every time a WAL file is closed, which is, by default, every 5 minutes, it is automatically uploaded to the cloud object storage solution. Your organization is responsible for the charges associated with the cloud object storage solution.
PostgreSQL clusters in BigAnimal are continuously backed up through a combination of base backups and transaction log (WAL) archiving. When a new cluster is created, an initial "base" backup is taken. After that, every time a WAL file is closed, which is, by default, up to every 5 minutes, it is automatically uploaded to the cloud object storage solution. Your organization is responsible for the charges associated with the cloud object storage solution.

BigAnimal retains backups for 30 days by default.

Expand All @@ -39,4 +39,4 @@ The restore operation is available for any cluster that has at least one availab
1. Fill in the required fields.
2. In the **Source** section, in the **Point in Time Restore** field, select **Now** on the calendar to restore to the last possible recovery point. Or, choose a timestamp to restore further back in time.
3. Review your selections in **Cluster Summary** and select **Restore Cluster** to begin the restore process.
4. The new cluster is now available on the [Clusters](https://portal.biganimal.com/clusters) page.
4. The new cluster is now available on the [Clusters](https://portal.biganimal.com/clusters) page.
4 changes: 3 additions & 1 deletion product_docs/docs/efm/4/03_installing_efm/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ For platform-specific install instructions, including accessing the repo, see:
- [CentOS 7](x86_amd64/04_efm4_centos7_x86)
- [SLES 15](x86_amd64/05_efm4_sles15_x86)
- [SLES 12](x86_amd64/06_efm4_sles12_x86)
- [Ubuntu 20.04 or 18.04/Debian 10](x86_amd64/07_efm4_ubuntu18_20_deb10_x8)
- [Ubuntu 20.04](x86_amd64/07_efm4_ubuntu20_x86)
- [Ubuntu 18.04](x86_amd64/07a_efm4_ubuntu18_x86)
- [Debian 10](x86_amd64/07b_efm4_deb10_x86)
- [Debian 9](x86_amd64/08_efm4_deb9_x86)

- Linux on IBM Power (ppc64le):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Installing Failover Manager on Ubuntu 20.04 or 18.04/Debian 10 x86"
navTitle: "Ubuntu 20.04 or 18.04/Debian 10"
title: "Installing Failover Manager on Ubuntu 20.04"
navTitle: "Ubuntu 20.04"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "Installing Failover Manager on Ubuntu 18.04"
navTitle: "Ubuntu 18.04"
---


To install Failover Manager, you must have credentials that allow access to the EnterpriseDB repository. To request credentials for the repository, see the [EnterpriseDB website](https://www.enterprisedb.com/user/login).

Use the EnterpriseDB APT repository to install Failover Manager.

## Installing

1. Assume superuser privileges:
```text
sudo su –
```
2. Configure the EnterpriseDB repository by substituting your EnterpriseDB credentials for the username and password placeholders in the following commands:

```text
sh -c 'echo "deb [arch=amd64] https://apt.enterprisedb.com/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list'
sh -c 'echo "machine apt.enterprisedb.com login <username> password <password>" > /etc/apt/auth.conf.d/edb.conf'
```

3. Add support to your system for secure APT repositories:
```text
apt-get install apt-transport-https
```
4. Add the EDB signing key:
```text
wget -q -O - https://<username>:<password>@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
```
5. Update the repository meta data:
```text
apt-get update
```
6. Install Failover Manager:
```text
apt-get -y install edb-efm42
```
## Initial configuration

If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).

After installing on each node of the cluster:

1. Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
2. Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
3. If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
4. Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "Installing Failover Manager on Debian 10 x86"
navTitle: "Debian 10"
---


To install Failover Manager, you must have credentials that allow access to the EnterpriseDB repository. To request credentials for the repository, see the [EnterpriseDB website](https://www.enterprisedb.com/user/login).

Use the EnterpriseDB APT repository to install Failover Manager.

## Installing

1. Assume superuser privileges:
```text
sudo su –
```
2. Configure the EnterpriseDB repository by substituting your EnterpriseDB credentials for the username and password placeholders in the following commands:

```text
sh -c 'echo "deb [arch=amd64] https://apt.enterprisedb.com/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list'
sh -c 'echo "machine apt.enterprisedb.com login <username> password <password>" > /etc/apt/auth.conf.d/edb.conf'
```

3. Add support to your system for secure APT repositories:
```text
apt-get install apt-transport-https
```
4. Add the EDB signing key:
```text
wget -q -O - https://<username>:<password>@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
```
5. Update the repository meta data:
```text
apt-get update
```
6. Install Failover Manager:
```text
apt-get -y install edb-efm42
```
## Initial configuration

If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).

After installing on each node of the cluster:

1. Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
2. Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
3. If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
4. Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ For operating system-specific install instructions, including accessing the repo
- [CentOS 7](04_efm4_centos7_x86)
- [SLES 15](05_efm4_sles15_x86)
- [SLES 12](06_efm4_sles12_x86)
- [Ubuntu 20.04 or 18.04/Debian 10](07_efm4_ubuntu18_20_deb10_x8)
- [Ubuntu 20.04](07_efm4_ubuntu20_x86)
- [Ubuntu 18.04](07a_efm4_ubuntu18_x86)
- [Debian 10](07b_efm4_deb10_x86)
- [Debian 9](08_efm4_deb9_x86)

Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ For platform-specific install instructions, see:
- [CentOS 7](x86_amd64/04_mtk55_centos7_x86)
- [SLES 15](x86_amd64/05_mtk55_sles15_x86)
- [SLES 12](x86_amd64/06_mtk55_sles12_x86)
- [Ubuntu 20.04 0r 18.04/Debian 10](x86_amd64/07_mtk55_ubuntu18_20_deb10_x86)
- [Ubuntu 20.04](x86_amd64/07_mtk55_ubuntu20_x86)
- [Ubuntu 18.04](x86_amd64/07a_mtk55_ubuntu18_x86)
- [Debian 10](x86_amd64/07b_mtk55_deb10_x86)
- [Debian 9](x86_amd64/08_mtk55_deb9_x86)

- Linux on IBM Power (ppc64le):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Installing Migration Toolkit on Ubuntu 20.04 or 18.04/Debian 10 x86"
navTitle: "Ubuntu 20.04 or 18.04/Debian 10"
title: "Installing Migration Toolkit on Ubuntu 20.04 x86"
navTitle: "Ubuntu 20.04"
---

<div id="debian_or_ubuntu_installation" class="registered_link"></div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "Installing Migration Toolkit on Ubuntu 18.04 x86"
navTitle: "Ubuntu 18.04"
---

<div id="debian_or_ubuntu_installation" class="registered_link"></div>

To install a package with apt, complete the following steps. When invoking the commands, replace the `username` and `password` with the user credentials provided by EnterpriseDB.

1. Assume superuser privileges:

```text
sudo su –
```

2. Set up the EnterpriseDB repository:

```text
sh -c 'echo "deb [arch=amd64] https://
apt.enterprisedb.com/
$(lsb_release -cs)-edb/ $(lsb_release -cs) main"
> /etc/
apt/sources.list.d/edb-$(lsb_release -cs).list'
```

1. Substitute your EnterpriseDB credentials for the `username` and `password` placeholders in the following command:

```text
sh -c 'echo "machine apt.enterprisedb.com login <username>
password <password>" > /etc/apt/auth.conf.d/edb.conf'
```

1. Add support to your system for secure APT repositories:

```text
apt-get install apt-transport-https
```

1. Add the EBD signing key:

```text
wget -q -O - https://username:password
@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
```

1. Update the repository metadata:

```text
apt-get update
```

1. Install the `edb-migrationtoolkit` package:

```text
apt-get -y install edb-migrationtoolkit
```

Loading

0 comments on commit c18c31c

Please sign in to comment.