From fbfcef3662b62901d30301c31cf431e6ebb5a0fd Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 1 Apr 2022 14:57:15 +0530 Subject: [PATCH 01/53] EDB*Plus 36.0.2 New release branch EDB*Plus 36.0.2 New release branch --- .../edbplus_rel_notes/edbplus3600_rel_notes.mdx | 12 ++++++++++++ .../edbplus_rel_notes/edbplus3602_rel_notes.mdx | 12 ++++++++++++ .../docs/edb_plus/36/edbplus_rel_notes/index.mdx | 15 +++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx create mode 100644 product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx create mode 100644 product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx new file mode 100644 index 00000000000..710c915828d --- /dev/null +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx @@ -0,0 +1,12 @@ +--- +title: "Version 36.0.0" +--- + + +New features, enhancements, bug fixes, and other changes in EDB*Plus 36.0.0 include: + +| Type | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| Enhancement | Support for EDB Postgres Advanced Server 10.0.0 | +| Enhancement | EDB Postgres Advanced Server support of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | +| Enhancement | EDB Postgres Advanced Server support of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the EDB Postgres Advanced Server database. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx new file mode 100644 index 00000000000..54bb2dd8aac --- /dev/null +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx @@ -0,0 +1,12 @@ +--- +title: "Version 36.0.2" +--- + + +New features, enhancements, bug fixes, and other changes in EDB*Plus 36.0.2 include: + +| Type | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Enhancement | The display format for a decimal point is now compatible with Oracle SQL*Plus [Support Ticket #75092]. | +| Security Fix | The EDB JDBC driver in EDB*Plus is upgraded to version 42.3.2.1. This upgrade fixes the CVE-2022-21724 vulnerability reported in older versions of the EDB JDBC driver. | +| Bug Fix | Describe command no linger fails for a schema qualified SYNONYM name [Support Ticket #72994]. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx new file mode 100644 index 00000000000..be1ce21424d --- /dev/null +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Release Notes" +navigation: +- edbplus3602_rel_notes +- edbplus3600_rel_notes +--- + +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. + +The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 36. The release notes in this section provide information on what was new in each release. + +| Version | Release Date | +| -------------------------------------- | ------------ | +| [36.0.2](edbplus3602_rel_notes.mdx) | 2022 Apr 05 | +| [36.0.0](edbplus3600_rel_notes.mdx) | 2018 Nov 28 | \ No newline at end of file From 1eff775857a29f56a2675f04a09a834c4d52d946 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 1 Apr 2022 16:09:52 +0530 Subject: [PATCH 02/53] Deleted old release notes file --- product_docs/docs/edb_plus/36/01_release_notes.mdx | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 product_docs/docs/edb_plus/36/01_release_notes.mdx diff --git a/product_docs/docs/edb_plus/36/01_release_notes.mdx b/product_docs/docs/edb_plus/36/01_release_notes.mdx deleted file mode 100644 index c922822d035..00000000000 --- a/product_docs/docs/edb_plus/36/01_release_notes.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Release Notes" ---- - - -New features, enhancements, bug fixes, and other changes in EDB*Plus 36 include: - -| Type | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------- | -| Enhancement | Support for EDB Postgres Advanced Server 10.0.0 | -| Enhancement | EDB Postgres Advanced Server support of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | -| Enhancement | EDB Postgres Advanced Server support of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the EDB Postgres Advanced Server database. | \ No newline at end of file From 156cdb986ae0525e4375c35dd88aa83de38014ed Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 1 Apr 2022 16:13:11 +0530 Subject: [PATCH 03/53] updated navigation --- product_docs/docs/edb_plus/36/index.mdx | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx index 11e1c7987ad..521faa990df 100644 --- a/product_docs/docs/edb_plus/36/index.mdx +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -4,6 +4,9 @@ title: "EDB*Plus" directoryDefaults: description: "EDB*Plus Documentation and release notes." +navigation: +- edbplus_rel_notes +- 03_installing_edb_plus --- EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. @@ -15,10 +18,4 @@ EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide var - Formatting output from SQL commands - Executing batch scripts - Executing OS commands -- Recording output - -
- -introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion - -
+- Recording output \ No newline at end of file From b7744d17c96cffecc469fc51e9860253bdbb137c Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 16 Feb 2022 21:06:14 +0000 Subject: [PATCH 04/53] off-the-cuff kickoff --- .../biganimal/release/free_trial/index.mdx | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 product_docs/docs/biganimal/release/free_trial/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx new file mode 100644 index 00000000000..d640ee3d679 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -0,0 +1,29 @@ +--- +title: "Getting started with the BigAnimal Free Trial" +navTitle: "Free trial getting started" +indexCards: none +--- + +The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. + +## Create an account + +- [Create your EDB account](#) +- [Sign up for the trial](#) + +## Create a cluster + +- [...Using the portal](#) +- [Using the CLI](#) +- [Using the API](#) + +## Connect + +- [Using psql](#) +- [Using pgAdmin](#) + +## Experiment + +- [Full PostgreSQL](#) +- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) + From f6494e9f9e6dc13c4cc12849c350ef36ddf89597 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Wed, 16 Feb 2022 15:24:53 -0800 Subject: [PATCH 05/53] Add mockups for 2 demos --- .../release/free_trial/backup_and_restore.mdx | 91 +++++++++++++++++++ .../release/free_trial/create_cluster_cli.mdx | 87 ++++++++++++++++++ .../biganimal/release/free_trial/index.mdx | 3 +- 3 files changed, 180 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx create mode 100644 product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx new file mode 100644 index 00000000000..c28bbf5cca7 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx @@ -0,0 +1,91 @@ +--- +title: Backup and restore a cluster +--- + +1. [Create a cluster](create_cluster_cli) + +2. [Create a new role/db called baseball](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) + +3. Connect to the baseball database +```sql +\c baseball +``` + +4. Change the prompt so that we have an accurate timestamp for knowing when to recover. +```sql +baseball=> \set PROMPT1 '%`date +%H:%M:%S` %/%R%# ' +Create a table for batters. +CREATE TABLE batters ( + id SERIAL, + playerid VARCHAR(9), + yearid INTEGER, + stint INTEGER, + teamid VARCHAR(3), + lgid VARCHAR(2), + g INTEGER, + ab INTEGER, + r INTEGER, + h INTEGER, + "2b" INTEGER, + "3b" INTEGER, + hr INTEGER, + rbi INTEGER, + sb INTEGER, + cs INTEGER, + bb INTEGER, + so INTEGER, + ibb INTEGER, + hbp INTEGER, + sh INTEGER, + sf INTEGER, + gidp INTEGER, + PRIMARY KEY (id) +); +``` + +5. Populate the table from the internet. +```sql +\COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER +``` + +6. Make sure there is data in the table using select. +```sql +select playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +from batters +where yearid = 1998 +order by hr_rank limit 5; +``` + +7. Drop that table! (Note the time!) +```sql +10:00:39 baseball=> drop table batters; +DROP TABLE +``` + +8. Re-run the select to verify the data is gone. + +9. For the free trial, you are limited to one active cluster. Restoring a cluster creates a brand new cluster that is initialized with the cluster backup. Quit psql (\q) and delete the cluster from the command line. +```shell +./biganimal delete-cluster --id p-xxxxxxxxxxx +``` + +10. Restore the cluster using the timestamp before the time you dropped the table. (This currently requires using the web interface.) + +11. Check the status of the new cluster from the command line. +```shell +./biganimal show-clusters +``` + +12. Log into the new cluster. Again use the edb_admin password used when creating the cluster you recently deleted. + +13. Verify that the batters table has been restored: +```sql +select playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +from batters +where yearid = 1998 +order by hr_rank limit 5; +``` \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx new file mode 100644 index 00000000000..56b305a5808 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx @@ -0,0 +1,87 @@ +--- +title: Creating a cluster on the commmand line +--- + +Download the CLI: +```shell +curl -L0 "https://cli.biganimal.com/download/$(uname -s)/$(uname -m)/latest/biganimal" +``` + +Create a credential on BigAnimal. You can pick any username you prefer. +```shell +./biganimal create-credential -a portal.staging.enterprisedb.network -o 443 -n newuser +``` + +The command will direct you to open a webpage and copy the randomly-generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. + +To verify what credentials you have verified: + +```shell +./biganimal show-credentials +``` +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Credentials ┃ +┣━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┫ +┃ Name ┃ Address ┃ Port ┃ +┣━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━┫ +┃ newuser ┃ portal.staging.enterprisedb.network ┃ 443 ┃ +┗━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━┛ +``` + +If you add another credential, you’ll need to add --credential newuser to the following commands. If you only have one, the option is not needed. + +Pick the region closest to you from the list provided by biganimal: +```shell +./biganimal show-regions +``` +``` +Provider ID: Azure +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Regions ┃ +┣━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┫ +┃ Region Id ┃ Region Name ┃ +┣━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫ +┃ eastus2 ┃ (US) East US 2 ┃ +┃ westeurope ┃ (Europe) West Europe ┃ +┗━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +Other options can be queried via the CLI, but this is the only variable we need to set for this demo. + +Edit a new file called create_cluster.yaml: +```yaml +--- +clusterName: test_cluster # Pick a more meaningful name! +password: mygoodpassword # Please change this password! +postgresType: epas +postgresVersion: "14" +provider: azure +region: eastus2 # Select from the options given by show-regions +instanceType: azure:Standard_E2s_v3 +volumeProperties: P1 +volumeType: azurepremiumstorage +networking: public +highAvailability: false +--- +``` + +Use the config file to create a new cluster: +```shell +./biganimal create-cluster --clusterConfigFile create_cluster.yaml +``` + +If successful, the command will give you a command to check the status of your new cluster: +```shell +./biganimal show-clusters --id p-xxxxxxxxxx +``` + +The id will be used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: +```shell +./biganimal show-cluster-connection --id p-xxxxxxxxxxx +``` + +Once the cluster is created, log in via psql. Use the password from the config file for edb_admin. +```shell +psql 'postgres://edb_admin@p-xxxxxxxxxx.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require' +``` diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index d640ee3d679..3a6321ee8bb 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -14,7 +14,7 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl ## Create a cluster - [...Using the portal](#) -- [Using the CLI](#) +- [Using the CLI](create_cluster_cli) - [Using the API](#) ## Connect @@ -24,6 +24,7 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl ## Experiment +- [Testing backups by restoring a cluster](backup_and_restore) - [Full PostgreSQL](#) - [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) From c450819dbfcd3dacc30e7158e978c1ef5a8bca70 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Thu, 17 Feb 2022 11:11:12 -0800 Subject: [PATCH 06/53] Update the structure a bit --- .../free_trial/01_create_account/index.mdx | 13 ++++++++ .../create_cluster_cli.mdx | 2 ++ .../release/free_trial/03_connect/index.mdx | 29 +++++++++++++++++ .../backup_and_restore.mdx | 2 ++ .../free_trial/04_experiment/index.mdx | 30 ++++++++++++++++++ .../release/free_trial/05_free_trial.mdx | 31 +++++++++++++++++++ .../biganimal/release/free_trial/index.mdx | 7 ++--- 7 files changed, 110 insertions(+), 4 deletions(-) create mode 100644 product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx rename product_docs/docs/biganimal/release/free_trial/{ => 02_creating_a_cluster}/create_cluster_cli.mdx (98%) create mode 100644 product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx rename product_docs/docs/biganimal/release/free_trial/{ => 04_experiment}/backup_and_restore.mdx (98%) create mode 100644 product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx create mode 100644 product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx new file mode 100644 index 00000000000..104a9567ca8 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx @@ -0,0 +1,13 @@ +--- +title: "Create an account for your free trial" +navTitle: "Create an account" +--- + +_Maybe a video here?_ + +_Detail what information you'll need to provide._ + +You can request a BigAnimal free trial from several locations: +- The EDB [Get started](https://www.enterprisedb.com/get-started) sign-up page +- The [BigAnimal home page](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) +- The EDB login page \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx similarity index 98% rename from product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx rename to product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx index 56b305a5808..b45b605ad56 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx @@ -1,5 +1,7 @@ --- title: Creating a cluster on the commmand line +navTitle: "Using the command line" +indexCards: none --- Download the CLI: diff --git a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx new file mode 100644 index 00000000000..75081c25278 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx @@ -0,0 +1,29 @@ +--- +title: "Connect to your cluster" +indexCards: none +--- + +The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. + +## Create an account + +- [Create your EDB account](01_create_account) +- [Sign up for the trial](#) + +## Create a cluster + +- [...Using the portal](#) +- [Using the CLI](create_cluster_cli) +- [Using the API](#) + +## Connect + +- [Using psql](#) +- [Using pgAdmin](#) + +## Experiment + +- [Testing backups by restoring a cluster](backup_and_restore) +- [Full PostgreSQL](#) +- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) + diff --git a/product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx similarity index 98% rename from product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx rename to product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx index c28bbf5cca7..25d7cf6a86b 100644 --- a/product_docs/docs/biganimal/release/free_trial/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx @@ -1,5 +1,7 @@ --- title: Backup and restore a cluster +navTitle: "Backup and restore" +indexCards: none --- 1. [Create a cluster](create_cluster_cli) diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx new file mode 100644 index 00000000000..105e528a26e --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx @@ -0,0 +1,30 @@ +--- +title: "Experimenting with the BigAnimal Free Trial" +navTitle: "Experimenting" +indexCards: none +--- + +The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. + +## Create an account + +- [Create your EDB account](01_create_account) +- [Sign up for the trial](#) + +## Create a cluster + +- [...Using the portal](#) +- [Using the CLI](create_cluster_cli) +- [Using the API](#) + +## Connect + +- [Using psql](#) +- [Using pgAdmin](#) + +## Experiment + +- [Testing backups by restoring a cluster](backup_and_restore) +- [Full PostgreSQL](#) +- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) + diff --git a/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx b/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx new file mode 100644 index 00000000000..7b82005d5f0 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx @@ -0,0 +1,31 @@ +--- +title: BigAnimal free trial limitations +navTitle: "Free trial limitations" +indexCards: none +--- + +EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. + +## What you can do with your free trial +- The free trial lasts for 14 days. The count begins when you provision a cluster. +- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. +- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). + - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. + - Numerous other instance types, storage types, and regions are available with a paid account. +- During the trial, you have access to EDB enterprise-level support. +- You can connect to your database cluster. +- You can edit the database configuration for a cluster and view the activity log for the service. +- You get an understanding of what account management looks like in BigAnimal. + +## What you can’t do +Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: + +- You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. +- Backups are only retained for 30 days. +- The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. + +## What happens when the free trial ends + +Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. + +When the free trial ends, your account continues to exist but your cluster and its backup and data are deleted. You cannot transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 3a6321ee8bb..c6912bca499 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -1,6 +1,6 @@ --- title: "Getting started with the BigAnimal Free Trial" -navTitle: "Free trial getting started" +navTitle: "Getting started with a free trial" indexCards: none --- @@ -8,13 +8,13 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl ## Create an account -- [Create your EDB account](#) +- [Create your EDB account](01_create_account) - [Sign up for the trial](#) ## Create a cluster - [...Using the portal](#) -- [Using the CLI](create_cluster_cli) +- [Using the CLI](02_creating_a_cluster/create_cluster_cli) - [Using the API](#) ## Connect @@ -27,4 +27,3 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl - [Testing backups by restoring a cluster](backup_and_restore) - [Full PostgreSQL](#) - [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) - From 6f925d8749a979fb945a06c0abdb738bde2fe133 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Thu, 17 Feb 2022 16:50:30 -0800 Subject: [PATCH 07/53] Feedback from Brad --- .../release/free_trial/03_connect/index.mdx | 23 --------- .../free_trial/04_experiment/index.mdx | 24 --------- .../release/free_trial/05_free_trial.mdx | 31 ------------ .../biganimal/release/free_trial/index.mdx | 49 ++++++++++++++++--- product_docs/docs/biganimal/release/index.mdx | 4 +- 5 files changed, 45 insertions(+), 86 deletions(-) delete mode 100644 product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx index 75081c25278..c6f78ef0133 100644 --- a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx @@ -3,27 +3,4 @@ title: "Connect to your cluster" indexCards: none --- -The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. - -## Create an account - -- [Create your EDB account](01_create_account) -- [Sign up for the trial](#) - -## Create a cluster - -- [...Using the portal](#) -- [Using the CLI](create_cluster_cli) -- [Using the API](#) - -## Connect - -- [Using psql](#) -- [Using pgAdmin](#) - -## Experiment - -- [Testing backups by restoring a cluster](backup_and_restore) -- [Full PostgreSQL](#) -- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx index 105e528a26e..ee192469d8a 100644 --- a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx @@ -4,27 +4,3 @@ navTitle: "Experimenting" indexCards: none --- -The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. - -## Create an account - -- [Create your EDB account](01_create_account) -- [Sign up for the trial](#) - -## Create a cluster - -- [...Using the portal](#) -- [Using the CLI](create_cluster_cli) -- [Using the API](#) - -## Connect - -- [Using psql](#) -- [Using pgAdmin](#) - -## Experiment - -- [Testing backups by restoring a cluster](backup_and_restore) -- [Full PostgreSQL](#) -- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) - diff --git a/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx b/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx deleted file mode 100644 index 7b82005d5f0..00000000000 --- a/product_docs/docs/biganimal/release/free_trial/05_free_trial.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: BigAnimal free trial limitations -navTitle: "Free trial limitations" -indexCards: none ---- - -EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. - -## What you can do with your free trial -- The free trial lasts for 14 days. The count begins when you provision a cluster. -- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. -- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). - - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. - - Numerous other instance types, storage types, and regions are available with a paid account. -- During the trial, you have access to EDB enterprise-level support. -- You can connect to your database cluster. -- You can edit the database configuration for a cluster and view the activity log for the service. -- You get an understanding of what account management looks like in BigAnimal. - -## What you can’t do -Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: - -- You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- Backups are only retained for 30 days. -- The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. - -## What happens when the free trial ends - -Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. - -When the free trial ends, your account continues to exist but your cluster and its backup and data are deleted. You cannot transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index c6912bca499..5d1821191e7 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -1,21 +1,30 @@ --- title: "Getting started with the BigAnimal Free Trial" -navTitle: "Getting started with a free trial" +navTitle: "Start your Free Trial" indexCards: none --- The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. +_or_ + +EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. + ## Create an account -- [Create your EDB account](01_create_account) -- [Sign up for the trial](#) +If you haven't done so already, you'll need to [create your EDB account](01_create_account). Once you've done that, you can [sign up for the trial](#). The trial period starts only after you create your first cluster. ## Create a cluster -- [...Using the portal](#) -- [Using the CLI](02_creating_a_cluster/create_cluster_cli) -- [Using the API](#) +The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to ba active at a time, you are free to delete your cluster and create a new one. It's even possible to any cluster you've previously deleted. + +BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced Server (EPAS) clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11-13). Other configuration options are limited for the free trail. + +There are three ways to create a cluster: + +1. [Using the portal](#) +2. [Using the CLI](02_creating_a_cluster/create_cluster_cli) +3. [Using the API](#) ## Connect @@ -24,6 +33,32 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl ## Experiment -- [Testing backups by restoring a cluster](backup_and_restore) +- [Testing backups by restoring a cluster](04_experiment/backup_and_restore) - [Full PostgreSQL](#) - [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) + + + +## What you can do with your free trial +- The free trial lasts for 14 days. The count begins when you provision a cluster. +- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. +- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). + - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. + - Numerous other instance types, storage types, and regions are available with a paid account. +- During the trial, you have access to EDB enterprise-level support. +- You can connect to your database cluster. +- You can edit the database configuration for a cluster and view the activity log for the service. +- You get an understanding of what account management looks like in BigAnimal. + +## What you can’t do +Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: + +- You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. +- Backups are only retained for 30 days. +- The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. + +## What happens when the free trial ends + +Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. + +When the free trial ends, your account continues to exist but your cluster and its backup and data are deleted. You cannot transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. diff --git a/product_docs/docs/biganimal/release/index.mdx b/product_docs/docs/biganimal/release/index.mdx index 5efe10ded3c..539c2f313d5 100644 --- a/product_docs/docs/biganimal/release/index.mdx +++ b/product_docs/docs/biganimal/release/index.mdx @@ -7,7 +7,9 @@ directoryDefaults: iconName: "logos/Biganimal" navigation: - overview - - getting_started + - "#Free Trial" + - free_trial + - "#Full Version" - using_cluster - administering_cluster - pricing_and_billing From aabe74ad671d2b8bbf44d5b2c90f81b3f78a82d6 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Fri, 18 Feb 2022 01:53:24 +0000 Subject: [PATCH 08/53] fill-in text + structure --- .../free_trial/01_create_account/index.mdx | 4 +- .../biganimal/release/free_trial/index.mdx | 58 +++++++++++-------- product_docs/docs/biganimal/release/index.mdx | 1 + src/pages/index.js | 6 ++ 4 files changed, 45 insertions(+), 24 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx index 104a9567ca8..b78fdc243f5 100644 --- a/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx @@ -7,7 +7,9 @@ _Maybe a video here?_ _Detail what information you'll need to provide._ +_Maybe a direct link...?_ https://www.enterprisedb.com/accounts/register/biganimal + You can request a BigAnimal free trial from several locations: - The EDB [Get started](https://www.enterprisedb.com/get-started) sign-up page - The [BigAnimal home page](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) -- The EDB login page \ No newline at end of file +- The EDB login page diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 5d1821191e7..e24d2ee355e 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -1,55 +1,65 @@ --- title: "Getting started with the BigAnimal Free Trial" -navTitle: "Start your Free Trial" +navTitle: "Getting started with a free trial" indexCards: none --- -The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the capabilities that BigAnimal has to offer. +The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. +The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. -_or_ +## What you get as part of the free trial -EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. +- **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases**. +- **One active cluster, unlimited inactive ones** + - You can try different configurations by deleting the active cluster and creating a new one. + - Restore deleted clusters at any time within the trial period. + - 2 vCPUs and 16 GB RAM with up to 4GB of Azure Premium SSD storage. + - 2 Azure Regions to choose from: US East 2 or West Europe (Netherlands). +- **Edit database configuration settings.** +- **Connect to your cluster** via a public IP from psql, pgAdmin, or your favorite PostgreSQL-friendly application. +- **Access to EDB enterprise-level support.** +- **Use BigAnimal services for 14 days.** The countdown begins when you first provision a cluster. + +(Numerous other instance types, storage types, regions, customizations and support options are available with a paid account.) + +Get started with your trial by signing up for a free EDB account. ## Create an account -If you haven't done so already, you'll need to [create your EDB account](01_create_account). Once you've done that, you can [sign up for the trial](#). The trial period starts only after you create your first cluster. +If you haven't done so already, you'll need to [create your EDB account](01_create_account). Once you've done that, you can [sign up for the trial](#). + +Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Accounts are free, and registration takes less than a minute. ## Create a cluster -The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to ba active at a time, you are free to delete your cluster and create a new one. It's even possible to any cluster you've previously deleted. +The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to ba active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced Server (EPAS) clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11-13). Other configuration options are limited for the free trail. -There are three ways to create a cluster: +There are several equivalent ways to create a cluster... -1. [Using the portal](#) -2. [Using the CLI](02_creating_a_cluster/create_cluster_cli) -3. [Using the API](#) +- [...Using the portal](#) +- [...Using the CLI](02_creating_a_cluster/create_cluster_cli) +- [...Using the API](#) ## Connect +Once you have a running cluster, you can connect using any PostgreSQL compatible software - here are a few ideas to get you going: + - [Using psql](#) - [Using pgAdmin](#) +- [Using VSCode](#) ## Experiment +A database is always more interesting when it contains... Data! +Load up some sample data and see what BigAnimal lets you do with it: + - [Testing backups by restoring a cluster](04_experiment/backup_and_restore) - [Full PostgreSQL](#) - [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) - - -## What you can do with your free trial -- The free trial lasts for 14 days. The count begins when you provision a cluster. -- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. -- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). - - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. - - Numerous other instance types, storage types, and regions are available with a paid account. -- During the trial, you have access to EDB enterprise-level support. -- You can connect to your database cluster. -- You can edit the database configuration for a cluster and view the activity log for the service. -- You get an understanding of what account management looks like in BigAnimal. - ## What you can’t do Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: @@ -62,3 +72,5 @@ Since this is a free trial, there are a few nuances and limitations to what you Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. When the free trial ends, your account continues to exist but your cluster and its backup and data are deleted. You cannot transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. + +We hope two weeks is enough to give you a rough idea of what BigAnimal offers, but if you're interested in *really* seeing it in action we also offer a 30-day trial of the full product, running on your own Azure account with full access to all regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/index.mdx b/product_docs/docs/biganimal/release/index.mdx index 539c2f313d5..587dfa67d65 100644 --- a/product_docs/docs/biganimal/release/index.mdx +++ b/product_docs/docs/biganimal/release/index.mdx @@ -10,6 +10,7 @@ navigation: - "#Free Trial" - free_trial - "#Full Version" + - getting_started - using_cluster - administering_cluster - pricing_and_billing diff --git a/src/pages/index.js b/src/pages/index.js index c7b8802dedb..f84f4b50d88 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -144,6 +144,12 @@ const Page = () => ( BigAnimal + + Free Trial + Date: Thu, 3 Mar 2022 11:14:32 -0800 Subject: [PATCH 09/53] Filling in some narrative --- .../create_cluster_cli.mdx | 41 ++++-------- .../04_experiment/backup_and_restore.mdx | 65 ++++++++++++------- 2 files changed, 56 insertions(+), 50 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx index b45b605ad56..098c4f83816 100644 --- a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx @@ -4,49 +4,34 @@ navTitle: "Using the command line" indexCards: none --- -Download the CLI: + +We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever you system will find executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. ```shell -curl -L0 "https://cli.biganimal.com/download/$(uname -s)/$(uname -m)/latest/biganimal" +mv biganimal $HOME/bin ``` -Create a credential on BigAnimal. You can pick any username you prefer. +It may also be necessary to give the executable proper permission: ```shell -./biganimal create-credential -a portal.staging.enterprisedb.network -o 443 -n newuser +chmod +x $HOME/bin/biganimal ``` -The command will direct you to open a webpage and copy the randomly-generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. - -To verify what credentials you have verified: +Next, we need to create a credential on BigAnimal. You can pick any username you prefer. ```shell -./biganimal show-credentials +biganimal create-credential -a portal.biganimal.com -o 443 -n newuser ``` -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Credentials ┃ -┣━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┫ -┃ Name ┃ Address ┃ Port ┃ -┣━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━┫ -┃ newuser ┃ portal.staging.enterprisedb.network ┃ 443 ┃ -┗━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━┛ + +The command will direct you to open a webpage and copy the randomly-generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. You can see which credentials you have verified on the command line. + +```shell +biganimal show-credentials ``` If you add another credential, you’ll need to add --credential newuser to the following commands. If you only have one, the option is not needed. Pick the region closest to you from the list provided by biganimal: ```shell -./biganimal show-regions -``` -``` -Provider ID: Azure -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Regions ┃ -┣━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┫ -┃ Region Id ┃ Region Name ┃ -┣━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫ -┃ eastus2 ┃ (US) East US 2 ┃ -┃ westeurope ┃ (Europe) West Europe ┃ -┗━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━┛ +biganimal show-regions ``` Other options can be queried via the CLI, but this is the only variable we need to set for this demo. diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx index 25d7cf6a86b..0169aa98f3e 100644 --- a/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx @@ -4,19 +4,30 @@ navTitle: "Backup and restore" indexCards: none --- -1. [Create a cluster](create_cluster_cli) +BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trail as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. -2. [Create a new role/db called baseball](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) +If you haven't already, [create a cluster](create_cluster_cli) on BigAnimal. For the free trial, you may only have one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. + +We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball" which we will populate with some Major League Baseball statistics. -3. Connect to the baseball database +```sql +create user baseball with password 'baseball_pwd'; +grant baseball to edb_admin; +create database baseball with owner baseball; +``` + +Now you can switch to your new (and empty) baseball database. ```sql \c baseball ``` -4. Change the prompt so that we have an accurate timestamp for knowing when to recover. +Normally we'd use log files to determine the moment in time that we want to restore. The free trial doesn't provide access to the logs, however. So that we have accurate timing of our activities, let's change the prompt to include a timestamp. +```sql +\set PROMPT1 '%`date +%H:%M:%S` %/%R%# ' +``` + +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. ```sql -baseball=> \set PROMPT1 '%`date +%H:%M:%S` %/%R%# ' -Create a table for batters. CREATE TABLE batters ( id SERIAL, playerid VARCHAR(9), @@ -45,44 +56,53 @@ CREATE TABLE batters ( ); ``` -5. Populate the table from the internet. +Now we can populate the table from the internet using the most recent data. ```sql \COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER ``` -6. Make sure there is data in the table using select. +Just to prove there's data loaded, let's look at the homerun leaders for the 1998 season. ```sql -select playerid, yearid, teamid, +SELECT playerid, yearid, teamid, rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, hr -from batters -where yearid = 1998 -order by hr_rank limit 5; +FROM batters +WHERE yearid = 1998 +ORDER BY hr_rank LIMIT 5; +``` + +Suppose someone wanted to revise history a bit. +```sql +UPDATE batters +SET hr=0 +where playerid = 'mcgwima01' AND yearid = 1998; ``` -7. Drop that table! (Note the time!) +Note the time so we can restore that data later. Verify the data has been changed by re-running the 1998 homerun leader query. Now for good measure, go ahead and drop the whole table. ```sql -10:00:39 baseball=> drop table batters; -DROP TABLE +DROP TABLE batters; ``` -8. Re-run the select to verify the data is gone. +You can verify the table is gone by looking at the list of tables. +```sql +\dt +``` -9. For the free trial, you are limited to one active cluster. Restoring a cluster creates a brand new cluster that is initialized with the cluster backup. Quit psql (\q) and delete the cluster from the command line. +For the free trial, you are limited to one active cluster. Restoring a cluster creates a brand new cluster that is initialized with the cluster backup. Quit psql (`\q`) and delete the cluster from the command line. ```shell ./biganimal delete-cluster --id p-xxxxxxxxxxx ``` -10. Restore the cluster using the timestamp before the time you dropped the table. (This currently requires using the web interface.) +Restore the cluster using the timestamp before the time you dropped the table. (This currently requires using the web interface.) -11. Check the status of the new cluster from the command line. +Check the status of the new cluster from the command line. ```shell ./biganimal show-clusters ``` -12. Log into the new cluster. Again use the edb_admin password used when creating the cluster you recently deleted. +Log into the new cluster. Again use the edb_admin password used when creating the cluster you recently deleted. -13. Verify that the batters table has been restored: +Verify that the batters table has been restored: ```sql select playerid, yearid, teamid, rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, @@ -90,4 +110,5 @@ select playerid, yearid, teamid, from batters where yearid = 1998 order by hr_rank limit 5; -``` \ No newline at end of file +``` + From 987a8f6eceba69d65f9a810273a97cae45fc1c50 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Fri, 4 Mar 2022 09:22:02 -0800 Subject: [PATCH 10/53] Add an index for creating a cluster --- .../create_cluster_cli.mdx | 16 ++++++++++------ .../free_trial/02_creating_a_cluster/index.mdx | 18 ++++++++++++++++++ 2 files changed, 28 insertions(+), 6 deletions(-) create mode 100644 product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx index 098c4f83816..59aac8253a8 100644 --- a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx @@ -27,14 +27,18 @@ The command will direct you to open a webpage and copy the randomly-generated, o biganimal show-credentials ``` -If you add another credential, you’ll need to add --credential newuser to the following commands. If you only have one, the option is not needed. +!!! caution +If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option is not needed. You may remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users will not need to add multiple credentials. +!!! + +In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. Pick the region closest to you from the list provided by biganimal: ```shell biganimal show-regions ``` -Other options can be queried via the CLI, but this is the only variable we need to set for this demo. +Other options can be queried via the CLI, but the only variable we need to set for this demo is . Edit a new file called create_cluster.yaml: ```yaml @@ -55,20 +59,20 @@ highAvailability: false Use the config file to create a new cluster: ```shell -./biganimal create-cluster --clusterConfigFile create_cluster.yaml +biganimal create-cluster --clusterConfigFile create_cluster.yaml ``` If successful, the command will give you a command to check the status of your new cluster: ```shell -./biganimal show-clusters --id p-xxxxxxxxxx +biganimal show-clusters --id p-xxxxxxxxxx ``` The id will be used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: ```shell -./biganimal show-cluster-connection --id p-xxxxxxxxxxx +biganimal show-cluster-connection --id p-xxxxxxxxxxx ``` Once the cluster is created, log in via psql. Use the password from the config file for edb_admin. ```shell -psql 'postgres://edb_admin@p-xxxxxxxxxx.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require' +psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require' ``` diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx new file mode 100644 index 00000000000..e49510feb84 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx @@ -0,0 +1,18 @@ +--- +title: "Create a cluster" +indexCards: none +--- + +The BigAnimal Free Trial allows one active cluster. If you want to try another configutation, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](/biganimal/latest/free_trial/04_experiment/backup_and_restore/). Backups are automaticly created by default. + +When you create a cluster, there are two flavors of PostgreSQL to choice from: + +* All supported versions of [open-source PostgreSQL](supported-open-source/postgresql/), including [PostgreSQL 14](https://www.postgresql.org/about/news/postgresql-14-released-2318/). +* [EDB Postgres Advanced Server](/epas/latest/), which augments open-source PostgreSQL with [Oracle compatibilty](/epas/latest/epas_compat_ora_dev_guide/) among other features. + +We'll demonstate two methods of creating a cluster: + +* [Using the portal](#) +* [Using the command line](create_cluster_cli) + +Clusters may also be created pragmatically using the [fully-featured BigAnimal API](/biganimal/latest/reference/api/). From 346cfab778910f56cf26cfc08d9e866a15ee574f Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Sat, 5 Mar 2022 01:58:42 +0000 Subject: [PATCH 11/53] Brad's suggestion for more explicit PG/EPAS differentiation in the intro --- product_docs/docs/biganimal/release/free_trial/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index e24d2ee355e..177ad5ad078 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -10,6 +10,8 @@ The free trial provides a subset of the full-featured BigAnimal environment so t ## What you get as part of the free trial - **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases**. + - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more powerful, more secure, more flexible, more secure and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). + - [EDB Postgres Advanced Server 14](https://www.enterprisedb.com/docs/epas/latest/epas_rel_notes/) builds on PostgreSQL 14 with a host of features for Oracle database compatibility, security, and usability ([more on Oracle database compatibility](/epas/latest/epas_compat_ora_dev_guide/)). - **One active cluster, unlimited inactive ones** - You can try different configurations by deleting the active cluster and creating a new one. - Restore deleted clusters at any time within the trial period. From d2a2e22dbf71ad8d0d37ce6f3a57ff34cf9cc73e Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Sat, 5 Mar 2022 05:24:48 +0000 Subject: [PATCH 12/53] rough connect instructions --- .../release/free_trial/03_connect/index.mdx | 87 +++++++++++++++++++ .../biganimal/release/free_trial/index.mdx | 6 +- 2 files changed, 90 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx index c6f78ef0133..75f6b5fad34 100644 --- a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx @@ -3,4 +3,91 @@ title: "Connect to your cluster" indexCards: none --- +So, you've created a cluster... Now what? You probably want to connect to it! + +BigAnimal clusters are Real Actual Postgres Databases, so you can connect to them just as you would any other Postgres database. Here are a few examples: + +## Connect using psql + +[psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) +and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, there are quite a few commands for +inspecting and managing the database built in that make light work of even complex tasks. + +You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. e.g. + +```shell +psql -W "postgres://edb_admin@p-xj6qj8i1hx.qsbilba3hlgp1vqr.biganimal.io:5432/edb_admin?sslmode=require" +``` + +The URI is all that's necessary for psql; while you *can* pass each element of that URL individually +(pulling the information from the Connect tab on the portal for instance), psql will happily parse it out for you (and prompt for the password). + +In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). + + +!!! EDB Postgres Advanced Server enhancements + If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as +tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client will work with Advanced Server as well. + +## Connect using pgAdmin + +Prefer using a GUI to work with your cluster? [The pgAdmin project](https://www.pgadmin.org/download/) provides just that: inspect, monitor, manage and query your cluster's databases from a desktop or web UI. + +A quick way to try out pgAdmin is to run it in a Docker container. With Docker installed, run: + +```shell +docker run -p 8000:80 \ + -e 'PGADMIN_DEFAULT_EMAIL=user@example.com' \ + -e 'PGADMIN_DEFAULT_PASSWORD=password' \ + -d dpage/pgadmin4 +__OUTPUT__ +Unable to find image 'dpage/pgadmin4:latest' locally +latest: Pulling from dpage/pgadmin4 +59bf1c3509f3: Already exists +34e720c4612b: Pull complete +8ef193cd122b: Pull complete +4377f1371242: Pull complete +9205bee41667: Pull complete +d5e36d286558: Pull complete +9c91d0528419: Pull complete +86e0602b566c: Pull complete +cf0d28491ace: Pull complete +198776d7d0ce: Pull complete +f7909c1938d8: Pull complete +9d477f4ed5d3: Pull complete +51c0f4ca201e: Pull complete +bc906010b44f: Pull complete +Digest: sha256:18cc2c7cce64b3f95b1ff13ec835da88c25b30d3745a02774abcd166379dae60 +Status: Downloaded newer image for dpage/pgadmin4:latest +99f4775629b1086b95601d659eae9dfe7125c4694a1a90891f840d12f8ca0261 +``` + +Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ then entering the email and password specified on the command line. + +[screenshot] + +From the welcome page, select Add New Server. You'll be prompted to configure the connection: + +[screenshot] + +Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then click "Connection" + +[screenshot] + +1. Enter your cluster's hostname in the Host name/address field, +2. `edb_admin` in the Maintenance database field (this is the default database that'll be connected to by pgAdmin), +3. `edb_admin` in the Username field, +4. and the password you provided when configuring your cluster in the Password field (you may want to save this for convenience while testing). + +Click SSL and change SSL mode to "Require". + +Finally, click the "Save" button. pgAdmin will try to establish a connection to your database, and when successful will display the dashboard +along with the list of available databases on the left. + + +## Connect using VSCode + +// TODO: pick one of the dozens of extensions for this + +## Connect using DBeaver diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 177ad5ad078..0f0add8a235 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -49,9 +49,9 @@ There are several equivalent ways to create a cluster... Once you have a running cluster, you can connect using any PostgreSQL compatible software - here are a few ideas to get you going: -- [Using psql](#) -- [Using pgAdmin](#) -- [Using VSCode](#) +- [Using psql](03_connect/#connect-using-psql) +- [Using pgAdmin](03_connect/#connect-using-pgadmin) +- [Using VSCode](03_connect/#connect-using-vscode) ## Experiment From b408a4f01ea7972c029efea33667f94bbd47c659 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Mon, 7 Mar 2022 09:38:33 -0800 Subject: [PATCH 13/53] Mention the free trial in the BA overview --- product_docs/docs/biganimal/release/overview/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/overview/index.mdx b/product_docs/docs/biganimal/release/overview/index.mdx index 84de73b868d..df6be4c3991 100644 --- a/product_docs/docs/biganimal/release/overview/index.mdx +++ b/product_docs/docs/biganimal/release/overview/index.mdx @@ -6,3 +6,5 @@ indexCards: simple BigAnimal is a fully managed database-as-a-service with built-in Oracle compatibility, running in your cloud account and operated by the Postgres experts. BigAnimal makes it easy to set up, manage, and scale your databases. Provision [PostgreSQL](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) or [EDB Postgres Advanced Server](https://www.enterprisedb.com/docs/epas/latest/) with Oracle compatibility. + +To sample BigAnimal, [get started with a free trial](/biganimal/latest/free_trial/). \ No newline at end of file From 3a6303c47d763c4ebcd5e02c9763485747ed3334 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Tue, 8 Mar 2022 12:24:24 -0800 Subject: [PATCH 14/53] Add a seperate page for importing sample data --- .../02_creating_a_cluster/index.mdx | 2 +- .../free_trial/04_experiment/import_data.mdx | 52 +++++++++++++++++++ .../free_trial/04_experiment/index.mdx | 4 ++ 3 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx index e49510feb84..6f28a404e20 100644 --- a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx @@ -3,7 +3,7 @@ title: "Create a cluster" indexCards: none --- -The BigAnimal Free Trial allows one active cluster. If you want to try another configutation, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](/biganimal/latest/free_trial/04_experiment/backup_and_restore/). Backups are automaticly created by default. +The BigAnimal Free Trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](/biganimal/latest/free_trial/04_experiment/backup_and_restore/). Backups are automaticly created by default. When you create a cluster, there are two flavors of PostgreSQL to choice from: diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx new file mode 100644 index 00000000000..061d53a442a --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx @@ -0,0 +1,52 @@ +--- +title: "Import data from external sources" +navTitle: "Import data" +--- + +PostgreSQL includes a variety of ways to import data. Here we'll show how to import a CVS file from the internet. + +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. +```sql +CREATE TABLE batters ( + id SERIAL, + playerid VARCHAR(9), + yearid INTEGER, + stint INTEGER, + teamid VARCHAR(3), + lgid VARCHAR(2), + g INTEGER, + ab INTEGER, + r INTEGER, + h INTEGER, + "2b" INTEGER, + "3b" INTEGER, + hr INTEGER, + rbi INTEGER, + sb INTEGER, + cs INTEGER, + bb INTEGER, + so INTEGER, + ibb INTEGER, + hbp INTEGER, + sh INTEGER, + sf INTEGER, + gidp INTEGER, + PRIMARY KEY (id) +); +``` + +Now we can populate the table from the internet using the most recent data. +```sql +\COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER +``` + +Just to prove there's data loaded, let's look at the homerun leaders for the 1998 season. +```sql +SELECT playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +FROM batters +WHERE yearid = 1998 +ORDER BY hr_rank LIMIT 5; +``` + diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx index ee192469d8a..fb7db77744c 100644 --- a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx @@ -4,3 +4,7 @@ navTitle: "Experimenting" indexCards: none --- +Once you have [created a cluster](/biganimal/latest/free_trial/02_creating_a_cluster/), it's time to put it through its paces. + +* [Import data](import_data) +* [Backup and restore](backup_and_restore) From b27327ed9d15dc17c6c4aa260c78ea40fedd8602 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Thu, 10 Mar 2022 07:51:53 -0800 Subject: [PATCH 15/53] fill in more detail in the data import --- .../free_trial/04_experiment/import_data.mdx | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx index 061d53a442a..749a4d7d788 100644 --- a/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx +++ b/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx @@ -5,7 +5,24 @@ navTitle: "Import data" PostgreSQL includes a variety of ways to import data. Here we'll show how to import a CVS file from the internet. -For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. + +We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball" which we will populate with some Major League Baseball statistics. + +```sql +create user baseball with password 'baseball_pwd'; +grant baseball to edb_admin; +create database baseball with owner baseball; +``` + +Now you can switch to your new (and empty) baseball database. +```sql +\c baseball +``` + + + +You can just copy and paste this command into your terminal. ```sql CREATE TABLE batters ( id SERIAL, From 2d4b07b766ff62d7cacaa8624a8010a95b753dc1 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Tue, 15 Mar 2022 16:05:42 -0700 Subject: [PATCH 16/53] Add a portal placeholder --- .../02_creating_a_cluster/create_cluster_portal.mdx | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx new file mode 100644 index 00000000000..695b8d79073 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx @@ -0,0 +1,7 @@ +--- +title: Creating a cluster using the web portal +navTitle: "Using the portal" +indexCards: none +--- + +Use the [Create a cluster on the CLI](create_cluster_cli) as a script for creating a cluster using the portal. Probably a video. \ No newline at end of file From 373ad82950cd2284aa35e42b0d26ffbd94686c68 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Fri, 18 Mar 2022 10:33:03 -0700 Subject: [PATCH 17/53] Draft quickstart guide inspired by Cockroach --- .../free_trial/quickstart_trial_biganimal.mdx | 110 ++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx new file mode 100644 index 00000000000..77140f75e98 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx @@ -0,0 +1,110 @@ +--- +title: "Quickstart with the BigAnimal Free Trial" +navTitle: "Quickstart" +indexCards: none +--- + +This page shows you how to create a PostgreSQL or EDB Postgres Advanced Server cluster using BigAnimal (free for 14 days), connect to the cluster, import sample data, and run some queries. + +## Step 1. Create a free trial cluster + +We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) cluster based on the latest PostgreSQL release. It will be hosted on [ideally AWS, but for the moment I'm using] Azure. + +1. If you haven't done so already, [create your EDB account](https://62312143bb9e32503f5ac560--edb-docs-staging.netlify.app/docs/biganimal/latest/free_trial/01_create_account/). + +2. Sign up for a free trial of BigAnimal. + +3. Navigate to the [Create Cluster](https://portal.biganimal.com/create-cluster) page. + +4. Enter a name for your cluster in the **Cluster Name** field. + +5. Pick a secure **Password** for your cluster. + +6. Select `EnterpriseDB PostgreSQL Advanced Server (EPAS)` as your **Database Type**. + +7. For **Postgres Version**, use `14` for the most advanced features. + +8. Select [AWS, whe that's possible, but for now] `Microsoft Azure` for the **Provider**. + +9. Pick the **Region** nearest you. + +10. Under **Instance Series** pick [whatever makes sense for AWS or] `Standard DSv3 Family vCPUs`. + +11. Use [AWS option or] `D2s v3 (2vCPU, 8GB RAM)` for the **Size**. + +12. Select [whatever AWS needs or] `P1 (4 Gi, 120 Provisioned IOPS, 25 Provisioned MB/s)` for the cluster's **Volume Properies**. + +13. Push the **Create Cluster** button to create your cluster. + +It takes about 5 minutes for the cluster to be spun up. While you are waiting, watch [a video about setting up a connection]. + +## Step 2. Connect to your cluster + +[Index of the top N ways to connect to a cluster.] + +* Command line using `psql` +* pgAdmin +* VSCode +* DBeaver +* Other? + +[Maybe stop here?] + +## Step 3. Create a new database (optional) + +We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. + +[For each of the ways to connect, link to the documentation about how to create a new database.] + +## Step 4. Populate sample data + +We're going to use temporary tables to calculate prime numbers usings a Sieve of Eratosthenes. First we need to create a table of primes. + + +```sql +CREATE TABLE primes ( + num INTEGER, + PRIMARY KEY (num) +); +``` + +[Turns out to be kinda a lot of complicated SQL. Probably better to use a simplier example. I wanted to import data, but that very much depends on the way the user connects. pgAdmin can't use the COPY command without jumping through some hoops, for instance.] + +```sql +-- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes + +WITH RECURSIVE +t0(m) AS ( + VALUES(1000) +), +t1(n) AS ( + VALUES(2) +UNION ALL + SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) +), +t2 (n, i) AS ( + SELECT 2*n, 2 + FROM t1 WHERE 2*n <= (SELECT m FROM t0) +UNION ALL + ( + WITH t3(k) AS ( + SELECT max(i) OVER () + 1 FROM t2 + ), + t4(k) AS ( + SELECT DISTINCT k FROM t3 + ) + SELECT k*n, k + FROM + t1 + CROSS JOIN + t4 + WHERE k*k <= (SELECT m FROM t0) + ) +) +INSERT INTO primes ( + SELECT n FROM t1 EXCEPT + SELECT n FROM t2 + ORDER BY 1 +); +``` + From 50f35f8c70f7bde9720631aa7dfada59ba00e340 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Tue, 29 Mar 2022 11:10:48 -0700 Subject: [PATCH 18/53] Use AWS and cleaning up the flow --- .../free_trial/quickstart_trial_biganimal.mdx | 167 +++++++++++------- 1 file changed, 102 insertions(+), 65 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx index 77140f75e98..cb8f97f53f9 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx @@ -4,11 +4,11 @@ navTitle: "Quickstart" indexCards: none --- -This page shows you how to create a PostgreSQL or EDB Postgres Advanced Server cluster using BigAnimal (free for 14 days), connect to the cluster, import sample data, and run some queries. +This page shows you how to create a PostgreSQL or EDB Postgres Advanced Server cluster using BigAnimal (free for 14 days), connect to the cluster, populate sample data, and run some queries. ## Step 1. Create a free trial cluster -We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) cluster based on the latest PostgreSQL release. It will be hosted on [ideally AWS, but for the moment I'm using] Azure. +We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) cluster based on the latest PostgreSQL release. It will be hosted on AWS. 1. If you haven't done so already, [create your EDB account](https://62312143bb9e32503f5ac560--edb-docs-staging.netlify.app/docs/biganimal/latest/free_trial/01_create_account/). @@ -16,7 +16,7 @@ We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) clus 3. Navigate to the [Create Cluster](https://portal.biganimal.com/create-cluster) page. -4. Enter a name for your cluster in the **Cluster Name** field. +4. Enter a name for your cluster in the **Cluster Name** field. ( 5. Pick a secure **Password** for your cluster. @@ -24,15 +24,15 @@ We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) clus 7. For **Postgres Version**, use `14` for the most advanced features. -8. Select [AWS, whe that's possible, but for now] `Microsoft Azure` for the **Provider**. +8. Select `AWS` for the **Provider**. 9. Pick the **Region** nearest you. -10. Under **Instance Series** pick [whatever makes sense for AWS or] `Standard DSv3 Family vCPUs`. +10. Under **Instance Series** pick `AWS EC2 R5 Instances`. -11. Use [AWS option or] `D2s v3 (2vCPU, 8GB RAM)` for the **Size**. +11. Use `r5.large, 2vCPU, 16GB RAM` for the **Size**. -12. Select [whatever AWS needs or] `P1 (4 Gi, 120 Provisioned IOPS, 25 Provisioned MB/s)` for the cluster's **Volume Properies**. +12. Leave all other options on their default. 13. Push the **Create Cluster** button to create your cluster. @@ -40,71 +40,108 @@ It takes about 5 minutes for the cluster to be spun up. While you are waiting, w ## Step 2. Connect to your cluster -[Index of the top N ways to connect to a cluster.] +1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. +2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. -* Command line using `psql` -* pgAdmin -* VSCode -* DBeaver -* Other? + ``` + $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" + Password: + psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) + WARNING: psql major version 13, server major version 14. + Some psql features might not work. + SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) + Type "help" for help. -[Maybe stop here?] + edb_admin=> + ``` ## Step 3. Create a new database (optional) We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. -[For each of the ways to connect, link to the documentation about how to create a new database.] +1. Create a new role called `math`. -## Step 4. Populate sample data + ``` + create user math with password 'math_password'; + ``` + +2. Grant the `math` role to `edb_admin`. + + ``` + grant math to edb_admin; + ``` + +3. Create a new `math` database. -We're going to use temporary tables to calculate prime numbers usings a Sieve of Eratosthenes. First we need to create a table of primes. - - -```sql -CREATE TABLE primes ( - num INTEGER, - PRIMARY KEY (num) -); -``` - -[Turns out to be kinda a lot of complicated SQL. Probably better to use a simplier example. I wanted to import data, but that very much depends on the way the user connects. pgAdmin can't use the COPY command without jumping through some hoops, for instance.] - -```sql --- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes - -WITH RECURSIVE -t0(m) AS ( - VALUES(1000) -), -t1(n) AS ( - VALUES(2) -UNION ALL - SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) -), -t2 (n, i) AS ( - SELECT 2*n, 2 - FROM t1 WHERE 2*n <= (SELECT m FROM t0) -UNION ALL - ( - WITH t3(k) AS ( - SELECT max(i) OVER () + 1 FROM t2 - ), - t4(k) AS ( - SELECT DISTINCT k FROM t3 - ) - SELECT k*n, k - FROM - t1 - CROSS JOIN - t4 - WHERE k*k <= (SELECT m FROM t0) - ) -) -INSERT INTO primes ( - SELECT n FROM t1 EXCEPT - SELECT n FROM t2 - ORDER BY 1 -); -``` + ``` + create database math with owner math; + ``` + +4. Connect to the `math` database. + + ``` + create database math with owner math; + ``` + +## Step 4. Populate sample data +We're going to use temporary tables to calculate prime numbers using a Sieve of Eratosthenes. + +1. Create a table for storing prime numbers called `primes`. + + ```sql + CREATE TABLE primes ( + num INTEGER, + PRIMARY KEY (num) + ); + ``` + +2. Populate the table with all prime numbers up to 1000. (This code is based on [code from David Fetter](https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes).) + + ```sql + -- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes + + WITH RECURSIVE + t0(m) AS ( + VALUES(1000) + ), + t1(n) AS ( + VALUES(2) + UNION ALL + SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) + ), + t2 (n, i) AS ( + SELECT 2*n, 2 + FROM t1 WHERE 2*n <= (SELECT m FROM t0) + UNION ALL + ( + WITH t3(k) AS ( + SELECT max(i) OVER () + 1 FROM t2 + ), + t4(k) AS ( + SELECT DISTINCT k FROM t3 + ) + SELECT k*n, k + FROM + t1 + CROSS JOIN + t4 + WHERE k*k <= (SELECT m FROM t0) + ) + ) + INSERT INTO primes ( + SELECT n FROM t1 EXCEPT + SELECT n FROM t2 + ORDER BY 1 + ); + ``` + +3. Select the largest prime number less than 1000. + + ``` + SELECT max(num) + FROM primes + WHERE num < 1000; + ``` + +You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. From a5921d8f759d771341e826576b368c016de77cb0 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 22 Feb 2022 06:34:42 -0500 Subject: [PATCH 19/53] EPRS 6.2.17 - New Release --- .../13_eprs_rel_notes_6.2.16.mdx | 22 ++----------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx b/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx index 33eb911ca65..d956a2f6319 100644 --- a/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx +++ b/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx @@ -1,5 +1,5 @@ --- -title: "Version 6.2.16" +title: "Version 6.2.17" --- @@ -7,23 +7,5 @@ New features, enhancements, bug fixes, and other changes in EDB Postgres Replica | Type | Description | | ----------- |------------ | -| Enhancement | Replication Server is certified to support PostgreSQL v14 and EDB Postgres Advanced Server v14. | -| Enhancement | Performance optimization for Synchronize operation when a MMR Publication has a SMR Subscription. [Support Ticket #74217] | -| Bug Fix | The `removepub` CLI command removes a Publication while it has one or more Subscriptions. This issue is fixed. [Support Ticket #72194] | -| Bug Fix | Fixed an issue where replication fails for the `UUID` data type in EDB Postgres Advanced Server to MS SQL Server permutation. [Support Ticket #73835] | -| Bug Fix | Fixed an issue where the Synchronize operation failed to replicate NULL for a BLOB type for EDB Postgres Advanced Server to Oracle. [Support Ticket #74057] | -| Bug Fix | Fixed case where wrong schema qualifier was picked up during history cleanup for EDB Postgres Advanced Server to Oracle and SQL Server permutations. [Support Ticket #72626] | -| Bug Fix | Fixed loading of Replication History on Replication Console after restart of Publication Services when SMR subscription is associated with a MMR Publication. [Support Ticket #74217] | -| Bug Fix | Fixed the upgrade issue related with the enhancement of shadow table triggers. [Support Ticket #74447] | -| Bug Fix | Fixed an issue where redundant INSERT conflicts were recorded when a new table was added in the MMR Publication. | -| Bug Fix | In a hybrid replication cluster, the cleanup shadow table routine is subject to remove unprocessed changes. This issue is fixed. | -| Bug Fix | The Synchronize replication fails while replicating changes for a multi-level List Partition table. This issue is fixed. | -| Bug Fix | Fixed the error where Snapshot fails for the third database in a MMR cluster. | -| Bug Fix | Fixed an error that prevented creation of a row-level Filter based on the `->` operator for JSONB data type. | -| Bug Fix | Fixed the issue related with the reporting of incorrect missing privileges while registering Oracle Publication database. | -| Bug Fix | In a hybrid cluster, batch is always applied using BUS (batch update using simple Statement) mode even when the user has opted for BUP mode (batch update using PreparedStatement). This issue is now fixed. | -| Bug Fix | Fixed an issue where an INSERT conflict in MMR Publication is subject to failure of Synchronize operation for a target SMR Subscription in a hybrid cluster. [Support Ticket #75608]| -| Bug Fix | Fixed an issue so that a validation error is reported when the CLI command `createpub` is executed without registering a Publication database. | -| Bug Fix | Fixed the NoClassDefFoundError error (org/postgresql/replication/LogSequenceNumber) observed during data Snapshot operation for a RPM based installation on RHEL8/CENTOS8. | -| Bug Fix | Fixed the error `libpq JNI wrapper library is not available` that occured while adding a database for WAL based replication. +| From 83e02fdf0909e9b9f2f01f52d943d1a7e03d8fdc Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 14:04:13 +0000 Subject: [PATCH 20/53] restructure --- .../index.mdx | 0 .../create_cluster_cli.mdx | 3 ++ .../create_cluster_portal.mdx | 0 .../index.mdx | 0 .../index.mdx | 0 .../backup_and_restore.mdx | 0 .../import_data.mdx | 0 .../{04_experiment => experiment}/index.mdx | 0 .../biganimal/release/free_trial/index.mdx | 13 +++++++++ .../release/free_trial/quickstart_on_aws.mdx | 28 +++++++++++++++++++ .../free_trial/quickstart_on_azure.mdx | 27 ++++++++++++++++++ 11 files changed, 71 insertions(+) rename product_docs/docs/biganimal/release/free_trial/{03_connect => connect_to_a_cluster}/index.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{02_creating_a_cluster => create_a_cluster}/create_cluster_cli.mdx (97%) rename product_docs/docs/biganimal/release/free_trial/{02_creating_a_cluster => create_a_cluster}/create_cluster_portal.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{02_creating_a_cluster => create_a_cluster}/index.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{01_create_account => create_an_account}/index.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{04_experiment => experiment}/backup_and_restore.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{04_experiment => experiment}/import_data.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{04_experiment => experiment}/index.mdx (100%) create mode 100644 product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx create mode 100644 product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/03_connect/index.mdx rename to product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx similarity index 97% rename from product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx rename to product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx index 59aac8253a8..bdfd1643868 100644 --- a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx @@ -76,3 +76,6 @@ Once the cluster is created, log in via psql. Use the password from the config f ```shell psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require' ``` +## Further reading + +[BigAniaml CLI reference](/biganimal/latest/reference/cli/) diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/create_cluster_portal.mdx rename to product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/02_creating_a_cluster/index.mdx rename to product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/01_create_account/index.mdx rename to product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/experiment/backup_and_restore.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/04_experiment/backup_and_restore.mdx rename to product_docs/docs/biganimal/release/free_trial/experiment/backup_and_restore.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/experiment/import_data.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/04_experiment/import_data.mdx rename to product_docs/docs/biganimal/release/free_trial/experiment/import_data.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/04_experiment/index.mdx rename to product_docs/docs/biganimal/release/free_trial/experiment/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 0f0add8a235..9d1db5c7c02 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -2,11 +2,24 @@ title: "Getting started with the BigAnimal Free Trial" navTitle: "Getting started with a free trial" indexCards: none +navigation: + - quickstart_on_aws + - quickstart_on_azure + - create_an_account + - create_a_cluster + - connect_to_a_cluster + - experiment --- The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. +!!! Note "Get started with BigAnimal quickly" + - [Trial PostgreSQL cluster running on AWS](quickstart_on_aws) - create, connect to and work with + a standard community PostgreSQL cluster, provisioned on AWS + - [Trial EDB Postgres Advanced Server cluster running on Azure](quickstart_on_azure) - create, connect to + and work with an Oracle database compatible Postgres cluster, provisioned on Azure + ## What you get as part of the free trial - **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases**. diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx new file mode 100644 index 00000000000..e49db789030 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx @@ -0,0 +1,28 @@ +--- +title: "Quickstart for the BigAnimal free trial on AWS" +navTitle: "Quickstart AWS" +tags: + - azure + - biganimal + - postgresql + - psql +--- + +## Step 1: create an account and sign into the portal + + (link to portal) + +## Step 2: create an AWS cluster + +### Provisioning, active clusters and deletion + +## Step 3: Connecting to your new cluster + +## Step 4: Create a database + +## Step 5: Populate data + +## Step 6: Query + +## Further reading + diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx new file mode 100644 index 00000000000..6b57011c086 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx @@ -0,0 +1,27 @@ +--- +title: "Quickstart for the BigAnimal free trial on Azure" +navTitle: "Quickstart Azure" +tags: + - azure + - biganimal + - postgresql + - psql +--- + +## Step 1: create an account and sign into the portal + + (link to portal) + +## Step 2: create an AWS cluster + +### Provisioning, active clusters and deletion + +## Step 3: Connecting to your new cluster + +## Step 4: Create a database + +## Step 5: Populate data + +## Step 6: Query + +## Further reading From 48a708e4e053eef1e177f189ce9d45a70a1a6b81 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 18:15:52 +0000 Subject: [PATCH 21/53] Quickstart content for AWS and Azure --- .../connect_using_dbeaver.mdx | 32 ++++ .../connect_using_pgadmin.mdx | 56 +++++++ .../connect_using_psql.mdx | 29 ++++ .../free_trial/connect_to_a_cluster/index.mdx | 88 +---------- .../create_a_cluster/create_cluster_cli.mdx | 4 + .../create_cluster_portal.mdx | 52 ++++++- .../free_trial/create_a_cluster/index.mdx | 6 +- .../free_trial/create_an_account/index.mdx | 20 ++- .../release/free_trial/experiment/index.mdx | 3 +- .../biganimal/release/free_trial/index.mdx | 19 ++- .../release/free_trial/quickstart_on_aws.mdx | 145 ++++++++++++++++- .../free_trial/quickstart_on_azure.mdx | 63 +++++++- .../free_trial/quickstart_trial_biganimal.mdx | 147 ------------------ 13 files changed, 400 insertions(+), 264 deletions(-) create mode 100644 product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx create mode 100644 product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx create mode 100644 product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx delete mode 100644 product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx new file mode 100644 index 00000000000..867f0e9e026 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -0,0 +1,32 @@ +--- +title: "Connect to your cluster using DBeaver" +navTitle: DBeaver +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + +1. Launch [DBeaver](https://dbeaver.io/) +2. Click the "New Database Connection" button on the toolbar to open the "Connect to a database" dialog +3. Select PostgreSQL and click "Next" + + You may be prompted to download the PostgreSQL JDBC driver +4. On the "Main" tab, + + - Enter your cluster's hostname in the "Host:" field + - Enter "edb_admin" in the "Database:" field + - Enter "edb_admin" in the "Username:" field + - Enter your cluster's password in the "Password:" field + +5. On the "SSL" tab, + + - Check the "Use SSL" checkbox + - Select "require" for the "SSL mode:" field + +6. On the "PostgreSQL" tab + + - Check the "Show all databases" checkbox + +7. Click the "Test connection ..." button and verify that DBeaver is able to connect to your cluster +8. Click "Finish" to save the connection diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx new file mode 100644 index 00000000000..d746f29dadb --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -0,0 +1,56 @@ +--- +title: "Connect to your cluster using DBeaver" +navTitle: DBeaver +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + + +[The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage and query your cluster's databases from a desktop or web UI. + +A quick way to try out pgAdmin is to run it in a Docker container. With Docker installed, run: + +```shell +docker run -p 8000:80 \ + -e 'PGADMIN_DEFAULT_EMAIL=user@example.com' \ + -e 'PGADMIN_DEFAULT_PASSWORD=password' \ + -d dpage/pgadmin4 +__OUTPUT__ +Unable to find image 'dpage/pgadmin4:latest' locally +latest: Pulling from dpage/pgadmin4 +59bf1c3509f3: Already exists +34e720c4612b: Pull complete +8ef193cd122b: Pull complete +4377f1371242: Pull complete +9205bee41667: Pull complete +d5e36d286558: Pull complete +9c91d0528419: Pull complete +86e0602b566c: Pull complete +cf0d28491ace: Pull complete +198776d7d0ce: Pull complete +f7909c1938d8: Pull complete +9d477f4ed5d3: Pull complete +51c0f4ca201e: Pull complete +bc906010b44f: Pull complete +Digest: sha256:18cc2c7cce64b3f95b1ff13ec835da88c25b30d3745a02774abcd166379dae60 +Status: Downloaded newer image for dpage/pgadmin4:latest +99f4775629b1086b95601d659eae9dfe7125c4694a1a90891f840d12f8ca0261 +``` + +Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ then entering the email and password specified on the command line. + +From the welcome page, select Add New Server. You'll be prompted to configure the connection: + +Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then click "Connection" + +1. Enter your cluster's hostname in the Host name/address field, +2. `edb_admin` in the Maintenance database field (this is the default database that'll be connected to by pgAdmin), +3. `edb_admin` in the Username field, +4. and the password you provided when configuring your cluster in the Password field (you may want to save this for convenience while testing). + +Click SSL and change SSL mode to "Require". + +Finally, click the "Save" button. pgAdmin will try to establish a connection to your database, and when successful will display the dashboard +along with the list of available databases on the left. diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx new file mode 100644 index 00000000000..14124940bd7 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx @@ -0,0 +1,29 @@ +--- +title: "Connect to your cluster using DBeaver" +navTitle: DBeaver +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + + +[psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) +and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, there are quite a few commands for +inspecting and managing the database built in that make light work of even complex tasks. + +You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. e.g. + +```shell +psql -W "postgres://edb_admin@p-h67q2yc7hq.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require" +``` + +The URI is all that's necessary for psql; while you *can* pass each element of that URL individually +(pulling the information from the Connect tab on the portal for instance), psql will happily parse it out for you (and prompt for the password). + +In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). + + +!!! EDB Postgres Advanced Server enhancements + If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as +tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client will work with Advanced Server as well. diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx index 75f6b5fad34..fef0db87458 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx @@ -1,93 +1,13 @@ --- title: "Connect to your cluster" -indexCards: none +indexCards: simple --- So, you've created a cluster... Now what? You probably want to connect to it! -BigAnimal clusters are Real Actual Postgres Databases, so you can connect to them just as you would any other Postgres database. Here are a few examples: +BigAnimal clusters are Real Actual Postgres Databases, so you can connect to them just as you would any other Postgres database. -## Connect using psql +All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. -[psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) -and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, there are quite a few commands for -inspecting and managing the database built in that make light work of even complex tasks. - -You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. e.g. - -```shell -psql -W "postgres://edb_admin@p-xj6qj8i1hx.qsbilba3hlgp1vqr.biganimal.io:5432/edb_admin?sslmode=require" -``` - -The URI is all that's necessary for psql; while you *can* pass each element of that URL individually -(pulling the information from the Connect tab on the portal for instance), psql will happily parse it out for you (and prompt for the password). - -In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). - - -!!! EDB Postgres Advanced Server enhancements - If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as -tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client will work with Advanced Server as well. - -## Connect using pgAdmin - -Prefer using a GUI to work with your cluster? [The pgAdmin project](https://www.pgadmin.org/download/) provides just that: inspect, monitor, manage and query your cluster's databases from a desktop or web UI. - -A quick way to try out pgAdmin is to run it in a Docker container. With Docker installed, run: - -```shell -docker run -p 8000:80 \ - -e 'PGADMIN_DEFAULT_EMAIL=user@example.com' \ - -e 'PGADMIN_DEFAULT_PASSWORD=password' \ - -d dpage/pgadmin4 -__OUTPUT__ -Unable to find image 'dpage/pgadmin4:latest' locally -latest: Pulling from dpage/pgadmin4 -59bf1c3509f3: Already exists -34e720c4612b: Pull complete -8ef193cd122b: Pull complete -4377f1371242: Pull complete -9205bee41667: Pull complete -d5e36d286558: Pull complete -9c91d0528419: Pull complete -86e0602b566c: Pull complete -cf0d28491ace: Pull complete -198776d7d0ce: Pull complete -f7909c1938d8: Pull complete -9d477f4ed5d3: Pull complete -51c0f4ca201e: Pull complete -bc906010b44f: Pull complete -Digest: sha256:18cc2c7cce64b3f95b1ff13ec835da88c25b30d3745a02774abcd166379dae60 -Status: Downloaded newer image for dpage/pgadmin4:latest -99f4775629b1086b95601d659eae9dfe7125c4694a1a90891f840d12f8ca0261 -``` - -Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ then entering the email and password specified on the command line. - -[screenshot] - -From the welcome page, select Add New Server. You'll be prompted to configure the connection: - -[screenshot] - -Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then click "Connection" - -[screenshot] - -1. Enter your cluster's hostname in the Host name/address field, -2. `edb_admin` in the Maintenance database field (this is the default database that'll be connected to by pgAdmin), -3. `edb_admin` in the Username field, -4. and the password you provided when configuring your cluster in the Password field (you may want to save this for convenience while testing). - -Click SSL and change SSL mode to "Require". - -Finally, click the "Save" button. pgAdmin will try to establish a connection to your database, and when successful will display the dashboard -along with the list of available databases on the left. - - -## Connect using VSCode - -// TODO: pick one of the dozens of extensions for this - -## Connect using DBeaver +This section provides a few examples of connecting from common clients. diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx index bdfd1643868..2f305a0d380 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx @@ -76,6 +76,10 @@ Once the cluster is created, log in via psql. Use the password from the config f ```shell psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require' ``` + +!!! Note "Other options for connecting" + Sure, psql is great - but maybe you want to use another client. See [Connect to your cluster](../connect_to_a_cluster) for other options. + ## Further reading [BigAniaml CLI reference](/biganimal/latest/reference/cli/) diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx index 695b8d79073..137e4aa1c90 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx @@ -4,4 +4,54 @@ navTitle: "Using the portal" indexCards: none --- -Use the [Create a cluster on the CLI](create_cluster_cli) as a script for creating a cluster using the portal. Probably a video. \ No newline at end of file +## Navigating to the Create Cluster page + +1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/) (sign in with [your account](../create_account) if need-be) + +2. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page + +3. Click the Create New Cluster button + +You should now find yourself at + +## Configuring a new cluster + +### The Cluster Settings tab + +In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. + +1. Use **Cluster Name** to describe the purpose of the cluster, e.g. "Test for Advanced Server on AWS" +2. **Password** is the admin password for the cluster - so pick a strong one! Note that this is independent of your EDB account. +3. **Database Type** is one of, + + - - *EnterpriseDB PostgreSQL Advanced Server* for Oracle database compatibility + - - *PostgreSQL* for official community builds of standard PostgreSQL + + So if you're interested in EDB's enhancements to PostgreSQL for Oracle database compatibility, choose Advanced Server; otherwise, choose PostgreSQL. +4. **Postgres Version** allows you to select from among the supported versions for either database type +4. **Provider** is either AWS or Azure; BigAnimal works the same on either one, so choose the one you're familiar with. +5. **Region** options will depend on which Provider you chose; pick the one closest to you. + +For **Instance Type** and **Storage**, only one option is available for each field during the trial - so just choose that. + +### The DB Configuration tab + +This is entirely optional, but if you're curious you can find a full set of PostgreSQL configuration options on this tab, allowing you to tune a cluster for specific needs or resource constraints. + +### The Availability tab + +This page configures high availability - but that feature is not available in the trial. Skip this tab unless you're curious. + +## Provisioning + +Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. + +Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. + +Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. + +Click on the provisioned cluster to view the parameters you'll need to connect to it. + +## Next steps + +Now you have a cluster, you can [connect](../connect_to_a_cluster) to it. diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx index 6f28a404e20..5ec996e8584 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx @@ -3,7 +3,7 @@ title: "Create a cluster" indexCards: none --- -The BigAnimal Free Trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](/biganimal/latest/free_trial/04_experiment/backup_and_restore/). Backups are automaticly created by default. +The BigAnimal Free Trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](../experiment/backup_and_restore/). Backups are automatically created as soon as a cluster is used. When you create a cluster, there are two flavors of PostgreSQL to choice from: @@ -12,7 +12,7 @@ When you create a cluster, there are two flavors of PostgreSQL to choice from: We'll demonstate two methods of creating a cluster: -* [Using the portal](#) +* [Using the portal](create_cluster_portal) * [Using the command line](create_cluster_cli) -Clusters may also be created pragmatically using the [fully-featured BigAnimal API](/biganimal/latest/reference/api/). +Clusters may also be created programatically using the [fully-featured BigAnimal API](/biganimal/latest/reference/api/). diff --git a/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx index b78fdc243f5..293c61f7c61 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx @@ -1,15 +1,19 @@ --- -title: "Create an account for your free trial" +title: "Create an EDB account for your free trial" navTitle: "Create an account" --- -_Maybe a video here?_ +Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Accounts are free, and registration takes less than a minute. -_Detail what information you'll need to provide._ +1. Navigate to +2. Click the "Try it for free" button +3. Fill in the form, and agree to the terms and conditions +4. Click Submit +5. Check your email - you should recieve an email from EDB containing an activation link +6. Click the activation link and enter a password for your EDB account -_Maybe a direct link...?_ https://www.enterprisedb.com/accounts/register/biganimal +You'll then be redirected to the BigAnimal portal. -You can request a BigAnimal free trial from several locations: -- The EDB [Get started](https://www.enterprisedb.com/get-started) sign-up page -- The [BigAnimal home page](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) -- The EDB login page +!!! Note "Already have an EDB account?" + If you've already signed up for an EDB account, you can navigate to to log in using it. diff --git a/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx index fb7db77744c..d12ae99acf5 100644 --- a/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx @@ -4,7 +4,8 @@ navTitle: "Experimenting" indexCards: none --- -Once you have [created a cluster](/biganimal/latest/free_trial/02_creating_a_cluster/), it's time to put it through its paces. +Once you have [created a cluster](../create_a_cluster/), it's time to put it through its paces. +Here are a few examples to get you started: * [Import data](import_data) * [Backup and restore](backup_and_restore) diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 9d1db5c7c02..d17b9bb4d38 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -41,7 +41,7 @@ Get started with your trial by signing up for a free EDB account. ## Create an account -If you haven't done so already, you'll need to [create your EDB account](01_create_account). Once you've done that, you can [sign up for the trial](#). +If you haven't done so already, you'll need to [create your EDB account](create_an_account). Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. @@ -54,26 +54,25 @@ BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced S There are several equivalent ways to create a cluster... -- [...Using the portal](#) -- [...Using the CLI](02_creating_a_cluster/create_cluster_cli) -- [...Using the API](#) +- [...Using the portal](create_a_cluster/create_cluster_portal) +- [...Using the CLI](create_a_cluster/create_cluster_cli) ## Connect Once you have a running cluster, you can connect using any PostgreSQL compatible software - here are a few ideas to get you going: -- [Using psql](03_connect/#connect-using-psql) -- [Using pgAdmin](03_connect/#connect-using-pgadmin) -- [Using VSCode](03_connect/#connect-using-vscode) +- [Using psql](connect_to_a_cluster/connect_using_psql) +- [Using pgAdmin](connect_to_a_cluster/connect_using_pgadmin) +- [Using DBeaver](connect_to_a_cluster/connect_using_dbeaver) ## Experiment A database is always more interesting when it contains... Data! Load up some sample data and see what BigAnimal lets you do with it: -- [Testing backups by restoring a cluster](04_experiment/backup_and_restore) -- [Full PostgreSQL](#) -- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](#) +- [Importing some sample data](experiment/import_data) +- [Testing backups by restoring a cluster](experiment/backup_and_restore) +- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](../using_cluster/06_demonstration_oracle_compatibility) ## What you can’t do Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx index e49db789030..1844146e1a1 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx @@ -10,19 +10,156 @@ tags: ## Step 1: create an account and sign into the portal - (link to portal) +If you haven't done so already, you'll need to [create your EDB account](create_an_account). + +Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). ## Step 2: create an AWS cluster +1. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page + +2. Click the Create New Cluster button + + You should now find yourself at + +3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field +4. Enter a strong, memorable password in the **Password** field + This is the admin password for the cluster. +5. Choose "PostgreSQL" for **Database Type** + This gives you an official build of PostgreSQL +6. Choose "14" for **Postgres Version** +4. Select AWS for **Provider** +5. Select "US East 1" for **Region** +6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. +7. Click "Create Cluster" + ### Provisioning, active clusters and deletion +Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. + +Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. + +Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. + ## Step 3: Connecting to your new cluster -## Step 4: Create a database -## Step 5: Populate data +1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. +2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. + + ``` + $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" + Password: + psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) + WARNING: psql major version 13, server major version 14. + Some psql features might not work. + SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) + Type "help" for help. + + edb_admin=> + ``` + +!!! Note + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. + + +## Step 4: Create a new database (optional) + +We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. + +1. Create a new role called `math`. + + ``` + create user math with password 'math_password'; + ``` -## Step 6: Query +2. Grant the `math` role to `edb_admin`. + + ``` + grant math to edb_admin; + ``` + +3. Create a new `math` database. + + ``` + create database math with owner math; + ``` + +4. Connect to the `math` database. + + ``` + create database math with owner math; + ``` + +## Step 5: Populate data & query it + + +We're going to use temporary tables to calculate prime numbers using a Sieve of Eratosthenes. + +1. Create a table for storing prime numbers called `primes`. + + ```sql + CREATE TABLE primes ( + num INTEGER, + PRIMARY KEY (num) + ); + ``` + +2. Populate the table with all prime numbers up to 1000. (This code is based on [code from David Fetter](https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes).) + + ```sql + -- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes + + WITH RECURSIVE + t0(m) AS ( + VALUES(1000) + ), + t1(n) AS ( + VALUES(2) + UNION ALL + SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) + ), + t2 (n, i) AS ( + SELECT 2*n, 2 + FROM t1 WHERE 2*n <= (SELECT m FROM t0) + UNION ALL + ( + WITH t3(k) AS ( + SELECT max(i) OVER () + 1 FROM t2 + ), + t4(k) AS ( + SELECT DISTINCT k FROM t3 + ) + SELECT k*n, k + FROM + t1 + CROSS JOIN + t4 + WHERE k*k <= (SELECT m FROM t0) + ) + ) + INSERT INTO primes ( + SELECT n FROM t1 EXCEPT + SELECT n FROM t2 + ORDER BY 1 + ); + ``` + +3. Select the largest prime number less than 1000. + + ``` + SELECT max(num) + FROM primes + WHERE num < 1000; + ``` + +You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. ## Further reading +Now that you've got the basics out of the way, see what else BigAnimal offers: + +- [Backup and restore](experiment/backup_and_restore) +- [Import data](experiment/import_data) +- [CLI reference](../reference/cli) +- [API reference](../reference/api) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx index 6b57011c086..b600bce19ba 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx @@ -4,24 +4,75 @@ navTitle: "Quickstart Azure" tags: - azure - biganimal - - postgresql + - epas - psql --- + ## Step 1: create an account and sign into the portal - (link to portal) +If you haven't done so already, you'll need to [create your EDB account](create_an_account). + +Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). + +## Step 2: create an Azure cluster + +1. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page -## Step 2: create an AWS cluster +2. Click the Create New Cluster button + + You should now find yourself at + +3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field +4. Enter a strong, memorable password in the **Password** field + This is the admin password for the cluster. +5. Choose "EnterpriseDB Postgres Advanced Server (EPAS)" for **Database Type** + This gives you EDB's Oracle database compatible version of Postgres +6. Choose "14" for **Postgres Version** +4. Select Azure for **Provider** +5. Select "(US) East US 2" for **Region** +6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. +7. Click "Create Cluster" ### Provisioning, active clusters and deletion +Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. + +Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. + +Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. + ## Step 3: Connecting to your new cluster -## Step 4: Create a database +1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. +2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. + + ``` + $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" + Password: + psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) + WARNING: psql major version 13, server major version 14. + Some psql features might not work. + SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) + Type "help" for help. + + edb_admin=> + ``` + +!!! Note + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. -## Step 5: Populate data +## Step 4: Import a database and try some Oracle-syntax queries -## Step 6: Query +You can find a full walkthrough in the [Oracle SQL compatibility demo](../using_cluster/06_demonstration_oracle_compatibility#try-it-on-your-own-cluster-export-and-import). + +You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. ## Further reading + +Now that you've got the basics out of the way, see what else BigAnimal offers: + +- [Backup and restore](experiment/backup_and_restore) +- [Import data](experiment/import_data) +- [CLI reference](../reference/cli) +- [API reference](../reference/api) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx deleted file mode 100644 index cb8f97f53f9..00000000000 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_trial_biganimal.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "Quickstart with the BigAnimal Free Trial" -navTitle: "Quickstart" -indexCards: none ---- - -This page shows you how to create a PostgreSQL or EDB Postgres Advanced Server cluster using BigAnimal (free for 14 days), connect to the cluster, populate sample data, and run some queries. - -## Step 1. Create a free trial cluster - -We will create an [EDB Postgres Advanced Server](/docs/epas/latest/) (EPAS) cluster based on the latest PostgreSQL release. It will be hosted on AWS. - -1. If you haven't done so already, [create your EDB account](https://62312143bb9e32503f5ac560--edb-docs-staging.netlify.app/docs/biganimal/latest/free_trial/01_create_account/). - -2. Sign up for a free trial of BigAnimal. - -3. Navigate to the [Create Cluster](https://portal.biganimal.com/create-cluster) page. - -4. Enter a name for your cluster in the **Cluster Name** field. ( - -5. Pick a secure **Password** for your cluster. - -6. Select `EnterpriseDB PostgreSQL Advanced Server (EPAS)` as your **Database Type**. - -7. For **Postgres Version**, use `14` for the most advanced features. - -8. Select `AWS` for the **Provider**. - -9. Pick the **Region** nearest you. - -10. Under **Instance Series** pick `AWS EC2 R5 Instances`. - -11. Use `r5.large, 2vCPU, 16GB RAM` for the **Size**. - -12. Leave all other options on their default. - -13. Push the **Create Cluster** button to create your cluster. - -It takes about 5 minutes for the cluster to be spun up. While you are waiting, watch [a video about setting up a connection]. - -## Step 2. Connect to your cluster - -1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. -2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. - - ``` - $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" - Password: - psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) - WARNING: psql major version 13, server major version 14. - Some psql features might not work. - SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) - Type "help" for help. - - edb_admin=> - ``` - -## Step 3. Create a new database (optional) - -We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. - -1. Create a new role called `math`. - - ``` - create user math with password 'math_password'; - ``` - -2. Grant the `math` role to `edb_admin`. - - ``` - grant math to edb_admin; - ``` - -3. Create a new `math` database. - - ``` - create database math with owner math; - ``` - -4. Connect to the `math` database. - - ``` - create database math with owner math; - ``` - -## Step 4. Populate sample data - -We're going to use temporary tables to calculate prime numbers using a Sieve of Eratosthenes. - -1. Create a table for storing prime numbers called `primes`. - - ```sql - CREATE TABLE primes ( - num INTEGER, - PRIMARY KEY (num) - ); - ``` - -2. Populate the table with all prime numbers up to 1000. (This code is based on [code from David Fetter](https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes).) - - ```sql - -- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes - - WITH RECURSIVE - t0(m) AS ( - VALUES(1000) - ), - t1(n) AS ( - VALUES(2) - UNION ALL - SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) - ), - t2 (n, i) AS ( - SELECT 2*n, 2 - FROM t1 WHERE 2*n <= (SELECT m FROM t0) - UNION ALL - ( - WITH t3(k) AS ( - SELECT max(i) OVER () + 1 FROM t2 - ), - t4(k) AS ( - SELECT DISTINCT k FROM t3 - ) - SELECT k*n, k - FROM - t1 - CROSS JOIN - t4 - WHERE k*k <= (SELECT m FROM t0) - ) - ) - INSERT INTO primes ( - SELECT n FROM t1 EXCEPT - SELECT n FROM t2 - ORDER BY 1 - ); - ``` - -3. Select the largest prime number less than 1000. - - ``` - SELECT max(num) - FROM primes - WHERE num < 1000; - ``` - -You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. From ffb708a30386c55bb0e5c0c580ed7e0d24daae0e Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 19:02:36 +0000 Subject: [PATCH 22/53] fix errant titles, annotations, odd eprs stowaway --- .../connect_using_pgadmin.mdx | 4 ++-- .../connect_using_psql.mdx | 4 ++-- .../release/free_trial/quickstart_on_aws.mdx | 2 +- .../free_trial/quickstart_on_azure.mdx | 2 +- .../13_eprs_rel_notes_6.2.16.mdx | 22 +++++++++++++++++-- 5 files changed, 26 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx index d746f29dadb..90288a3fa24 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -1,6 +1,6 @@ --- -title: "Connect to your cluster using DBeaver" -navTitle: DBeaver +title: "Connect to your cluster using pgAdmin" +navTitle: pgAdmin indexCards: none --- diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx index 14124940bd7..873fafd3d92 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx @@ -1,6 +1,6 @@ --- -title: "Connect to your cluster using DBeaver" -navTitle: DBeaver +title: "Connect to your cluster using psql" +navTitle: psql indexCards: none --- diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx index 1844146e1a1..0f3b9ca8bbc 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx @@ -60,7 +60,7 @@ Once your first cluster is fully provisioned, your 14 day free trial officially ``` !!! Note - While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. ## Step 4: Create a new database (optional) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx index b600bce19ba..cdf5b94f1d9 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx @@ -60,7 +60,7 @@ Once your first cluster is fully provisioned, your 14 day free trial officially ``` !!! Note - While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. ## Step 4: Import a database and try some Oracle-syntax queries diff --git a/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx b/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx index d956a2f6319..33eb911ca65 100644 --- a/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx +++ b/product_docs/docs/eprs/6.2/eprs_rel_notes/13_eprs_rel_notes_6.2.16.mdx @@ -1,5 +1,5 @@ --- -title: "Version 6.2.17" +title: "Version 6.2.16" --- @@ -7,5 +7,23 @@ New features, enhancements, bug fixes, and other changes in EDB Postgres Replica | Type | Description | | ----------- |------------ | -| +| Enhancement | Replication Server is certified to support PostgreSQL v14 and EDB Postgres Advanced Server v14. | +| Enhancement | Performance optimization for Synchronize operation when a MMR Publication has a SMR Subscription. [Support Ticket #74217] | +| Bug Fix | The `removepub` CLI command removes a Publication while it has one or more Subscriptions. This issue is fixed. [Support Ticket #72194] | +| Bug Fix | Fixed an issue where replication fails for the `UUID` data type in EDB Postgres Advanced Server to MS SQL Server permutation. [Support Ticket #73835] | +| Bug Fix | Fixed an issue where the Synchronize operation failed to replicate NULL for a BLOB type for EDB Postgres Advanced Server to Oracle. [Support Ticket #74057] | +| Bug Fix | Fixed case where wrong schema qualifier was picked up during history cleanup for EDB Postgres Advanced Server to Oracle and SQL Server permutations. [Support Ticket #72626] | +| Bug Fix | Fixed loading of Replication History on Replication Console after restart of Publication Services when SMR subscription is associated with a MMR Publication. [Support Ticket #74217] | +| Bug Fix | Fixed the upgrade issue related with the enhancement of shadow table triggers. [Support Ticket #74447] | +| Bug Fix | Fixed an issue where redundant INSERT conflicts were recorded when a new table was added in the MMR Publication. | +| Bug Fix | In a hybrid replication cluster, the cleanup shadow table routine is subject to remove unprocessed changes. This issue is fixed. | +| Bug Fix | The Synchronize replication fails while replicating changes for a multi-level List Partition table. This issue is fixed. | +| Bug Fix | Fixed the error where Snapshot fails for the third database in a MMR cluster. | +| Bug Fix | Fixed an error that prevented creation of a row-level Filter based on the `->` operator for JSONB data type. | +| Bug Fix | Fixed the issue related with the reporting of incorrect missing privileges while registering Oracle Publication database. | +| Bug Fix | In a hybrid cluster, batch is always applied using BUS (batch update using simple Statement) mode even when the user has opted for BUP mode (batch update using PreparedStatement). This issue is now fixed. | +| Bug Fix | Fixed an issue where an INSERT conflict in MMR Publication is subject to failure of Synchronize operation for a target SMR Subscription in a hybrid cluster. [Support Ticket #75608]| +| Bug Fix | Fixed an issue so that a validation error is reported when the CLI command `createpub` is executed without registering a Publication database. | +| Bug Fix | Fixed the NoClassDefFoundError error (org/postgresql/replication/LogSequenceNumber) observed during data Snapshot operation for a RPM based installation on RHEL8/CENTOS8. | +| Bug Fix | Fixed the error `libpq JNI wrapper library is not available` that occured while adding a database for WAL based replication. From 133a555a8e63dda134dd1844d9e20b7da8367101 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 19:08:58 +0000 Subject: [PATCH 23/53] Intros for quickstarts, order for connect options, shorter root nav title --- .../release/free_trial/connect_to_a_cluster/index.mdx | 4 ++++ product_docs/docs/biganimal/release/free_trial/index.mdx | 2 +- .../docs/biganimal/release/free_trial/quickstart_on_aws.mdx | 2 ++ .../docs/biganimal/release/free_trial/quickstart_on_azure.mdx | 1 + 4 files changed, 8 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx index fef0db87458..21683a85127 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx @@ -1,6 +1,10 @@ --- title: "Connect to your cluster" indexCards: simple +navigation: + - connect_using_psql + - connect_using_pgadmin + - connect_using_dbeaver --- So, you've created a cluster... Now what? You probably want to connect to it! diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index d17b9bb4d38..5b95c8e3d51 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -1,6 +1,6 @@ --- title: "Getting started with the BigAnimal Free Trial" -navTitle: "Getting started with a free trial" +navTitle: "Getting started" indexCards: none navigation: - quickstart_on_aws diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx index 0f3b9ca8bbc..50c0a01f971 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx @@ -8,6 +8,8 @@ tags: - psql --- +This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL cluster on BigAnimal running against Azure with a free trial account. + ## Step 1: create an account and sign into the portal If you haven't done so already, you'll need to [create your EDB account](create_an_account). diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx index cdf5b94f1d9..4eb1b0974ad 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx @@ -8,6 +8,7 @@ tags: - psql --- +This topic provides a quick walkthrough of the steps needed to configure an EnterpriseDB Postgres Advanced Server cluster on BigAnimal running against Azure with a free trial account. ## Step 1: create an account and sign into the portal From 4b102b9b6f9c6273da8cf919f21d8d9e83909301 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Tue, 29 Mar 2022 14:00:39 -0700 Subject: [PATCH 24/53] Make steps > 3 optional with one AWS quickstart --- .../biganimal/release/free_trial/index.mdx | 7 +- .../{quickstart_on_aws.mdx => quickstart.mdx} | 27 ++++--- .../free_trial/quickstart_on_azure.mdx | 79 ------------------- 3 files changed, 16 insertions(+), 97 deletions(-) rename product_docs/docs/biganimal/release/free_trial/{quickstart_on_aws.mdx => quickstart.mdx} (83%) delete mode 100644 product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 5b95c8e3d51..eba28f0cca5 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -3,8 +3,7 @@ title: "Getting started with the BigAnimal Free Trial" navTitle: "Getting started" indexCards: none navigation: - - quickstart_on_aws - - quickstart_on_azure + - quickstart - create_an_account - create_a_cluster - connect_to_a_cluster @@ -15,10 +14,8 @@ The BigAnimal Free Trial provides an EDB-hosted environment where you can quickl The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. !!! Note "Get started with BigAnimal quickly" - - [Trial PostgreSQL cluster running on AWS](quickstart_on_aws) - create, connect to and work with + - [Trial PostgreSQL cluster running on AWS](quickstart) - create, connect to and work with a standard community PostgreSQL cluster, provisioned on AWS - - [Trial EDB Postgres Advanced Server cluster running on Azure](quickstart_on_azure) - create, connect to - and work with an Oracle database compatible Postgres cluster, provisioned on Azure ## What you get as part of the free trial diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx similarity index 83% rename from product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx rename to product_docs/docs/biganimal/release/free_trial/quickstart.mdx index 50c0a01f971..ae721bf4806 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_aws.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -1,6 +1,6 @@ --- title: "Quickstart for the BigAnimal free trial on AWS" -navTitle: "Quickstart AWS" +navTitle: "Quickstart" tags: - azure - biganimal @@ -8,7 +8,7 @@ tags: - psql --- -This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL cluster on BigAnimal running against Azure with a free trial account. +This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL cluster on BigAnimal running against AWS with a free trial account. ## Step 1: create an account and sign into the portal @@ -18,9 +18,9 @@ Then, use your account to access the [BigAnimal portal](https://portal.biganimal ## Step 2: create an AWS cluster -1. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page +1. Select the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page -2. Click the Create New Cluster button +2. Select the Create New Cluster button You should now find yourself at @@ -33,11 +33,11 @@ Then, use your account to access the [BigAnimal portal](https://portal.biganimal 4. Select AWS for **Provider** 5. Select "US East 1" for **Region** 6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. -7. Click "Create Cluster" +7. Select "Create Cluster" ### Provisioning, active clusters and deletion -Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. +Select create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. @@ -45,8 +45,7 @@ Once your first cluster is fully provisioned, your 14 day free trial officially ## Step 3: Connecting to your new cluster - -1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. +1. Select your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. 2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. ``` @@ -65,7 +64,9 @@ Once your first cluster is fully provisioned, your 14 day free trial officially While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. -## Step 4: Create a new database (optional) +## Things to try + +### Create a new database We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. @@ -87,16 +88,16 @@ We're going to create some sample math data, so we're going to create a database create database math with owner math; ``` -4. Connect to the `math` database. +4. Connect to the `math` database. You will be prompted for the `edb_admin` password you provided in Step 2 above. ``` - create database math with owner math; + \connect math ``` -## Step 5: Populate data & query it +### Populate a table and query it -We're going to use temporary tables to calculate prime numbers using a Sieve of Eratosthenes. +We're going to use temporary tables to calculate prime numbers using a [Sieve of Eratosthenes](https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes). 1. Create a table for storing prime numbers called `primes`. diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx deleted file mode 100644 index 4eb1b0974ad..00000000000 --- a/product_docs/docs/biganimal/release/free_trial/quickstart_on_azure.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Quickstart for the BigAnimal free trial on Azure" -navTitle: "Quickstart Azure" -tags: - - azure - - biganimal - - epas - - psql ---- - -This topic provides a quick walkthrough of the steps needed to configure an EnterpriseDB Postgres Advanced Server cluster on BigAnimal running against Azure with a free trial account. - -## Step 1: create an account and sign into the portal - -If you haven't done so already, you'll need to [create your EDB account](create_an_account). - -Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). - -## Step 2: create an Azure cluster - -1. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page - -2. Click the Create New Cluster button - - You should now find yourself at - -3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field -4. Enter a strong, memorable password in the **Password** field - This is the admin password for the cluster. -5. Choose "EnterpriseDB Postgres Advanced Server (EPAS)" for **Database Type** - This gives you EDB's Oracle database compatible version of Postgres -6. Choose "14" for **Postgres Version** -4. Select Azure for **Provider** -5. Select "(US) East US 2" for **Region** -6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. -7. Click "Create Cluster" - -### Provisioning, active clusters and deletion - -Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. - -Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. - -Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. - -## Step 3: Connecting to your new cluster - -1. Click on your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. -2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. - - ``` - $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" - Password: - psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) - WARNING: psql major version 13, server major version 14. - Some psql features might not work. - SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) - Type "help" for help. - - edb_admin=> - ``` - -!!! Note - While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. - -## Step 4: Import a database and try some Oracle-syntax queries - -You can find a full walkthrough in the [Oracle SQL compatibility demo](../using_cluster/06_demonstration_oracle_compatibility#try-it-on-your-own-cluster-export-and-import). - -You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. - -## Further reading - -Now that you've got the basics out of the way, see what else BigAnimal offers: - -- [Backup and restore](experiment/backup_and_restore) -- [Import data](experiment/import_data) -- [CLI reference](../reference/cli) -- [API reference](../reference/api) From da0c6868254510e936517700f9108249b618ac3d Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 21:08:12 +0000 Subject: [PATCH 25/53] Move non-quickstart content a level deeper --- .../connect_using_dbeaver.mdx | 5 ++++ .../connect_using_pgadmin.mdx | 4 +++ .../connect_using_psql.mdx | 4 +++ .../connect_to_a_cluster/index.mdx | 1 + .../create_a_cluster/create_cluster_cli.mdx | 4 +++ .../create_cluster_portal.mdx | 2 +- .../{ => detail}/create_a_cluster/index.mdx | 1 + .../{ => detail}/create_an_account/index.mdx | 1 + .../experiment/backup_and_restore.mdx | 0 .../{ => detail}/experiment/import_data.mdx | 0 .../{ => detail}/experiment/index.mdx | 1 + .../release/free_trial/detail/index.mdx | 12 +++++++++ .../biganimal/release/free_trial/index.mdx | 25 ++++++++----------- .../release/free_trial/quickstart.mdx | 8 +++--- 14 files changed, 49 insertions(+), 19 deletions(-) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/connect_to_a_cluster/connect_using_dbeaver.mdx (96%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/connect_to_a_cluster/connect_using_pgadmin.mdx (98%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/connect_to_a_cluster/connect_using_psql.mdx (97%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/connect_to_a_cluster/index.mdx (89%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/create_a_cluster/create_cluster_cli.mdx (97%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/create_a_cluster/create_cluster_portal.mdx (97%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/create_a_cluster/index.mdx (93%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/create_an_account/index.mdx (90%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/experiment/backup_and_restore.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/experiment/import_data.mdx (100%) rename product_docs/docs/biganimal/release/free_trial/{ => detail}/experiment/index.mdx (78%) create mode 100644 product_docs/docs/biganimal/release/free_trial/detail/index.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx similarity index 96% rename from product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx index 867f0e9e026..1c7e861a1c3 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_dbeaver.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -30,3 +30,8 @@ indexCards: none 7. Click the "Test connection ..." button and verify that DBeaver is able to connect to your cluster 8. Click "Finish" to save the connection + + +## Next steps + +[Experiment!](../experiment) diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx similarity index 98% rename from product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx index 90288a3fa24..48431c2c41d 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -54,3 +54,7 @@ Click SSL and change SSL mode to "Require". Finally, click the "Save" button. pgAdmin will try to establish a connection to your database, and when successful will display the dashboard along with the list of available databases on the left. + +## Next steps + +[Experiment!](../experiment) diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx similarity index 97% rename from product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx index 873fafd3d92..7e426f7c0cb 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -27,3 +27,7 @@ In case you're unfamiliar with PostgreSQL's URI format, you can find it document !!! EDB Postgres Advanced Server enhancements If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client will work with Advanced Server as well. + +## Next steps + +[Experiment!](../experiment) diff --git a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx similarity index 89% rename from product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx index 21683a85127..41a06c40343 100644 --- a/product_docs/docs/biganimal/release/free_trial/connect_to_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx @@ -1,5 +1,6 @@ --- title: "Connect to your cluster" +description: "Connecting to a BigAnimal cluster from several common clients" indexCards: simple navigation: - connect_using_psql diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx similarity index 97% rename from product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index 2f305a0d380..632a93e53bc 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -80,6 +80,10 @@ psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=r !!! Note "Other options for connecting" Sure, psql is great - but maybe you want to use another client. See [Connect to your cluster](../connect_to_a_cluster) for other options. +## Next steps + +[Connect to your cluster](../connect_to_a_cluster) + ## Further reading [BigAniaml CLI reference](/biganimal/latest/reference/cli/) diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx similarity index 97% rename from product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx index 137e4aa1c90..15d5bf8c135 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -54,4 +54,4 @@ Click on the provisioned cluster to view the parameters you'll need to connect t ## Next steps -Now you have a cluster, you can [connect](../connect_to_a_cluster) to it. +[Connect to your cluster](../connect_to_a_cluster) diff --git a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx similarity index 93% rename from product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx index 5ec996e8584..967b6029b3a 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx @@ -1,5 +1,6 @@ --- title: "Create a cluster" +description: "Creating a BigAnimal cluster from the portal or the command line" indexCards: none --- diff --git a/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx similarity index 90% rename from product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx index 293c61f7c61..08024a06c01 100644 --- a/product_docs/docs/biganimal/release/free_trial/create_an_account/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx @@ -1,5 +1,6 @@ --- title: "Create an EDB account for your free trial" +description: "Creating an EDB account and signing into the BigAnimal free trial portal" navTitle: "Create an account" --- diff --git a/product_docs/docs/biganimal/release/free_trial/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/experiment/backup_and_restore.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx similarity index 100% rename from product_docs/docs/biganimal/release/free_trial/experiment/import_data.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx diff --git a/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx similarity index 78% rename from product_docs/docs/biganimal/release/free_trial/experiment/index.mdx rename to product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx index d12ae99acf5..1270c77e558 100644 --- a/product_docs/docs/biganimal/release/free_trial/experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx @@ -1,6 +1,7 @@ --- title: "Experimenting with the BigAnimal Free Trial" navTitle: "Experimenting" +description: "A few ideas for testing the basic capabilities of the BigAnimal system" indexCards: none --- diff --git a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx new file mode 100644 index 00000000000..fc0bcbbfcec --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx @@ -0,0 +1,12 @@ +--- +title: Going deeper into the BigAnimal free trial +navTitle: Going deeper +indexCards: simple +navigation: + - create_an_account + - create_a_cluster + - connect_to_a_cluster + - experiment +--- + +The [Quickstart](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the power that it provides. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index eba28f0cca5..a4bfb69db12 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -4,18 +4,15 @@ navTitle: "Getting started" indexCards: none navigation: - quickstart - - create_an_account - - create_a_cluster - - connect_to_a_cluster - - experiment + - detail --- The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. !!! Note "Get started with BigAnimal quickly" - - [Trial PostgreSQL cluster running on AWS](quickstart) - create, connect to and work with - a standard community PostgreSQL cluster, provisioned on AWS + [Quickstart for the BigAnimal free trial](quickstart) - create, connect to and work with + a standard community PostgreSQL 14 cluster, provisioned on AWS ## What you get as part of the free trial @@ -38,7 +35,7 @@ Get started with your trial by signing up for a free EDB account. ## Create an account -If you haven't done so already, you'll need to [create your EDB account](create_an_account). +If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. @@ -51,24 +48,24 @@ BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced S There are several equivalent ways to create a cluster... -- [...Using the portal](create_a_cluster/create_cluster_portal) -- [...Using the CLI](create_a_cluster/create_cluster_cli) +- [...Using the portal](detail/create_a_cluster/create_cluster_portal) +- [...Using the CLI](detail/create_a_cluster/create_cluster_cli) ## Connect Once you have a running cluster, you can connect using any PostgreSQL compatible software - here are a few ideas to get you going: -- [Using psql](connect_to_a_cluster/connect_using_psql) -- [Using pgAdmin](connect_to_a_cluster/connect_using_pgadmin) -- [Using DBeaver](connect_to_a_cluster/connect_using_dbeaver) +- [Using psql](detail/connect_to_a_cluster/connect_using_psql) +- [Using pgAdmin](detail/connect_to_a_cluster/connect_using_pgadmin) +- [Using DBeaver](detail/connect_to_a_cluster/connect_using_dbeaver) ## Experiment A database is always more interesting when it contains... Data! Load up some sample data and see what BigAnimal lets you do with it: -- [Importing some sample data](experiment/import_data) -- [Testing backups by restoring a cluster](experiment/backup_and_restore) +- [Importing some sample data](detail/experiment/import_data) +- [Testing backups by restoring a cluster](detail/experiment/backup_and_restore) - [...Plus EDB Postgres Advanced Server's Oracle Compatibility](../using_cluster/06_demonstration_oracle_compatibility) ## What you can’t do diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index ae721bf4806..4fa9e26bdb4 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -12,7 +12,7 @@ This topic provides a quick walkthrough of the steps needed to configure a Postg ## Step 1: create an account and sign into the portal -If you haven't done so already, you'll need to [create your EDB account](create_an_account). +If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). @@ -61,7 +61,7 @@ Once your first cluster is fully provisioned, your 14 day free trial officially ``` !!! Note - While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](connect_to_a_cluster) for more ideas. + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](detail/connect_to_a_cluster) for more ideas. ## Things to try @@ -162,7 +162,7 @@ You've successfully created a BigAnimal free trial cluster. If you want to explo Now that you've got the basics out of the way, see what else BigAnimal offers: -- [Backup and restore](experiment/backup_and_restore) -- [Import data](experiment/import_data) +- [Backup and restore](detail/experiment/backup_and_restore) +- [Import data](detail/experiment/import_data) - [CLI reference](../reference/cli) - [API reference](../reference/api) From d25008f5241cbea81ccdb703f41c112bf3522c75 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 29 Mar 2022 21:10:46 +0000 Subject: [PATCH 26/53] tweak intro & title slightly --- product_docs/docs/biganimal/release/free_trial/quickstart.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index 4fa9e26bdb4..6b8b0d5e528 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -1,5 +1,5 @@ --- -title: "Quickstart for the BigAnimal free trial on AWS" +title: "Quickstart for the BigAnimal free trial" navTitle: "Quickstart" tags: - azure @@ -8,7 +8,7 @@ tags: - psql --- -This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL cluster on BigAnimal running against AWS with a free trial account. +This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL 14 cluster on BigAnimal running against AWS with a free trial account. ## Step 1: create an account and sign into the portal From b64efd1b272e9dc0ef1f96a0524e1ff90e4420b6 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 31 Mar 2022 04:10:26 +0000 Subject: [PATCH 27/53] Integrate changes from #2427, misc cleanup --- .../connect_using_dbeaver.mdx | 5 ++ .../connect_using_pgadmin.mdx | 4 ++ .../connect_using_psql.mdx | 4 ++ .../create_a_cluster/create_cluster_cli.mdx | 3 +- .../create_cluster_portal.mdx | 7 +++ .../detail/experiment/backup_and_restore.mdx | 53 +++++++++++++++++-- .../free_trial/detail/experiment/index.mdx | 13 +++++ .../biganimal/release/free_trial/index.mdx | 11 ++-- 8 files changed, 92 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx index 1c7e861a1c3..130eb594bf3 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -35,3 +35,8 @@ indexCards: none ## Next steps [Experiment!](../experiment) + + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx index 48431c2c41d..1013599b130 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -58,3 +58,7 @@ along with the list of available databases on the left. ## Next steps [Experiment!](../experiment) + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx index 7e426f7c0cb..759b8d14235 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -31,3 +31,7 @@ tab completion for Oracle database compatible syntax. However, the standard Post ## Next steps [Experiment!](../experiment) + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index 632a93e53bc..d06432d02ee 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -86,4 +86,5 @@ psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=r ## Further reading -[BigAniaml CLI reference](/biganimal/latest/reference/cli/) +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) +[Creating a cluster](/biganimal/latest/getting_started/creating_a_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx index 15d5bf8c135..fc07fbfcfb4 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -31,6 +31,9 @@ In the free trial, the range of cluster options is somewhat limited, but should 4. **Postgres Version** allows you to select from among the supported versions for either database type 4. **Provider** is either AWS or Azure; BigAnimal works the same on either one, so choose the one you're familiar with. 5. **Region** options will depend on which Provider you chose; pick the one closest to you. +6. **Network Connectivity** is restricted to a public IP for the trial, but you can restrict access to trusted networks by + checking the *Use allowlists to restrict network access* checkbox and specifying one more more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + to allow access from. For **Instance Type** and **Storage**, only one option is available for each field during the trial - so just choose that. @@ -55,3 +58,7 @@ Click on the provisioned cluster to view the parameters you'll need to connect t ## Next steps [Connect to your cluster](../connect_to_a_cluster) + +## Further reading + +[Creating a cluster](/biganimal/latest/getting_started/creating_a_cluster/) in the full version documentation. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx index 0169aa98f3e..a45d9266042 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx @@ -21,9 +21,10 @@ Now you can switch to your new (and empty) baseball database. \c baseball ``` -Normally we'd use log files to determine the moment in time that we want to restore. The free trial doesn't provide access to the logs, however. So that we have accurate timing of our activities, let's change the prompt to include a timestamp. +Normally we'd use log files to determine the moment in time that we want to restore. The free trial doesn't provide access to the logs, however. So that we have accurate timing of our activities, let's change the prompt to include a timestamp. For convenience, we'll use the (almost) ISO-8601 format that the restore command accepts. + ```sql -\set PROMPT1 '%`date +%H:%M:%S` %/%R%# ' +\set PROMPT1 '%`date +"%Y-%m-%dT%H:%M:%S%z"` %/%R%# ' ``` For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. @@ -89,20 +90,59 @@ You can verify the table is gone by looking at the list of tables. ``` For the free trial, you are limited to one active cluster. Restoring a cluster creates a brand new cluster that is initialized with the cluster backup. Quit psql (`\q`) and delete the cluster from the command line. + +!!! Note + For more on using the BigAnimal CLI, refer to [Creating a cluster on the commmand line](../create_a_cluster/create_cluster_cli) and the [BigAnimal CLI reference](/biganimal/latest/reference/cli/). + ```shell ./biganimal delete-cluster --id p-xxxxxxxxxxx ``` -Restore the cluster using the timestamp before the time you dropped the table. (This currently requires using the web interface.) +Restore the cluster using the timestamp before the time you dropped the table. + +```shell +biganimal restore-cluster --id p-xxxxxxxxxxx --from-deleted --restore-point 2022-03-31T02:39:40+0000 +__OUTPUT__ +✔ New Name for Restored Cluster, Leave empty to continue with source cluster data: █ +Restored Cluster Password: ************* +Region: US East 1 +Instance Type: r5.large(2vCPU, 16GB RAM) +Volume Type: General Purpose SSD (GP3) +Volume Properties: gp3 (1 Gi - 16384 Gi, 3000 IOPS, 125 MiB/s tput) +✔ Specify database configuration, for example "application_name=sample_app&array_nulls=true". Leave empty to continue with source cluster data: █ +High Availability: Keep Existing +Networking: Keep Existing +Add IP Range to allow network traffic to your cluster from the public Internet: Keep Existing +Are you sure you want to Restore Cluster ? [y|n]: y +Restore Cluster operation is started +Cluster ID is "p-yyyyyyyyyy" +To check current state, run: biganimal show-clusters --id p-yyyyyyyyyy +``` + +!!! Note Optional arguments for the CLI + We're only providing the information we have handy to the restore command: the ID of the cluster, the fact that + the cluster is deleted, and the timestamp for the restore point. The CLI will prompt for additional information + (such as the password, or the region to restore to) and allow you to enter or select from a list as appropriate. + + If you know ahead of time which options you'll need, you can provide all of them via parameters and the command + will run non-interactively. Check the status of the new cluster from the command line. + ```shell ./biganimal show-clusters ``` -Log into the new cluster. Again use the edb_admin password used when creating the cluster you recently deleted. +Once provisioning is complete, you'll want to grab the new connection information - the hostname will have changed! + +```shell +biganimal show-cluster-connection --id p-yyyyyyyyyy +``` + +Log into the new cluster. Be sure to use the new hostname, and use the edb_admin password you provided when restoring the cluster. Verify that the batters table has been restored: + ```sql select playerid, yearid, teamid, rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, @@ -112,3 +152,8 @@ where yearid = 1998 order by hr_rank limit 5; ``` + +## Further reading + +[Backing up and restoring](/biganimal/latest/using_cluster/04_backup_and_restore/) in the full version documentation. +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx index 1270c77e558..2cdfe04390b 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx @@ -10,3 +10,16 @@ Here are a few examples to get you started: * [Import data](import_data) * [Backup and restore](backup_and_restore) + +## Experimenting with different configurations during the trial + +You can only have one *active* cluster at a time... But what if you want to do some extensive testing on multiple clusters? Perhaps to compare different cloud providers, regions, or database options against an [import](import_data) of a represenative dataset? + +Well, if you want to configure a new cluster, you can just delete the currently active one: + +1. Navigate to the [Clusters](https://portal.biganimal.com/clusters) page on the portal +2. Select the delete button (trashcan icon) on the active cluster +3. Confirm deletion +4. Reload the page + +Now the Create New Cluster button is enabled again, and you can [create a new cluster](../create_a_cluster) or [restore a previously deleted one](backup_and_restore). diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index a4bfb69db12..e09b3cb1b3b 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -22,8 +22,14 @@ The free trial provides a subset of the full-featured BigAnimal environment so t - **One active cluster, unlimited inactive ones** - You can try different configurations by deleting the active cluster and creating a new one. - Restore deleted clusters at any time within the trial period. - - 2 vCPUs and 16 GB RAM with up to 4GB of Azure Premium SSD storage. - - 2 Azure Regions to choose from: US East 2 or West Europe (Netherlands). + - Choose from either AWS or Azure cloud hosting, with two regions available for each (out of [all supported regions](/biganimal/latest/overview/03a_region_support)) + + | Cluster Details | On Azure | On AWS | + | --------------- | --------------------------------------------- | ----------------------------------------------------- | + | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | + | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | + | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 4 | + | | | | - **Edit database configuration settings.** - **Connect to your cluster** via a public IP from psql, pgAdmin, or your favorite PostgreSQL-friendly application. - **Access to EDB enterprise-level support.** @@ -72,7 +78,6 @@ Load up some sample data and see what BigAnimal lets you do with it: Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- Backups are only retained for 30 days. - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends From 96d00a4112a70673f0c4dd928ce2fef825e33694 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 31 Mar 2022 08:31:50 -0400 Subject: [PATCH 28/53] minor copy edits --- .../connect_using_dbeaver.mdx | 34 +++++++++---------- .../connect_using_pgadmin.mdx | 20 +++++------ .../connect_using_psql.mdx | 11 +++--- .../detail/connect_to_a_cluster/index.mdx | 2 +- .../create_a_cluster/create_cluster_cli.mdx | 8 ++--- .../create_cluster_portal.mdx | 26 +++++++------- .../detail/create_an_account/index.mdx | 14 ++++---- .../detail/experiment/backup_and_restore.mdx | 2 +- .../free_trial/detail/experiment/index.mdx | 11 +++--- .../biganimal/release/free_trial/index.mdx | 4 ++- .../release/free_trial/quickstart.mdx | 26 +++++++------- 11 files changed, 81 insertions(+), 77 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx index 130eb594bf3..df7e76d5496 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -5,31 +5,31 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. -1. Launch [DBeaver](https://dbeaver.io/) -2. Click the "New Database Connection" button on the toolbar to open the "Connect to a database" dialog -3. Select PostgreSQL and click "Next" +1. Launch [DBeaver](https://dbeaver.io/). +2. Select the **New Database Connection** button on the toolbar to open the **Connect to a database** dialog. +3. Select PostgreSQL and select **Next**. - You may be prompted to download the PostgreSQL JDBC driver -4. On the "Main" tab, + You may be prompted to download the PostgreSQL JDBC driver. +4. On the **Main** tab, - - Enter your cluster's hostname in the "Host:" field - - Enter "edb_admin" in the "Database:" field - - Enter "edb_admin" in the "Username:" field - - Enter your cluster's password in the "Password:" field + - Enter your cluster's hostname in the **Host** field. -5. On the "SSL" tab, + - Enter "edb_admin" in the **Database** field. + - Enter "edb_admin" in the **Username** field. + - Enter your cluster's password in the **Password** field. - - Check the "Use SSL" checkbox - - Select "require" for the "SSL mode:" field +5. On the **SSL** tab, -6. On the "PostgreSQL" tab + - Check the **Use SSL** checkbox. - - Check the "Show all databases" checkbox + - Select "require" for the **SSL mode:** field. -7. Click the "Test connection ..." button and verify that DBeaver is able to connect to your cluster -8. Click "Finish" to save the connection +6. On the **PostgreSQL** tab, check the **Show all databases** checkbox. + +7. Select the **Test connection ...** button and verify that DBeaver is able to connect to your cluster. +8. Select **Finish** to save the connection. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx index 1013599b130..d184ff6a5b9 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -5,10 +5,10 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. -[The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage and query your cluster's databases from a desktop or web UI. +[The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage, and query your cluster's databases from a desktop or web UI. A quick way to try out pgAdmin is to run it in a Docker container. With Docker installed, run: @@ -41,18 +41,18 @@ Status: Downloaded newer image for dpage/pgadmin4:latest Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ then entering the email and password specified on the command line. -From the welcome page, select Add New Server. You'll be prompted to configure the connection: +From the welcome page, select **Add New Server**. You're prompted to configure the connection: -Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then click "Connection" +Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then select **Connection**. -1. Enter your cluster's hostname in the Host name/address field, -2. `edb_admin` in the Maintenance database field (this is the default database that'll be connected to by pgAdmin), -3. `edb_admin` in the Username field, -4. and the password you provided when configuring your cluster in the Password field (you may want to save this for convenience while testing). +1. Enter your cluster's hostname in the **Host name/address** field, +2. "edb_admin" in the **Maintenance database** field (this is the default database that'll be connected to by pgAdmin), +3. "edb_admin" in the **Username** field, +4. and the password you provided when configuring your cluster in the **Password** field (you may want to save this for convenience while testing). -Click SSL and change SSL mode to "Require". +Select SSL and change SSL mode to "Require". -Finally, click the "Save" button. pgAdmin will try to establish a connection to your database, and when successful will display the dashboard +Finally, select the **Save** button. pgAdmin tries to establish a connection to your database, and when successful displays the dashboard along with the list of available databases on the left. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx index 759b8d14235..5ff2feef4be 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -5,28 +5,27 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. [psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, there are quite a few commands for inspecting and managing the database built in that make light work of even complex tasks. -You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. e.g. +You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. For example, ```shell psql -W "postgres://edb_admin@p-h67q2yc7hq.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require" ``` -The URI is all that's necessary for psql; while you *can* pass each element of that URL individually +The URI is all that's necessary for psql. While you *can* pass each element of that URL individually (pulling the information from the Connect tab on the portal for instance), psql will happily parse it out for you (and prompt for the password). In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). -!!! EDB Postgres Advanced Server enhancements - If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as -tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client will work with Advanced Server as well. +!!! Note EDB Postgres Advanced Server enhancements + If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client works with EDB Postgres Advanced Server as well. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx index 41a06c40343..50ef4558b12 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx @@ -12,7 +12,7 @@ So, you've created a cluster... Now what? You probably want to connect to it! BigAnimal clusters are Real Actual Postgres Databases, so you can connect to them just as you would any other Postgres database. -All of the parameters you need to connect can be found on the portal by clicking on the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then clicking the "Connect" tab. +All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. This section provides a few examples of connecting from common clients. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index d06432d02ee..68f8cf9e3a0 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -5,7 +5,7 @@ indexCards: none --- -We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever you system will find executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. +We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system will find executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. ```shell mv biganimal $HOME/bin ``` @@ -28,7 +28,7 @@ biganimal show-credentials ``` !!! caution -If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option is not needed. You may remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users will not need to add multiple credentials. +If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option is not needed. You may remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users do not need to add multiple credentials. !!! In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. @@ -67,7 +67,7 @@ If successful, the command will give you a command to check the status of your n biganimal show-clusters --id p-xxxxxxxxxx ``` -The id will be used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: +The id is used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: ```shell biganimal show-cluster-connection --id p-xxxxxxxxxxx ``` @@ -86,5 +86,5 @@ psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=r ## Further reading -[BigAnimal CLI reference](/biganimal/latest/reference/cli/) +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) and [Creating a cluster](/biganimal/latest/getting_started/creating_a_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx index fc07fbfcfb4..e076118e3a7 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -6,13 +6,13 @@ indexCards: none ## Navigating to the Create Cluster page -1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/) (sign in with [your account](../create_account) if need-be) +1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/) (sign in with [your account](../create_account) if need-be). -2. Click the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page +2. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. -3. Click the Create New Cluster button +3. Select the **Create New Cluster** button. -You should now find yourself at +You should now find yourself at . ## Configuring a new cluster @@ -20,19 +20,19 @@ You should now find yourself at In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. -1. Use **Cluster Name** to describe the purpose of the cluster, e.g. "Test for Advanced Server on AWS" +1. Use **Cluster Name** to describe the purpose of the cluster, e.g. "Test for Advanced Server on AWS." 2. **Password** is the admin password for the cluster - so pick a strong one! Note that this is independent of your EDB account. 3. **Database Type** is one of, - - - *EnterpriseDB PostgreSQL Advanced Server* for Oracle database compatibility - - - *PostgreSQL* for official community builds of standard PostgreSQL + - *EnterpriseDB PostgreSQL Advanced Server* for Oracle database compatibility + - *PostgreSQL* for official community builds of standard PostgreSQL So if you're interested in EDB's enhancements to PostgreSQL for Oracle database compatibility, choose Advanced Server; otherwise, choose PostgreSQL. -4. **Postgres Version** allows you to select from among the supported versions for either database type +4. **Postgres Version** allows you to select from among the supported versions for either database type. 4. **Provider** is either AWS or Azure; BigAnimal works the same on either one, so choose the one you're familiar with. -5. **Region** options will depend on which Provider you chose; pick the one closest to you. +5. **Region** options depend on which Provider you chose; pick the one closest to you. 6. **Network Connectivity** is restricted to a public IP for the trial, but you can restrict access to trusted networks by - checking the *Use allowlists to restrict network access* checkbox and specifying one more more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + checking the **Use allowlists to restrict network access** checkbox and specifying one more more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to allow access from. For **Instance Type** and **Storage**, only one option is available for each field during the trial - so just choose that. @@ -47,13 +47,13 @@ This page configures high availability - but that feature is not available in th ## Provisioning -Click create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. +Select create cluster and you're brought back to the clusters page with your newly-configured cluster now populating the list. Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. -Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. +Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown appears telling you how many days are left in your trial. -Click on the provisioned cluster to view the parameters you'll need to connect to it. +Select the provisioned cluster to view the parameters you'll need to connect to it. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx index 08024a06c01..b0a7cb7c85a 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx @@ -7,14 +7,14 @@ navTitle: "Create an account" Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. -1. Navigate to -2. Click the "Try it for free" button -3. Fill in the form, and agree to the terms and conditions -4. Click Submit -5. Check your email - you should recieve an email from EDB containing an activation link -6. Click the activation link and enter a password for your EDB account +1. Navigate to . +2. Select the **Try it for free** button. +3. Fill in the form, and agree to the terms and conditions. +4. Select **Submit**. +5. Check your email - you should receive an email from EDB containing an activation link. +6. Select the activation link and enter a password for your EDB account. -You'll then be redirected to the BigAnimal portal. +You're then redirected to the BigAnimal portal. !!! Note "Already have an EDB account?" If you've already signed up for an EDB account, you can navigate to to log in using it. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx index a45d9266042..0f6d6563014 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx @@ -4,7 +4,7 @@ navTitle: "Backup and restore" indexCards: none --- -BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trail as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. +BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trial as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. If you haven't already, [create a cluster](create_cluster_cli) on BigAnimal. For the free trial, you may only have one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx index 2cdfe04390b..865e1bb0773 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx @@ -17,9 +17,10 @@ You can only have one *active* cluster at a time... But what if you want to do s Well, if you want to configure a new cluster, you can just delete the currently active one: -1. Navigate to the [Clusters](https://portal.biganimal.com/clusters) page on the portal -2. Select the delete button (trashcan icon) on the active cluster -3. Confirm deletion -4. Reload the page +1. Navigate to the [Clusters](https://portal.biganimal.com/clusters) page on the portal. -Now the Create New Cluster button is enabled again, and you can [create a new cluster](../create_a_cluster) or [restore a previously deleted one](backup_and_restore). +2. Select the delete button (trashcan icon) on the active cluster. +3. Confirm the deletion. +4. Reload the page. + +Now the **Create New Cluster** button is enabled again, and you can [create a new cluster](../create_a_cluster) or [restore a previously deleted one](backup_and_restore). diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index e09b3cb1b3b..95913a2fccd 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -18,6 +18,7 @@ The free trial provides a subset of the full-featured BigAnimal environment so t - **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases**. - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more powerful, more secure, more flexible, more secure and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). + - [EDB Postgres Advanced Server 14](https://www.enterprisedb.com/docs/epas/latest/epas_rel_notes/) builds on PostgreSQL 14 with a host of features for Oracle database compatibility, security, and usability ([more on Oracle database compatibility](/epas/latest/epas_compat_ora_dev_guide/)). - **One active cluster, unlimited inactive ones** - You can try different configurations by deleting the active cluster and creating a new one. @@ -48,7 +49,7 @@ Accounts are free, and registration takes less than a minute. ## Create a cluster -The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to ba active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. +The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced Server (EPAS) clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11-13). Other configuration options are limited for the free trail. @@ -78,6 +79,7 @@ Load up some sample data and see what BigAnimal lets you do with it: Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. + - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index 6b8b0d5e528..dc1bd298339 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -18,22 +18,24 @@ Then, use your account to access the [BigAnimal portal](https://portal.biganimal ## Step 2: create an AWS cluster -1. Select the Clusters link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page +1. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. -2. Select the Create New Cluster button +2. Select the **Create New Cluster** button. - You should now find yourself at + You should now find yourself at . + +3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field. +4. Enter a strong, memorable password in the **Password** field. -3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field -4. Enter a strong, memorable password in the **Password** field This is the admin password for the cluster. 5. Choose "PostgreSQL" for **Database Type** - This gives you an official build of PostgreSQL -6. Choose "14" for **Postgres Version** -4. Select AWS for **Provider** -5. Select "US East 1" for **Region** + + This gives you an official build of PostgreSQL. +6. Choose "14" for **Postgres Version**. +4. Select AWS for **Provider**. +5. Select "US East 1" for **Region**. 6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. -7. Select "Create Cluster" +7. Select **Create Cluster**. ### Provisioning, active clusters and deletion @@ -41,7 +43,7 @@ Select create cluster and you'll be brought back to the clusters page with your Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. -Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown will appear telling you how many days are left in your trial. +Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown appears telling you how many days are left in your trial. ## Step 3: Connecting to your new cluster @@ -88,7 +90,7 @@ We're going to create some sample math data, so we're going to create a database create database math with owner math; ``` -4. Connect to the `math` database. You will be prompted for the `edb_admin` password you provided in Step 2 above. +4. Connect to the `math` database. You are prompted for the `edb_admin` password you provided in Step 2 above. ``` \connect math From 6a8ca23c8ac18e844597b0a87b341eda619d273e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 31 Mar 2022 11:52:00 -0400 Subject: [PATCH 29/53] copyedit of free trial content --- .../connect_using_dbeaver.mdx | 23 +++++----- .../connect_using_pgadmin.mdx | 18 ++++---- .../connect_using_psql.mdx | 14 +++--- .../detail/connect_to_a_cluster/index.mdx | 6 +-- .../create_a_cluster/create_cluster_cli.mdx | 31 ++++++++----- .../create_cluster_portal.mdx | 32 ++++++------- .../detail/create_a_cluster/index.mdx | 16 +++---- .../detail/create_an_account/index.mdx | 6 +-- .../detail/experiment/backup_and_restore.mdx | 35 ++++++++------ .../detail/experiment/import_data.mdx | 14 +++--- .../free_trial/detail/experiment/index.mdx | 6 +-- .../release/free_trial/detail/index.mdx | 2 +- .../biganimal/release/free_trial/index.mdx | 46 +++++++++---------- .../release/free_trial/quickstart.mdx | 42 ++++++++--------- 14 files changed, 154 insertions(+), 137 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx index df7e76d5496..a6673725a5b 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -5,30 +5,29 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. 1. Launch [DBeaver](https://dbeaver.io/). 2. Select the **New Database Connection** button on the toolbar to open the **Connect to a database** dialog. -3. Select PostgreSQL and select **Next**. +3. Select **PostgreSQL** and select **Next**. - You may be prompted to download the PostgreSQL JDBC driver. -4. On the **Main** tab, + You might be prompted to download the PostgreSQL JDBC driver. +4. On the **Main** tab: - Enter your cluster's hostname in the **Host** field. - - Enter "edb_admin" in the **Database** field. - - Enter "edb_admin" in the **Username** field. + - Enter `edb_admin` in the **Database** field. + - Enter `edb_admin` in the **Username** field. - Enter your cluster's password in the **Password** field. -5. On the **SSL** tab, +5. On the **SSL** tab: - - Check the **Use SSL** checkbox. + - Select the **Use SSL** check box. + - Select **require** for the **SSL mode:** field. - - Select "require" for the **SSL mode:** field. +6. On the **PostgreSQL** tab, check the **Show all databases** check box. -6. On the **PostgreSQL** tab, check the **Show all databases** checkbox. - -7. Select the **Test connection ...** button and verify that DBeaver is able to connect to your cluster. +7. Select the **Test connection** button and verify that DBeaver is able to connect to your cluster. 8. Select **Finish** to save the connection. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx index d184ff6a5b9..222e543190f 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -5,7 +5,7 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. [The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage, and query your cluster's databases from a desktop or web UI. @@ -39,20 +39,20 @@ Status: Downloaded newer image for dpage/pgadmin4:latest 99f4775629b1086b95601d659eae9dfe7125c4694a1a90891f840d12f8ca0261 ``` -Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ then entering the email and password specified on the command line. +Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ and then entering the email and password specified on the command line. From the welcome page, select **Add New Server**. You're prompted to configure the connection: -Enter "BigAnimal Trial" for the name (or use the name you gave to your cluster!), then select **Connection**. +Enter `BigAnimal Trial` for the name (or use the name you gave to your cluster!), and then select **Connection**. -1. Enter your cluster's hostname in the **Host name/address** field, -2. "edb_admin" in the **Maintenance database** field (this is the default database that'll be connected to by pgAdmin), -3. "edb_admin" in the **Username** field, -4. and the password you provided when configuring your cluster in the **Password** field (you may want to save this for convenience while testing). +1. Enter your cluster's hostname in the **Host name/address** field. +2. Enter `edb_admin` in the **Maintenance database** field (this is the default database that'll be connected to by pgAdmin). +3. Enter `edb_admin` in the **Username** field. +4. Enter the password you provided when configuring your cluster in the **Password** field (you might want to save this for convenience while testing). -Select SSL and change SSL mode to "Require". +Select **SSL** and change SSL mode to **Require**. -Finally, select the **Save** button. pgAdmin tries to establish a connection to your database, and when successful displays the dashboard +Finally, select the **Save** button. pgAdmin tries to establish a connection to your database. When successful, it displays the dashboard along with the list of available databases on the left. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx index 5ff2feef4be..c6e89e9cc8c 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -5,27 +5,27 @@ indexCards: none --- !!! Note - All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. [psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) -and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, there are quite a few commands for -inspecting and managing the database built in that make light work of even complex tasks. +and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, it offers quite a few built-in commands for +inspecting and managing the database that make light work of even complex tasks. -You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's Overview tab on the portal. For example, +You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's **Overview** tab on the portal. For example: ```shell psql -W "postgres://edb_admin@p-h67q2yc7hq.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require" ``` -The URI is all that's necessary for psql. While you *can* pass each element of that URL individually -(pulling the information from the Connect tab on the portal for instance), psql will happily parse it out for you (and prompt for the password). +The URI is all that's necessary for psql. While you _can_ pass each element of that URL individually +(pulling the information from the **Connect** tab on the portal, for instance), psql will happily parse it out for you (and prompt for the password). In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). !!! Note EDB Postgres Advanced Server enhancements - If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it - there are a few nice additions such as tab completion for Oracle database compatible syntax. However, the standard PostgreSQL client works with EDB Postgres Advanced Server as well. + If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it; there are a few nice additions such as tab completion for Oracle database-compatible syntax. However, the standard PostgreSQL client works with EDB Postgres Advanced Server as well. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx index 50ef4558b12..d40aa5077ac 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx @@ -8,11 +8,11 @@ navigation: - connect_using_dbeaver --- -So, you've created a cluster... Now what? You probably want to connect to it! +So, you've created a cluster. Now what? You probably want to connect to it! -BigAnimal clusters are Real Actual Postgres Databases, so you can connect to them just as you would any other Postgres database. +BigAnimal clusters are real, actual Postgres databases, so you can connect to them just as you would any other Postgres database. -All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page, then selecting the **Connect** tab. +All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. This section provides a few examples of connecting from common clients. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index 68f8cf9e3a0..ccc0c856d7c 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -1,46 +1,51 @@ --- -title: Creating a cluster on the commmand line +title: Creating a cluster on the command line navTitle: "Using the command line" indexCards: none --- -We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system will find executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. +We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system finds executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. + ```shell mv biganimal $HOME/bin ``` -It may also be necessary to give the executable proper permission: +It might also be necessary to give the executable proper permission: + ```shell chmod +x $HOME/bin/biganimal ``` -Next, we need to create a credential on BigAnimal. You can pick any username you prefer. +Next, you need to create a credential on BigAnimal. You can pick any username you prefer. + ```shell biganimal create-credential -a portal.biganimal.com -o 443 -n newuser ``` -The command will direct you to open a webpage and copy the randomly-generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. You can see which credentials you have verified on the command line. +The command will direct you to open a webpage and copy the randomly generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. You can see the credentials you've verified on the command line. ```shell biganimal show-credentials ``` !!! caution -If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option is not needed. You may remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users do not need to add multiple credentials. +If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option isn't needed. You can remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users don't need to add multiple credentials. !!! -In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. +In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. + +Pick the region closest to you from the list provided by BigAnimal: -Pick the region closest to you from the list provided by biganimal: ```shell biganimal show-regions ``` Other options can be queried via the CLI, but the only variable we need to set for this demo is . -Edit a new file called create_cluster.yaml: +Edit a new file called `create_cluster.yaml`: + ```yaml --- clusterName: test_cluster # Pick a more meaningful name! @@ -58,27 +63,31 @@ highAvailability: false ``` Use the config file to create a new cluster: + ```shell biganimal create-cluster --clusterConfigFile create_cluster.yaml ``` If successful, the command will give you a command to check the status of your new cluster: + ```shell biganimal show-clusters --id p-xxxxxxxxxx ``` The id is used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: + ```shell biganimal show-cluster-connection --id p-xxxxxxxxxxx ``` -Once the cluster is created, log in via psql. Use the password from the config file for edb_admin. +Once the cluster is created, log in via psql. Use the password from the `config` file for edb_admin. + ```shell psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require' ``` !!! Note "Other options for connecting" - Sure, psql is great - but maybe you want to use another client. See [Connect to your cluster](../connect_to_a_cluster) for other options. + Sure, psql is great, but maybe you want to use another client. See [Connect to your cluster](../connect_to_a_cluster) for other options. ## Next steps diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx index e076118e3a7..744e11889b3 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -6,52 +6,52 @@ indexCards: none ## Navigating to the Create Cluster page -1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/) (sign in with [your account](../create_account) if need-be). +1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/). (Sign in with [your account](../create_account) if you need to). 2. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. 3. Select the **Create New Cluster** button. -You should now find yourself at . +You should now find yourself at the [Create Cluster page](https://portal.biganimal.com/create-cluster). ## Configuring a new cluster ### The Cluster Settings tab -In the free trial, the range of cluster options is somewhat limited, but should be more than sufficient for demonstrating the capabilities of BigAnimal. +In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. -1. Use **Cluster Name** to describe the purpose of the cluster, e.g. "Test for Advanced Server on AWS." -2. **Password** is the admin password for the cluster - so pick a strong one! Note that this is independent of your EDB account. -3. **Database Type** is one of, +1. Use **Cluster Name** to describe the purpose of the cluster, e.g., "Test for Advanced Server on AWS." +2. **Password** is the admin password for the cluster, so pick a strong one! Note that this is independent of your EDB account. +3. **Database Type** is one of: - - *EnterpriseDB PostgreSQL Advanced Server* for Oracle database compatibility - - *PostgreSQL* for official community builds of standard PostgreSQL + - **EnterpriseDB PostgreSQL Advanced Server** for Oracle database compatibility + - **PostgreSQL** for official community builds of standard PostgreSQL So if you're interested in EDB's enhancements to PostgreSQL for Oracle database compatibility, choose Advanced Server; otherwise, choose PostgreSQL. 4. **Postgres Version** allows you to select from among the supported versions for either database type. 4. **Provider** is either AWS or Azure; BigAnimal works the same on either one, so choose the one you're familiar with. -5. **Region** options depend on which Provider you chose; pick the one closest to you. +5. **Region** options depend on the provider you chose; pick the one closest to you. 6. **Network Connectivity** is restricted to a public IP for the trial, but you can restrict access to trusted networks by - checking the **Use allowlists to restrict network access** checkbox and specifying one more more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + selecting the **Use allowlists to restrict network access** check box and specifying one or more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to allow access from. -For **Instance Type** and **Storage**, only one option is available for each field during the trial - so just choose that. +For **Instance Type** and **Storage**, only one option is available for each field during the trial, so just choose that. ### The DB Configuration tab -This is entirely optional, but if you're curious you can find a full set of PostgreSQL configuration options on this tab, allowing you to tune a cluster for specific needs or resource constraints. +This is entirely optional, but if you're curious, you can find a full set of PostgreSQL configuration options on this tab, allowing you to tune a cluster for specific needs or resource constraints. ### The Availability tab -This page configures high availability - but that feature is not available in the trial. Skip this tab unless you're curious. +This page configures high availability, but that feature isn't available in the trial. Skip this tab unless you're curious. ## Provisioning -Select create cluster and you're brought back to the clusters page with your newly-configured cluster now populating the list. +Select **Create Cluster**, and you're brought back to the Clusters page with your newly configured cluster now populating the list. -Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. +Initially, the new cluster is being provisioned. This usually takes a minute or two but can take up to an hour. A progress bar is shown near the right. -Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown appears telling you how many days are left in your trial. +Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. Select the provisioned cluster to view the parameters you'll need to connect to it. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx index 967b6029b3a..c9a644fc050 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx @@ -4,16 +4,16 @@ description: "Creating a BigAnimal cluster from the portal or the command line" indexCards: none --- -The BigAnimal Free Trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully it's quick and easy to [restore a cluster from backup](../experiment/backup_and_restore/). Backups are automatically created as soon as a cluster is used. +The BigAnimal free trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully, it's quick and easy to [restore a cluster from backup](../experiment/backup_and_restore/). Backups are automatically created as soon as a cluster is used. -When you create a cluster, there are two flavors of PostgreSQL to choice from: +When you create a cluster, there are two flavors of PostgreSQL to choose from: -* All supported versions of [open-source PostgreSQL](supported-open-source/postgresql/), including [PostgreSQL 14](https://www.postgresql.org/about/news/postgresql-14-released-2318/). -* [EDB Postgres Advanced Server](/epas/latest/), which augments open-source PostgreSQL with [Oracle compatibilty](/epas/latest/epas_compat_ora_dev_guide/) among other features. +- All supported versions of [open-source PostgreSQL](supported-open-source/postgresql/), including [PostgreSQL 14](https://www.postgresql.org/about/news/postgresql-14-released-2318/). +- [EDB Postgres Advanced Server](/epas/latest/), which augments open-source PostgreSQL with [Oracle compatibility](/epas/latest/epas_compat_ora_dev_guide/), among other features. -We'll demonstate two methods of creating a cluster: +We'll demonstrate two methods of creating a cluster: -* [Using the portal](create_cluster_portal) -* [Using the command line](create_cluster_cli) +- [Using the portal](create_cluster_portal) +- [Using the command line](create_cluster_cli) -Clusters may also be created programatically using the [fully-featured BigAnimal API](/biganimal/latest/reference/api/). +Clusters can also be created programmatically using the [fully featured BigAnimal API](/biganimal/latest/reference/api/). diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx index b0a7cb7c85a..c7331608175 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx @@ -4,17 +4,17 @@ description: "Creating an EDB account and signing into the BigAnimal free trial navTitle: "Create an account" --- -Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gets you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. 1. Navigate to . 2. Select the **Try it for free** button. 3. Fill in the form, and agree to the terms and conditions. 4. Select **Submit**. -5. Check your email - you should receive an email from EDB containing an activation link. +5. Check your email. You should receive an email from EDB containing an activation link. 6. Select the activation link and enter a password for your EDB account. You're then redirected to the BigAnimal portal. !!! Note "Already have an EDB account?" - If you've already signed up for an EDB account, you can navigate to to log in using it. + If you've already signed up for an EDB account, you can navigate to to log in. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx index 0f6d6563014..be63498f95d 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx @@ -1,14 +1,14 @@ --- -title: Backup and restore a cluster +title: Back up and restore a cluster navTitle: "Backup and restore" indexCards: none --- BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trial as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. -If you haven't already, [create a cluster](create_cluster_cli) on BigAnimal. For the free trial, you may only have one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. +If you haven't already, [create a cluster](create_cluster_cli) on BigAnimal. For the free trial, you can have only one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. -We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball" which we will populate with some Major League Baseball statistics. +We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball," which we will populate with some Major League Baseball statistics. ```sql create user baseball with password 'baseball_pwd'; @@ -17,6 +17,7 @@ create database baseball with owner baseball; ``` Now you can switch to your new (and empty) baseball database. + ```sql \c baseball ``` @@ -27,7 +28,8 @@ Normally we'd use log files to determine the moment in time that we want to rest \set PROMPT1 '%`date +"%Y-%m-%dT%H:%M:%S%z"` %/%R%# ' ``` -For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. + ```sql CREATE TABLE batters ( id SERIAL, @@ -58,11 +60,13 @@ CREATE TABLE batters ( ``` Now we can populate the table from the internet using the most recent data. + ```sql \COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER ``` -Just to prove there's data loaded, let's look at the homerun leaders for the 1998 season. +Just to prove there's data loaded, let's look at the home run leaders for the 1998 season. + ```sql SELECT playerid, yearid, teamid, rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, @@ -73,26 +77,29 @@ ORDER BY hr_rank LIMIT 5; ``` Suppose someone wanted to revise history a bit. + ```sql UPDATE batters SET hr=0 where playerid = 'mcgwima01' AND yearid = 1998; ``` -Note the time so we can restore that data later. Verify the data has been changed by re-running the 1998 homerun leader query. Now for good measure, go ahead and drop the whole table. +Note the time so we can restore that data later. Verify the data has been changed by rerunning the 1998 home run leader query. Now, for good measure, go ahead and drop the whole table. + ```sql DROP TABLE batters; ``` You can verify the table is gone by looking at the list of tables. + ```sql \dt ``` -For the free trial, you are limited to one active cluster. Restoring a cluster creates a brand new cluster that is initialized with the cluster backup. Quit psql (`\q`) and delete the cluster from the command line. +For the free trial, you're limited to one active cluster. Restoring a cluster creates a brand new cluster that's initialized with the cluster backup. Quit psql (`\q`), and delete the cluster from the command line. !!! Note - For more on using the BigAnimal CLI, refer to [Creating a cluster on the commmand line](../create_a_cluster/create_cluster_cli) and the [BigAnimal CLI reference](/biganimal/latest/reference/cli/). + For more on using the BigAnimal CLI, refer to [Creating a cluster on the command line](../create_a_cluster/create_cluster_cli) and the [BigAnimal CLI reference](/biganimal/latest/reference/cli/). ```shell ./biganimal delete-cluster --id p-xxxxxxxxxxx @@ -122,9 +129,9 @@ To check current state, run: biganimal show-clusters --id p-yyyyyyyyyy !!! Note Optional arguments for the CLI We're only providing the information we have handy to the restore command: the ID of the cluster, the fact that the cluster is deleted, and the timestamp for the restore point. The CLI will prompt for additional information - (such as the password, or the region to restore to) and allow you to enter or select from a list as appropriate. + (such as the password or the region to restore to) and allow you to enter or select from a list as appropriate. - If you know ahead of time which options you'll need, you can provide all of them via parameters and the command + If you know ahead of time the options you'll need, you can provide all of them via parameters, and the command will run non-interactively. Check the status of the new cluster from the command line. @@ -133,7 +140,7 @@ Check the status of the new cluster from the command line. ./biganimal show-clusters ``` -Once provisioning is complete, you'll want to grab the new connection information - the hostname will have changed! +Once provisioning is complete, you'll want to grab the new connection information. The hostname will have changed! ```shell biganimal show-cluster-connection --id p-yyyyyyyyyy @@ -141,7 +148,7 @@ biganimal show-cluster-connection --id p-yyyyyyyyyy Log into the new cluster. Be sure to use the new hostname, and use the edb_admin password you provided when restoring the cluster. -Verify that the batters table has been restored: +Verify that the batters table was restored: ```sql select playerid, yearid, teamid, @@ -155,5 +162,5 @@ order by hr_rank limit 5; ## Further reading -[Backing up and restoring](/biganimal/latest/using_cluster/04_backup_and_restore/) in the full version documentation. -[BigAnimal CLI reference](/biganimal/latest/reference/cli/) +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) and [Backing up and restoring](/biganimal/latest/using_cluster/04_backup_and_restore/) in the full version documentation. + diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx index 749a4d7d788..8c16ab5bb4e 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx @@ -3,11 +3,11 @@ title: "Import data from external sources" navTitle: "Import data" --- -PostgreSQL includes a variety of ways to import data. Here we'll show how to import a CVS file from the internet. +PostgreSQL includes a variety of ways to import data. Here, we'll show how to import a CSV file from the internet. -For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we will need to first define a table to put that data into. +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. -We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball" which we will populate with some Major League Baseball statistics. +We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball," which we'll populate with some Major League Baseball statistics. ```sql create user baseball with password 'baseball_pwd'; @@ -16,13 +16,13 @@ create database baseball with owner baseball; ``` Now you can switch to your new (and empty) baseball database. + ```sql \c baseball ``` - - You can just copy and paste this command into your terminal. + ```sql CREATE TABLE batters ( id SERIAL, @@ -53,11 +53,13 @@ CREATE TABLE batters ( ``` Now we can populate the table from the internet using the most recent data. + ```sql \COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER ``` -Just to prove there's data loaded, let's look at the homerun leaders for the 1998 season. +Just to prove there's data loaded, let's look at the home run leaders for the 1998 season. + ```sql SELECT playerid, yearid, teamid, rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx index 865e1bb0773..3deac297d90 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx @@ -1,11 +1,11 @@ --- -title: "Experimenting with the BigAnimal Free Trial" +title: "Experimenting with the BigAnimal free trial" navTitle: "Experimenting" description: "A few ideas for testing the basic capabilities of the BigAnimal system" indexCards: none --- -Once you have [created a cluster](../create_a_cluster/), it's time to put it through its paces. +Once you've [created a cluster](../create_a_cluster/), it's time to put it through its paces. Here are a few examples to get you started: * [Import data](import_data) @@ -13,7 +13,7 @@ Here are a few examples to get you started: ## Experimenting with different configurations during the trial -You can only have one *active* cluster at a time... But what if you want to do some extensive testing on multiple clusters? Perhaps to compare different cloud providers, regions, or database options against an [import](import_data) of a represenative dataset? +You can have only one _active_ cluster at a time. But what if you want to do some extensive testing on multiple clusters? Perhaps to compare different cloud providers, regions, or database options against an [import](import_data) of a representative dataset? Well, if you want to configure a new cluster, you can just delete the currently active one: diff --git a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx index fc0bcbbfcec..83531231a8a 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx @@ -9,4 +9,4 @@ navigation: - experiment --- -The [Quickstart](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the power that it provides. +The [Quick start](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the power that it provides. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 95913a2fccd..23f452f7ea0 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -1,5 +1,5 @@ --- -title: "Getting started with the BigAnimal Free Trial" +title: "Getting started with the BigAnimal free trial" navTitle: "Getting started" indexCards: none navigation: @@ -7,25 +7,25 @@ navigation: - detail --- -The BigAnimal Free Trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. +The BigAnimal free trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. !!! Note "Get started with BigAnimal quickly" - [Quickstart for the BigAnimal free trial](quickstart) - create, connect to and work with - a standard community PostgreSQL 14 cluster, provisioned on AWS + [Quick start for the BigAnimal free trial](quickstart) — Create, connect to, and work with + a standard community PostgreSQL 14 cluster, provisioned on AWS. ## What you get as part of the free trial -- **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases**. - - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more powerful, more secure, more flexible, more secure and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). +- **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases.** + - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more powerful, more secure, more flexible, more secure, and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). - [EDB Postgres Advanced Server 14](https://www.enterprisedb.com/docs/epas/latest/epas_rel_notes/) builds on PostgreSQL 14 with a host of features for Oracle database compatibility, security, and usability ([more on Oracle database compatibility](/epas/latest/epas_compat_ora_dev_guide/)). -- **One active cluster, unlimited inactive ones** +- **One active cluster, unlimited inactive ones.** - You can try different configurations by deleting the active cluster and creating a new one. - Restore deleted clusters at any time within the trial period. - - Choose from either AWS or Azure cloud hosting, with two regions available for each (out of [all supported regions](/biganimal/latest/overview/03a_region_support)) + - Choose from either AWS or Azure cloud hosting, with two regions available for each (out of [all supported regions](/biganimal/latest/overview/03a_region_support)). - | Cluster Details | On Azure | On AWS | + | Cluster details | On Azure | On AWS | | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | @@ -36,7 +36,7 @@ The free trial provides a subset of the full-featured BigAnimal environment so t - **Access to EDB enterprise-level support.** - **Use BigAnimal services for 14 days.** The countdown begins when you first provision a cluster. -(Numerous other instance types, storage types, regions, customizations and support options are available with a paid account.) +(Numerous other instance types, storage types, regions, customizations, and support options are available with a paid account.) Get started with your trial by signing up for a free EDB account. @@ -44,23 +44,23 @@ Get started with your trial by signing up for a free EDB account. If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). -Registering an account on enterprisedb.com gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gets you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. ## Create a cluster -The Free Trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial only allows one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. +The free trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial allows only one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. -BigAnimal offers both standard PostgreSQL and EnterpriseDB PostgreSQL Advanced Server (EPAS) clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11-13). Other configuration options are limited for the free trail. +BigAnimal offers both standard PostgreSQL and EnterpriseDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trail. -There are several equivalent ways to create a cluster... +There are several equivalent ways to create a cluster: -- [...Using the portal](detail/create_a_cluster/create_cluster_portal) -- [...Using the CLI](detail/create_a_cluster/create_cluster_cli) +- [Using the portal](detail/create_a_cluster/create_cluster_portal) +- [Using the CLI](detail/create_a_cluster/create_cluster_cli) ## Connect -Once you have a running cluster, you can connect using any PostgreSQL compatible software - here are a few ideas to get you going: +Once you have a running cluster, you can connect using any PostgreSQL-compatible software. Here are a few ideas to get you going: - [Using psql](detail/connect_to_a_cluster/connect_using_psql) - [Using pgAdmin](detail/connect_to_a_cluster/connect_using_pgadmin) @@ -68,24 +68,24 @@ Once you have a running cluster, you can connect using any PostgreSQL compatible ## Experiment -A database is always more interesting when it contains... Data! +A database is always more interesting when it contains...data! Load up some sample data and see what BigAnimal lets you do with it: - [Importing some sample data](detail/experiment/import_data) - [Testing backups by restoring a cluster](detail/experiment/backup_and_restore) -- [...Plus EDB Postgres Advanced Server's Oracle Compatibility](../using_cluster/06_demonstration_oracle_compatibility) +- [Seeing EDB Postgres Advanced Server's Oracle compatibility](../using_cluster/06_demonstration_oracle_compatibility) in action ## What you can’t do Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: -- You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. +- You can't invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. +- The BigAnimal free trial interface notes the features that aren't available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. -When the free trial ends, your account continues to exist but your cluster and its backup and data are deleted. You cannot transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. +When the free trial ends, your account continues to exist, but your cluster and its backup and data are deleted. You can't transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. -We hope two weeks is enough to give you a rough idea of what BigAnimal offers, but if you're interested in *really* seeing it in action we also offer a 30-day trial of the full product, running on your own Azure account with full access to all regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) \ No newline at end of file +We hope two weeks is enough time to give you a rough idea of what BigAnimal offers, but if you're interested in _really_ seeing it in action, we also offer a 30-day trial of the full product, running on your own Azure account with full access to all regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index dc1bd298339..db01475fd0b 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -1,6 +1,6 @@ --- -title: "Quickstart for the BigAnimal free trial" -navTitle: "Quickstart" +title: "Quick start for the BigAnimal free trial" +navTitle: "Quick start" tags: - azure - biganimal @@ -8,47 +8,47 @@ tags: - psql --- -This topic provides a quick walkthrough of the steps needed to configure a PostgreSQL 14 cluster on BigAnimal running against AWS with a free trial account. +This topic provides a quick walk-through of the steps needed to configure a PostgreSQL 14 cluster on BigAnimal running against AWS with a free trial account. -## Step 1: create an account and sign into the portal +## Step 1: Create an account and sign into the portal If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). -## Step 2: create an AWS cluster +## Step 2: Create an AWS cluster 1. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. 2. Select the **Create New Cluster** button. - You should now find yourself at . + You should now find yourself at the [Create Cluster page]. -3. Enter "AWS PostgreSQL cluster" in the **Cluster Name** field. +3. Enter `AWS PostgreSQL cluster` in the **Cluster Name** field. 4. Enter a strong, memorable password in the **Password** field. This is the admin password for the cluster. -5. Choose "PostgreSQL" for **Database Type** +5. Select **PostgreSQL** for **Database Type** This gives you an official build of PostgreSQL. -6. Choose "14" for **Postgres Version**. -4. Select AWS for **Provider**. -5. Select "US East 1" for **Region**. -6. For **Instance Type** and **Storage**, only one set of options are available in the trial - select them. +6. Select **14** for **Postgres Version**. +4. Select **AWS** for **Provider**. +5. Select **US East 1** for **Region**. +6. For **Instance Type** and **Storage**, only one set of options is available in the trial. Select each option. 7. Select **Create Cluster**. -### Provisioning, active clusters and deletion +### Provisioning, active clusters, and deletion -Select create cluster and you'll be brought back to the clusters page with your newly-configured cluster now populating the list. +After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. -Initially, the new cluster is being provisioned. This usually takes a minute or two, but can take up to an hour. A progress bar is shown near the right. +Initially, the new cluster is being provisioned. This usually takes a minute or two but can take up to an hour. A progress bar is shown near the right. -Once your first cluster is fully provisioned, your 14 day free trial officially starts, and a countdown appears telling you how many days are left in your trial. +Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. -## Step 3: Connecting to your new cluster +## Step 3: Connect to your new cluster 1. Select your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. -2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where `psql` is installed. It will prompt for your password and put you on a SQL command line. +2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where psql is installed. It will prompt for your password and put you on a SQL command line. ``` $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" @@ -63,7 +63,7 @@ Once your first cluster is fully provisioned, your 14 day free trial officially ``` !!! Note - While psql is a good all-around option for working with Postgres databases, you can use the client of your choice - see [Connect to a cluster](detail/connect_to_a_cluster) for more ideas. + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice. See [Connect to a cluster](detail/connect_to_a_cluster) for more ideas. ## Things to try @@ -90,7 +90,7 @@ We're going to create some sample math data, so we're going to create a database create database math with owner math; ``` -4. Connect to the `math` database. You are prompted for the `edb_admin` password you provided in Step 2 above. +4. Connect to the `math` database. You're prompted for the `edb_admin` password you provided in Step 2 above. ``` \connect math @@ -158,7 +158,7 @@ We're going to use temporary tables to calculate prime numbers using a [Sieve of WHERE num < 1000; ``` -You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed-up and can be restored any time before the end of the trial period. +You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed up and can be restored any time before the end of the trial period. ## Further reading From da3e2a8b1904100d81ec69c8ed8822bd28bf2c07 Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Thu, 31 Mar 2022 09:54:37 -0700 Subject: [PATCH 30/53] Clarify the intent of the section after creating a cluster --- .../docs/biganimal/release/free_trial/quickstart.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index db01475fd0b..700949a7318 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -35,13 +35,11 @@ Then, use your account to access the [BigAnimal portal](https://portal.biganimal 4. Select **AWS** for **Provider**. 5. Select **US East 1** for **Region**. 6. For **Instance Type** and **Storage**, only one set of options is available in the trial. Select each option. -7. Select **Create Cluster**. +7. Select **Create Cluster**. You'll be brought back to the Clusters page with your newly configured cluster now populating the list. It usually takes a minute or two for your cluster to be ready but can take up to an hour. A progress bar is shown near the right. -### Provisioning, active clusters, and deletion +### Managing your cluster -After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. - -Initially, the new cluster is being provisioned. This usually takes a minute or two but can take up to an hour. A progress bar is shown near the right. +After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. In the free trial, only one cluster may be provisioned at a time. That said, you may delete your cluster, start a new cluster and even restore a deleted cluster. BigAnimal automatically backs up clusters. Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. From 481bce85bde082ea1a7f939d83a6955893018150 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 31 Mar 2022 17:00:12 +0000 Subject: [PATCH 31/53] EDB style: minimize use of "power". Remove duplicate phrasing --- product_docs/docs/biganimal/release/free_trial/detail/index.mdx | 2 +- product_docs/docs/biganimal/release/free_trial/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx index 83531231a8a..f98d864e3bf 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx @@ -9,4 +9,4 @@ navigation: - experiment --- -The [Quick start](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the power that it provides. +The [Quick start](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the capabilities that it provides. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index 23f452f7ea0..b16fb67fc28 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -17,7 +17,7 @@ The free trial provides a subset of the full-featured BigAnimal environment so t ## What you get as part of the free trial - **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases.** - - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more powerful, more secure, more flexible, more secure, and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). + - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more flexible, more secure, and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). - [EDB Postgres Advanced Server 14](https://www.enterprisedb.com/docs/epas/latest/epas_rel_notes/) builds on PostgreSQL 14 with a host of features for Oracle database compatibility, security, and usability ([more on Oracle database compatibility](/epas/latest/epas_compat_ora_dev_guide/)). - **One active cluster, unlimited inactive ones.** From 877c629abd4f9e625aceccc8671f0fd88d9b532a Mon Sep 17 00:00:00 2001 From: Jon Ericson Date: Thu, 31 Mar 2022 10:03:19 -0700 Subject: [PATCH 32/53] Remove redundant paragraph --- product_docs/docs/biganimal/release/free_trial/quickstart.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index 700949a7318..2be01d280f2 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -156,8 +156,6 @@ We're going to use temporary tables to calculate prime numbers using a [Sieve of WHERE num < 1000; ``` -You've successfully created a BigAnimal free trial cluster. If you want to explore other configurations, feel free to delete your cluster and create a new one. During the free trial, all clusters are automatically backed up and can be restored any time before the end of the trial period. - ## Further reading Now that you've got the basics out of the way, see what else BigAnimal offers: From 4d1bf5261f0d0dd70186aea09a45bb9046ba7775 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 31 Mar 2022 17:52:15 +0000 Subject: [PATCH 33/53] link fixes --- .../free_trial/detail/experiment/backup_and_restore.mdx | 4 ++-- .../release/free_trial/detail/experiment/import_data.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx index be63498f95d..ee38df0e011 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx @@ -6,9 +6,9 @@ indexCards: none BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trial as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. -If you haven't already, [create a cluster](create_cluster_cli) on BigAnimal. For the free trial, you can have only one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. +If you haven't already, [create a cluster](../create_a_cluster/create_cluster_cli) on BigAnimal. For the free trial, you can have only one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. -We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball," which we will populate with some Major League Baseball statistics. +We're going to [add a database](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) called "baseball," which we will populate with some Major League Baseball statistics. ```sql create user baseball with password 'baseball_pwd'; diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx index 8c16ab5bb4e..14626028248 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx @@ -7,7 +7,7 @@ PostgreSQL includes a variety of ways to import data. Here, we'll show how to im For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. -We're going to [add a database]((/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application)) called "baseball," which we'll populate with some Major League Baseball statistics. +We're going to [add a database](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) called "baseball," which we'll populate with some Major League Baseball statistics. ```sql create user baseball with password 'baseball_pwd'; From 6a6513113c93dc7f8a244fe1d4741b3430b8746b Mon Sep 17 00:00:00 2001 From: nataliawojcik27 <90423028+nataliawojcik27@users.noreply.github.com> Date: Thu, 31 Mar 2022 14:32:18 -0400 Subject: [PATCH 34/53] minor-copy-changes-natalia Minor copy, punctuation and positioning changes --- .../docs/biganimal/release/free_trial/index.mdx | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index b16fb67fc28..e5a66076241 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -29,7 +29,7 @@ The free trial provides a subset of the full-featured BigAnimal environment so t | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | - | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 4 | + | Storage | Premium SSD disks P1 4Gi | GP3 Volume disk size 4 | | | | | - **Edit database configuration settings.** - **Connect to your cluster** via a public IP from psql, pgAdmin, or your favorite PostgreSQL-friendly application. @@ -38,20 +38,18 @@ The free trial provides a subset of the full-featured BigAnimal environment so t (Numerous other instance types, storage types, regions, customizations, and support options are available with a paid account.) -Get started with your trial by signing up for a free EDB account. - ## Create an account -If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). +TO get started with your free trial you'll need to [create an EDB account](detail/create_an_account). -Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gives you access to the BigAnimal trial, as well as EDB's training and software downloads. Accounts are free, and registration takes less than a minute. ## Create a cluster -The free trial allows anybody to create a database cluster hosted on BigAnimal to try for 14 days. While the trial allows only one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. +The free trial allows you to create a database cluster hosted on BigAnimal to try for 14 days. While the trial allows only one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. -BigAnimal offers both standard PostgreSQL and EnterpriseDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trail. +BigAnimal offers both standard PostgreSQL and EnterpriseDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trial. There are several equivalent ways to create a cluster: @@ -88,4 +86,4 @@ Within the BigAnimal Free Trial interface, a countdown displays the time remaini When the free trial ends, your account continues to exist, but your cluster and its backup and data are deleted. You can't transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. -We hope two weeks is enough time to give you a rough idea of what BigAnimal offers, but if you're interested in _really_ seeing it in action, we also offer a 30-day trial of the full product, running on your own Azure account with full access to all regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) \ No newline at end of file +We hope two weeks is enough time to give you a rough idea of what BigAnimal offers, but if you're interested in _really_ seeing it in action, we also offer an evaluation of the full product, with full access to regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) From 2a374624b41c0f8ea8fa752d64c863d33c5d2d7e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 31 Mar 2022 14:35:03 -0400 Subject: [PATCH 35/53] Minor edits to latest changes --- product_docs/docs/biganimal/release/free_trial/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx index 2be01d280f2..c6f5f9d557a 100644 --- a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -39,7 +39,7 @@ Then, use your account to access the [BigAnimal portal](https://portal.biganimal ### Managing your cluster -After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. In the free trial, only one cluster may be provisioned at a time. That said, you may delete your cluster, start a new cluster and even restore a deleted cluster. BigAnimal automatically backs up clusters. +After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. In the free trial, you can provision only one cluster at a time. That said, you can delete your cluster, start a new cluster, and even restore a deleted cluster. BigAnimal automatically backs up clusters. Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. From e0b36d7770f88caf3aaa1e3c07e19d6a1e68323b Mon Sep 17 00:00:00 2001 From: nataliawojcik27 <90423028+nataliawojcik27@users.noreply.github.com> Date: Thu, 31 Mar 2022 14:38:48 -0400 Subject: [PATCH 36/53] minor-copy-change-going-deeper-natalila Minor copy edits --- product_docs/docs/biganimal/release/free_trial/detail/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx index f98d864e3bf..f2e2e820b7b 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx @@ -9,4 +9,4 @@ navigation: - experiment --- -The [Quick start](../quickstart) presents one set of options to get you going quickly, but there are quite a few ways things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the capabilities that it provides. +The [Quick start](../quickstart) presents one way to get started, but there are quite a few things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the capabilities that it provides. From f2f354553e9b3a435ea884dbaeb47099d868f621 Mon Sep 17 00:00:00 2001 From: nataliawojcik27 <90423028+nataliawojcik27@users.noreply.github.com> Date: Thu, 31 Mar 2022 14:42:15 -0400 Subject: [PATCH 37/53] minor-copy-change-creating-cluster-natalia Clarifying copy tweak on Creating Cluster page --- .../release/free_trial/detail/create_a_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx index c9a644fc050..f422fc47cf6 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx @@ -4,7 +4,7 @@ description: "Creating a BigAnimal cluster from the portal or the command line" indexCards: none --- -The BigAnimal free trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully, it's quick and easy to [restore a cluster from backup](../experiment/backup_and_restore/). Backups are automatically created as soon as a cluster is used. +The BigAnimal free trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully, it's also quick and easy to [restore your deleted cluster from a backup](../experiment/backup_and_restore/) if you need to later on. Backups are automatically created as soon as a cluster is used. When you create a cluster, there are two flavors of PostgreSQL to choose from: From 322fecab861cae7c6e29082ec6364581f13a964a Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 31 Mar 2022 15:42:07 -0400 Subject: [PATCH 38/53] added link to quick start topic from full version BAFT topic --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index ef2d5463dd6..3f2f0ca35f7 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -4,6 +4,8 @@ title: BigAnimal free trial EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. +To get the most out of the free trial quickly, see [Quick start for the BigAnimal free trial](../free_trial/quickstart.mdx). + ## How to start your free trial You can request a BigAnimal free trial from several locations: - The EDB [Get started](https://www.enterprisedb.com/get-started) sign-up page From 1eec7447d9ad0530155a714f7a54523352dd369a Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Fri, 1 Apr 2022 04:24:22 +0000 Subject: [PATCH 39/53] use correct domain for BAFT cluster examples, flesh out output for CLI creation --- .../connect_using_psql.mdx | 2 +- .../create_a_cluster/create_cluster_cli.mdx | 66 +++++++++++++++++-- 2 files changed, 61 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx index c6e89e9cc8c..4c042193e6b 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -15,7 +15,7 @@ inspecting and managing the database that make light work of even complex tasks. You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's **Overview** tab on the portal. For example: ```shell -psql -W "postgres://edb_admin@p-h67q2yc7hq.mtstaging.s.edbcloud.io:5432/edb_admin?sslmode=require" +psql -W "postgres://edb_admin@p-xxxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require" ``` The URI is all that's necessary for psql. While you _can_ pass each element of that URL individually diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index ccc0c856d7c..721ffa29411 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -22,16 +22,36 @@ Next, you need to create a credential on BigAnimal. You can pick any username yo ```shell biganimal create-credential -a portal.biganimal.com -o 443 -n newuser +__OUTPUT__ +First, copy your one-time code: + CODE-CODE +Then visit: https://auth.biganimal.com/activate +press [Enter] to continue in the web browser... + +Credential "newuser" is created operation succeeded +Switched the context credential to "newuser". ``` +!!! Note Linux dependencies + The BigAnimal CLI uses the xdg-open utility to open a browser on Linux systems. + On minimal systems, you may need to install this dependency before creating a credential. + The command will direct you to open a webpage and copy the randomly generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. You can see the credentials you've verified on the command line. ```shell biganimal show-credentials +__OUTPUT__ +┌──────────────────────────────────────────────────────┐ +│ Credentials │ +├─────────┬─────────────────────────────────────┬──────┤ +│ name │ address │ port │ +├─────────┼─────────────────────────────────────┼──────┤ +│ newuser │ portal.biganimal.com │ 443 │ +└─────────┴─────────────────────────────────────┴──────┘ ``` !!! caution -If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option isn't needed. You can remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users don't need to add multiple credentials. +If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option isn't needed. You can change the default credential using `biganimal config set context_credential [name]` You can remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users don't need to add multiple credentials. !!! In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. @@ -40,14 +60,26 @@ Pick the region closest to you from the list provided by BigAnimal: ```shell biganimal show-regions +__OUTPUT__ +Use the arrow keys to navigate: ↓ ↑ +Provider ID? + AWS + ▸ Azure +┌───────────────────────────────────┐ +│ Regions │ +├────────────┬──────────────────────┤ +│ Region Id │ Region Name │ +├────────────┼──────────────────────┤ +│ eastus2 │ (US) East US 2 │ +│ westeurope │ (Europe) West Europe │ +└────────────┴──────────────────────┘ ``` -Other options can be queried via the CLI, but the only variable we need to set for this demo is . +Other options can be queried via the CLI, but the only value we need to set for this demo is the region Id. Edit a new file called `create_cluster.yaml`: ```yaml ---- clusterName: test_cluster # Pick a more meaningful name! password: mygoodpassword # Please change this password! postgresType: epas @@ -59,25 +91,47 @@ volumeProperties: P1 volumeType: azurepremiumstorage networking: public highAvailability: false ---- ``` Use the config file to create a new cluster: ```shell biganimal create-cluster --clusterConfigFile create_cluster.yaml +__OUTPUT__ +Are you sure you want to create cluster "test_cluster"? [y|n]: y +Create Cluster operation is started +Cluster ID is "p-xxxxxxxxxx" +To check current state, run: biganimal show-clusters --id p-xxxxxxxxxx ``` -If successful, the command will give you a command to check the status of your new cluster: +If successful, create-cluster will give you the ID of your new cluster (you'll use this to manage it) as well as +the command you can use to check the status of your new cluster: ```shell biganimal show-clusters --id p-xxxxxxxxxx +__OUTPUT__ +┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ Clusters │ +├──────────────┬──────────────┬───────────────────────────────────┬──────────┬────────────────┬───────────────┬──────────────────────────────┬─────────┤ +│ ID │ Name │ Status │ Provider │ Region │ Instance Type │ Postgres Type │ Version │ +├──────────────┼──────────────┼───────────────────────────────────┼──────────┼────────────────┼───────────────┼──────────────────────────────┼─────────┤ +│ p-xxxxxxxxxx │ test_cluster │ Cluster creation request received │ Azure │ (US) East US 2 │ E2s v3 │ EDB Postgres Advanced Server │ 14 │ +└──────────────┴──────────────┴───────────────────────────────────┴──────────┴────────────────┴───────────────┴──────────────────────────────┴─────────┘ ``` -The id is used to manage your cluster. It might take a few minutes to create your cluster. When it’s ready, you can get the connection string for your cluster: +It might take a few minutes to create your cluster. When it’s ready, +the Status column will change to "Cluster in healthy state". + +In the meantime, you can get the connection string for your cluster: ```shell biganimal show-cluster-connection --id p-xxxxxxxxxxx +__OUTPUT__ +┌──────────────────────────────────────────────────────────────────────────────────────────┐ +│ Connection String │ +├──────────────────────────────────────────────────────────────────────────────────────────┤ +│ postgres://edb_admin@p-xxxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require │ +└──────────────────────────────────────────────────────────────────────────────────────────┘ ``` Once the cluster is created, log in via psql. Use the password from the `config` file for edb_admin. From 8ec79bb6f334d0c0015145066dbc16b73ac2a0d7 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Fri, 1 Apr 2022 18:13:25 +0000 Subject: [PATCH 40/53] Address some comments from Jason --- .../detail/create_a_cluster/create_cluster_cli.mdx | 14 ++++---------- .../free_trial/detail/experiment/import_data.mdx | 6 ++++++ .../docs/biganimal/release/free_trial/index.mdx | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx index 721ffa29411..3fdb78d2d7d 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -5,17 +5,11 @@ indexCards: none --- -We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system finds executable files. If you have a Unix-style shell, your own `bin` directory is usually a good location. +We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system finds executable files (somewhere on your PATH). -```shell -mv biganimal $HOME/bin -``` - -It might also be necessary to give the executable proper permission: - -```shell -chmod +x $HOME/bin/biganimal -``` +!!! Note Linux and MacOS note + If you're on a Linux or MacOS system, you'll need to mark the `biganimal` file as executable by + running `chmod +x [/path/to/biganimal]` before you can use it. Next, you need to create a credential on BigAnimal. You can pick any username you prefer. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx index 14626028248..7b34eec728f 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx @@ -5,6 +5,12 @@ navTitle: "Import data" PostgreSQL includes a variety of ways to import data. Here, we'll show how to import a CSV file from the internet. +!!! Caution + Be careful when loading your own data in the Trial version and avoid storing sensitive information; trial clusters + are hosted in a shared environment. + + For a more comprehensive evaluation that runs under your own cloud account, [contact our Sales team](https://www.enterprisedb.com/contact). + For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. We're going to [add a database](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) called "baseball," which we'll populate with some Major League Baseball statistics. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx index e5a66076241..e00c580fa78 100644 --- a/product_docs/docs/biganimal/release/free_trial/index.mdx +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -49,7 +49,7 @@ Accounts are free, and registration takes less than a minute. The free trial allows you to create a database cluster hosted on BigAnimal to try for 14 days. While the trial allows only one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. -BigAnimal offers both standard PostgreSQL and EnterpriseDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trial. +BigAnimal offers both standard PostgreSQL and EDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trial. There are several equivalent ways to create a cluster: @@ -80,7 +80,7 @@ Since this is a free trial, there are a few nuances and limitations to what you - The BigAnimal free trial interface notes the features that aren't available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. -## What happens when the free trial ends +## What happens when the free trial ends? Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. From c26e0552af8358f3c913f5f5e3c3bb4a9ddc9d23 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Mon, 4 Apr 2022 05:30:35 +0000 Subject: [PATCH 41/53] Address a few of Jason's comments --- .../connect_using_dbeaver.mdx | 2 +- .../connect_using_pgadmin.mdx | 33 +------------------ .../create_cluster_portal.mdx | 2 +- 3 files changed, 3 insertions(+), 34 deletions(-) diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx index a6673725a5b..9d24b968057 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -27,7 +27,7 @@ indexCards: none 6. On the **PostgreSQL** tab, check the **Show all databases** check box. -7. Select the **Test connection** button and verify that DBeaver is able to connect to your cluster. +7. Select the **Test connection** button and verify that DBeaver can connect to your cluster. 8. Select **Finish** to save the connection. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx index 222e543190f..061aead708e 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -10,38 +10,7 @@ indexCards: none [The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage, and query your cluster's databases from a desktop or web UI. -A quick way to try out pgAdmin is to run it in a Docker container. With Docker installed, run: - -```shell -docker run -p 8000:80 \ - -e 'PGADMIN_DEFAULT_EMAIL=user@example.com' \ - -e 'PGADMIN_DEFAULT_PASSWORD=password' \ - -d dpage/pgadmin4 -__OUTPUT__ -Unable to find image 'dpage/pgadmin4:latest' locally -latest: Pulling from dpage/pgadmin4 -59bf1c3509f3: Already exists -34e720c4612b: Pull complete -8ef193cd122b: Pull complete -4377f1371242: Pull complete -9205bee41667: Pull complete -d5e36d286558: Pull complete -9c91d0528419: Pull complete -86e0602b566c: Pull complete -cf0d28491ace: Pull complete -198776d7d0ce: Pull complete -f7909c1938d8: Pull complete -9d477f4ed5d3: Pull complete -51c0f4ca201e: Pull complete -bc906010b44f: Pull complete -Digest: sha256:18cc2c7cce64b3f95b1ff13ec835da88c25b30d3745a02774abcd166379dae60 -Status: Downloaded newer image for dpage/pgadmin4:latest -99f4775629b1086b95601d659eae9dfe7125c4694a1a90891f840d12f8ca0261 -``` - -Once the command finishes, you can open the pgAdmin dashboard by visiting http://localhost:8000/ and then entering the email and password specified on the command line. - -From the welcome page, select **Add New Server**. You're prompted to configure the connection: +From the welcome page, select **Add New Server**. You'll be prompted to configure the connection. Enter `BigAnimal Trial` for the name (or use the name you gave to your cluster!), and then select **Connection**. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx index 744e11889b3..ffb521ab2dd 100644 --- a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -20,7 +20,7 @@ You should now find yourself at the [Create Cluster page](https://portal.biganim In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. -1. Use **Cluster Name** to describe the purpose of the cluster, e.g., "Test for Advanced Server on AWS." +1. Use **Cluster Name** to describe the purpose of the cluster. For example, "Test for Advanced Server on AWS." 2. **Password** is the admin password for the cluster, so pick a strong one! Note that this is independent of your EDB account. 3. **Database Type** is one of: From a5e8c6e0b38a90d7a5914a57197f3244859a9e2c Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Mon, 4 Apr 2022 05:47:05 +0000 Subject: [PATCH 42/53] Apply DeeDee's suggestion for cleaner index --- product_docs/docs/biganimal/release/index.mdx | 8 ++++++-- product_docs/docs/biganimal/release/overview/index.mdx | 2 -- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/biganimal/release/index.mdx b/product_docs/docs/biganimal/release/index.mdx index 587dfa67d65..36403438dd4 100644 --- a/product_docs/docs/biganimal/release/index.mdx +++ b/product_docs/docs/biganimal/release/index.mdx @@ -1,15 +1,15 @@ --- title: BigAnimal description: "BigAnimal: DBaaS for PostgresSQL " -indexCards: simple +indexCards: none hideVersion: true directoryDefaults: iconName: "logos/Biganimal" navigation: - - overview - "#Free Trial" - free_trial - "#Full Version" + - overview - getting_started - using_cluster - administering_cluster @@ -18,3 +18,7 @@ navigation: - reference --- + +BigAnimal is a fully managed database-as-a-service with built-in Oracle compatibility, running in your cloud account and operated by the Postgres experts. BigAnimal makes it easy to set up, manage, and scale your databases. Provision [PostgreSQL](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) or [EDB Postgres Advanced Server](https://www.enterprisedb.com/docs/epas/latest/) with Oracle compatibility. + +To sample BigAnimal, [get started with a free trial](/biganimal/latest/free_trial/). \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/overview/index.mdx b/product_docs/docs/biganimal/release/overview/index.mdx index df6be4c3991..84de73b868d 100644 --- a/product_docs/docs/biganimal/release/overview/index.mdx +++ b/product_docs/docs/biganimal/release/overview/index.mdx @@ -6,5 +6,3 @@ indexCards: simple BigAnimal is a fully managed database-as-a-service with built-in Oracle compatibility, running in your cloud account and operated by the Postgres experts. BigAnimal makes it easy to set up, manage, and scale your databases. Provision [PostgreSQL](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) or [EDB Postgres Advanced Server](https://www.enterprisedb.com/docs/epas/latest/) with Oracle compatibility. - -To sample BigAnimal, [get started with a free trial](/biganimal/latest/free_trial/). \ No newline at end of file From fa56d759c2bddae6c5addb740035d1a2dd2d1339 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 4 Apr 2022 16:25:44 +0530 Subject: [PATCH 43/53] Changed the release date for EDB*Plus and PEM --- product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx | 2 +- product_docs/docs/pem/8/pem_rel_notes/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx index be1ce21424d..40b7ba80e89 100644 --- a/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx @@ -11,5 +11,5 @@ The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 36 | Version | Release Date | | -------------------------------------- | ------------ | -| [36.0.2](edbplus3602_rel_notes.mdx) | 2022 Apr 05 | +| [36.0.2](edbplus3602_rel_notes.mdx) | 2022 Apr 04 | | [36.0.0](edbplus3600_rel_notes.mdx) | 2018 Nov 28 | \ No newline at end of file diff --git a/product_docs/docs/pem/8/pem_rel_notes/index.mdx b/product_docs/docs/pem/8/pem_rel_notes/index.mdx index 7aa8c30e6bc..784fc0a5603 100644 --- a/product_docs/docs/pem/8/pem_rel_notes/index.mdx +++ b/product_docs/docs/pem/8/pem_rel_notes/index.mdx @@ -6,7 +6,7 @@ The Postgres Enterprise Manager (PEM) documentation describes the latest version | Version | Release Date | Upstream Merges | Accessibility Conformance | | ------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- | -| [8.4.0](04_840_rel_notes) | 04 Apr 2022 | NA | [Conformance Report](https://www.enterprisedb.com/accessibility) | +| [8.4.0](04_840_rel_notes) | 01 Apr 2022 | NA | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.3.0](05_830_rel_notes) | 24 Nov 2021 | pgAdmin [5.7](https://www.pgadmin.org/docs/pgadmin4/5.7/release_notes_5_7.html#bug-fixes) | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.2.0](06_820_rel_notes) | 09 Sep 2021 | pgAdmin [5.4](https://www.pgadmin.org/docs/pgadmin4/5.4/release_notes_5_4.html#bug-fixes), [5.5](https://www.pgadmin.org/docs/pgadmin4/5.5/release_notes_5_5.html#bug-fixes), and [5.6](https://www.pgadmin.org/docs/pgadmin4/5.6/release_notes_5_6.html#bug-fixes) | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.1.1](07_811_rel_notes) | 22 Jul 2021 | NA | NA | From 63e0f4efdee66ddee2085316289b0075e80c82b8 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 8 Mar 2022 10:47:29 -0500 Subject: [PATCH 44/53] BigAnimal: UPM-4772 - AWS Free Trial --- .../release/getting_started/00_free_trial.mdx | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index 3f2f0ca35f7..d42684be506 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -14,10 +14,18 @@ You can request a BigAnimal free trial from several locations: ## What you can do with your free trial - The free trial lasts for 14 days. The count begins when you provision a cluster. -- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. -- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). - - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. - - Numerous other instance types, storage types, and regions are available with a paid account. +- You can provision a single cluster: + + | Cluster Details | On Azure | On AWS | + | --------------- | --------------------------------------------- | ----------------------------------------------------- | + | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | + | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | + | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD Volumes | + + Numerous other instance types, storage types, and regions are available with a paid account. + + If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. + - During the trial, you have access to EDB enterprise-level support. - You can connect to your database cluster. - You can edit the database configuration for a cluster and view the activity log for the service. @@ -27,6 +35,7 @@ You can request a BigAnimal free trial from several locations: Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. + - Backups are only retained for 30 days. - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. From bcd6ee7ca87c2f6c5183189b4bf648aee6336599 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 8 Mar 2022 13:39:57 -0500 Subject: [PATCH 45/53] added info about only using one provider per cluster --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index d42684be506..b4238a5ea2a 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -24,7 +24,9 @@ You can request a BigAnimal free trial from several locations: Numerous other instance types, storage types, and regions are available with a paid account. - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. + If you delete your cluster within the 14 day trial period, you can restore that cluster or create a new one. + + You can try out a different provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. - During the trial, you have access to EDB enterprise-level support. - You can connect to your database cluster. From 2b1f27bbc60d61a808ef174c0220a3c17f125b4e Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 8 Mar 2022 13:58:30 -0500 Subject: [PATCH 46/53] tweaked the table formatting added a bottom border --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index b4238a5ea2a..ad08a9704b1 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -21,6 +21,7 @@ You can request a BigAnimal free trial from several locations: | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD Volumes | + | | | | Numerous other instance types, storage types, and regions are available with a paid account. From f003b7aa447aa509de971ee04e6e7c61553d8bd8 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 8 Mar 2022 14:54:12 -0500 Subject: [PATCH 47/53] more tweaks to the format --- .../biganimal/release/getting_started/00_free_trial.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index ad08a9704b1..be607955506 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -23,11 +23,11 @@ You can request a BigAnimal free trial from several locations: | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD Volumes | | | | | - Numerous other instance types, storage types, and regions are available with a paid account. + - Numerous other instance types, storage types, and regions are available with a paid account. - If you delete your cluster within the 14 day trial period, you can restore that cluster or create a new one. + - If you delete your cluster within the 14 day trial period, you can restore that cluster or create a new one. - You can try out a different provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. + - You can try out a different provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. - During the trial, you have access to EDB enterprise-level support. - You can connect to your database cluster. From 2cc19630095216626077bf8e6d281b16f7662beb Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 10 Mar 2022 05:54:13 -0500 Subject: [PATCH 48/53] tweaked storage type --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index be607955506..a9e489239aa 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -20,7 +20,7 @@ You can request a BigAnimal free trial from several locations: | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | - | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD Volumes | + | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD P1 4Gi | | | | | - Numerous other instance types, storage types, and regions are available with a paid account. From 75da062630e24cb404b1c4fcd00713fba30d1873 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 15 Mar 2022 13:59:38 -0400 Subject: [PATCH 49/53] described configurable options for storage --- .../creating_a_cluster/index.mdx | 45 +++++++------------ .../release/overview/03a_region_support.mdx | 14 +++++- 2 files changed, 28 insertions(+), 31 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index ee0f9612078..bd8287a1275 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -13,19 +13,12 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y ## Create a cluster 1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. - 2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. - 3. On the **Create Cluster** page, specify the cluster settings on the following tabs: - - [**Cluster Info**](#cluster-info-tab) - - [**Operational Settings**](#operational-settings-tab) - - [**DB Configuration** ](#db-configuration-tab) (optional) - - [ **Availability** ](#availability-tab) (optional) - 4. Select **Create Cluster**. It might take a few minutes to deploy. !!! Note @@ -34,44 +27,36 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y ### Cluster Info tab 1. Enter the name for your cluster in the **Cluster Name** field. - 2. Enter a password for your cluster in the **Password** field. This is the password for the user edb_admin. - 3. Select **Next: Operational Settings**. ### Operational Settings tab 1. In the **Database Type** section: - 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. - - [*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 **Version** field, 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** field, select the cloud provider for your cluster. - -3. In the **Region** field, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as other resources you have that communicate with your cluster. - - For a list of available regions, see [Supported regions](../../overview/03a_region_support). - +3. In the **Region** field, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as other resources you have that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). 4. In the **Instance Type** section, - 1. Select the category that works best for your applications and workload: - - memory optimized for large data sets - - compute optimized for compute bound applications - - general purpose if you don't require memory or compute optimization - 1. Select the instance series and size. - - See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. + - For Azure + 1. Select the category that works best for your applications and workload: + - memory optimized for large data sets + - compute optimized for compute bound applications + - general purpose if you don't require memory or compute optimization + 1. Select the instance series and size. + See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. + - For AWS Free Trial + - The AWS Free Trial supports the RSA Large, vCPU 2, and 16 GB instance type. 5. In the **Storage** section, select **Volume Type**. In **Volume Properties**, select the type and amount of storage needed for your cluster. - !!! Note - BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. -6. In the **Networking** section, you 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 only allows access 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. + - For Azure + - BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. + - For AWS Free Trial + - The AWS Free Trial supports AWS GPS Volumes. You can select 1-4 as the size. IOPS is calculated based on the storage size you select and disk throughput is calculated based on the IOPS value. +6. In the **Networking** section, you 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 only allows access 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. Private networking allows only IP addresses within your private network to connect to your cluster. See [Cluster networking architecture](01_cluster_networking) for more information. - - 7. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**. ### DB Configuration tab diff --git a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx index b2a475d6e53..79f3d111a5f 100644 --- a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx +++ b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx @@ -1,7 +1,10 @@ --- title: "Supported regions" --- - When using Azure, you can create a cluster in the following regions: + +## Supported Azure regions + +When using Azure, you can create a cluster in the following regions: - North America (NA): - (Canada) Canada Central @@ -22,3 +25,12 @@ title: "Supported regions" - (Asia Pacific) Australia East - (Asia Pacific) Japan East - (Asia Pacific) South East Asia (Singapore) + +## Supported AWS regions for Free Trial + +When using the AWS Free Trial, you can create a cluster in the following regions: + +- North America (NA): + - US-East-1 (N. Virginia) +- Europe, Middle East, Africa (EMEA) + - EU-West-1 (Ireland) \ No newline at end of file From 5e74436db9fb3434e1ae91e10b37f422a51727b0 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 15 Mar 2022 14:43:15 -0400 Subject: [PATCH 50/53] free trial topic storage options updates --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index a9e489239aa..f45381dbc42 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -20,7 +20,7 @@ You can request a BigAnimal free trial from several locations: | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | - | Storage | Premium SSD disks P1 4Gi | GP3 General Purpose SSD P1 4Gi | + | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size P1-P4, IOPS and data throughput based on disk size | | | | | - Numerous other instance types, storage types, and regions are available with a paid account. From c4f293f733531580122c8d69c947cf444519fd57 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 17 Mar 2022 10:38:04 -0400 Subject: [PATCH 51/53] incorporated Natalia's feedback - open question on backup statement --- .../biganimal/release/getting_started/00_free_trial.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index f45381dbc42..cf885e29faf 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -14,20 +14,20 @@ You can request a BigAnimal free trial from several locations: ## What you can do with your free trial - The free trial lasts for 14 days. The count begins when you provision a cluster. -- You can provision a single cluster: +- You can provision a single cluster using either PostgreSQL or EDB Postgres Advanced Server: | Cluster Details | On Azure | On AWS | | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | - | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size P1-P4, IOPS and data throughput based on disk size | + | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 1-4 | | | | | - Numerous other instance types, storage types, and regions are available with a paid account. - If you delete your cluster within the 14 day trial period, you can restore that cluster or create a new one. - - You can try out a different provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. + - You can try out a different cloud provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. - During the trial, you have access to EDB enterprise-level support. - You can connect to your database cluster. @@ -39,7 +39,8 @@ Since this is a free trial, there are a few nuances and limitations to what you - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- Backups are only retained for 30 days. +- Backups are retained for 30 days. + - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends From e49ecc2d6a053cbd161c5d7c42304943aae8124d Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 17 Mar 2022 12:34:10 -0400 Subject: [PATCH 52/53] removed backup statement --- .../docs/biganimal/release/getting_started/00_free_trial.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index cf885e29faf..d40d21ea0d0 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -39,8 +39,6 @@ Since this is a free trial, there are a few nuances and limitations to what you - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- Backups are retained for 30 days. - - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends From 3f2a89794f518cb39344399d03c0ee6dd7616489 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 24 Mar 2022 14:15:07 -0400 Subject: [PATCH 53/53] changed size to 4, not 1-4 - removed FT details from Creating a cluster --- .../release/getting_started/00_free_trial.mdx | 2 +- .../creating_a_cluster/index.mdx | 30 +++++++++++-------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index d40d21ea0d0..b37a78c5d23 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -20,7 +20,7 @@ You can request a BigAnimal free trial from several locations: | --------------- | --------------------------------------------- | ----------------------------------------------------- | | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | - | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 1-4 | + | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 4 | | | | | - Numerous other instance types, storage types, and regions are available with a paid account. diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index bd8287a1275..52aebab0672 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -13,9 +13,11 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y ## Create a cluster 1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. + 2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. 3. On the **Create Cluster** page, specify the cluster settings on the following tabs: - [**Cluster Info**](#cluster-info-tab) + - [**Operational Settings**](#operational-settings-tab) - [**DB Configuration** ](#db-configuration-tab) (optional) - [ **Availability** ](#availability-tab) (optional) @@ -27,33 +29,35 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y ### Cluster Info tab 1. Enter the name for your cluster in the **Cluster Name** field. + 2. Enter a password for your cluster in the **Password** field. This is the password for the user edb_admin. 3. Select **Next: Operational Settings**. ### Operational Settings tab 1. In the **Database Type** section: + 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. + - [*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 **Version** field, 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** field, select the cloud provider for your cluster. 3. In the **Region** field, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as other resources you have that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). 4. In the **Instance Type** section, - - For Azure - 1. Select the category that works best for your applications and workload: - - memory optimized for large data sets - - compute optimized for compute bound applications - - general purpose if you don't require memory or compute optimization - 1. Select the instance series and size. - See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. - - For AWS Free Trial - - The AWS Free Trial supports the RSA Large, vCPU 2, and 16 GB instance type. + 1. Select the category that works best for your applications and workload: + - memory optimized for large data sets + + - compute optimized for compute bound applications + - general purpose if you don't require memory or compute optimization + + 1. Select the instance series and size. + + See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. 5. In the **Storage** section, select **Volume Type**. In **Volume Properties**, select the type and amount of storage needed for your cluster. - - For Azure - - BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. - - For AWS Free Trial - - The AWS Free Trial supports AWS GPS Volumes. You can select 1-4 as the size. IOPS is calculated based on the storage size you select and disk throughput is calculated based on the IOPS value. + !!! Note + BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. 6. In the **Networking** section, you 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 only allows access 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. Private networking allows only IP addresses within your private network to connect to your cluster. See [Cluster networking architecture](01_cluster_networking) for more information.