Merge pull request #4269 from EnterpriseDB/release/2023-06-20

Release: 2023-06-20

install_template/templates/platformBase/base.njk

@@ -13,12 +13,30 @@ title: Installing {{ product.name }} on {{ platform.name }} {{ platform.arch }}
 
 Before you begin the installation process:
 {% block product_prerequisites %}
-- Set up the repository
+- Set up the EDB repository
 
-  Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. 
+  Setting up the repository is a one-time task. If you have already set up your repository, you don't need to perform this step.
+
+  To determine if your repository exists, enter this command: 
+
+  {%- filter indent(2) -%}
+   {% block repocheck %} {# Any changes to this block should be replicated for Debian, Ubuntu, and SLES #}
+
+  `dnf repolist | grep enterprisedb`
+  {% endblock repocheck %}
+  If no output is generated, the repository isn't installed. 
+  {%- endfilter %}
+
+  To set up the EDB repository:
+
+  1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads). 
+
+  1. Select the button that provides access to the EDB repo. 
+
+  1. Select the platform and software that you want to download.   
 
-  To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there.
 {% endblock product_prerequisites %}
+
 {% block prerequisites %}{% endblock prerequisites %}
 ## Install the package
 {% block installCommand %}

install_template/templates/platformBase/debian.njk

@@ -1,6 +1,11 @@
 {% extends "platformBase/base.njk" %}
 {% set packageManager = "apt-get" %}
 {% set packageManagerNoninteractive = "-y" %}
+{% block repocheck %}  
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}
+
 {% block installCommand %}
 ```shell
 sudo {{ packageManager }} {{ packageManagerNoninteractive }} install {{ packageName }}

install_template/templates/platformBase/sles-12.njk

@@ -1,6 +1,10 @@
 {% extends "platformBase/base.njk" %}
 {% set packageManager = "zypper" %}
 {% set packageManagerNoninteractive = "-n" %}
+{% block repocheck %}
+
+`zypper lr -E | grep enterprisedb`
+{% endblock repocheck %}
 {% block prerequisites %}
 {% block other_platform_prerequesites_shell %}{% endblock other_platform_prerequesites_shell %}
 - Activate the required SUSE module

install_template/templates/platformBase/ubuntu.njk

@@ -2,6 +2,10 @@
 {% set packageManager = "apt-get" %}
 {% set packageManagerNoninteractive = "-y" %}
 {% block prerequisites %}{% endblock prerequisites %}
+{% block repocheck %}
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}
 {% block installCommand %}
 ```shell
 sudo {{ packageManager }} {{ packageManagerNoninteractive }} install {{ packageName }}

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

@@ -11,6 +11,7 @@ deployPath: epas/{{ product.version }}/installing/linux_{{platform.arch}}/epas_{
 redirects:
   - epas/{{ product.version }}/epas_inst_linux/installing_epas_using_edb_repository/{{deploy.expand_arch[platform.arch]}}/epas_{{deploy.map_platform_old[platform.name]}}_{{platform.arch | replace(r/_?64/g, "")}}.mdx
 {% endblock frontmatter %}
+{% block postgresqlalternative %}{% endblock postgresqlalternative %}
 
 {% block installCommand %}
 {{super()}}{% block slesoption %}

install_template/templates/products/migration-toolkit/base.njk

@@ -11,6 +11,7 @@ deployPath: migration_toolkit/{{ product.version }}/installing/linux_{{platform.
 redirects:
   - migration_toolkit/{{ product.version }}/05_installing_mtk/install_on_linux/{{deploy.expand_arch[platform.arch]}}/mtk55_{{deploy.map_platform_old[platform.name]}}_{{platform.arch | replace(r/_?64/g, "")}}.mdx
 {% endblock frontmatter %}
+{% block postgresqlalternative %}{% endblock postgresqlalternative %}
 
 {% block postinstall %}
 ## Initial configuration

install_template/templates/products/mysql-foreign-data-wrapper/base.njk

@@ -12,6 +12,7 @@ deployPath: mysql_data_adapter/{{ product.version }}/installing/linux_{{platform
 redirects:
   - mysql_data_adapter/{{ product.version }}/04_installing_the_mysql_data_adapter/{{deploy.expand_arch[platform.arch]}}/mysql_{{deploy.map_platform_old[platform.name]}}_{{platform.arch | replace(r/_?64/g, "")}}.mdx
 {% endblock frontmatter %}
+{% block postgresqlalternative %}{% endblock postgresqlalternative %}
 
 {% block product_prerequisites %}{% include "platformBase/_epasinstallsameserver.njk" %}
 {{ super() }}

install_template/templates/products/postgres-enterprise-manager-agent/base.njk

@@ -11,6 +11,7 @@ deployPath: pem/{{ product.version }}/installing_pem_agent/linux_{{platform.arch
 redirects:
   - pem/{{ product.version }}/installing_pem_agent/installing_on_linux/{{deploy.expand_arch[platform.arch]}}/pem_agent_{{deploy.map_platform_old[platform.name]}}_{{platform.arch | replace(r/_?64/g, "")}}.mdx
 {% endblock frontmatter %}
+{% block postgresqlalternative %}{% endblock postgresqlalternative %}
 
 {% block installCommand %}
 {{super()}}

install_template/templates/products/postgres-enterprise-manager-server/base.njk

@@ -13,18 +13,35 @@ redirects:
 {% endblock frontmatter %}
 
 {% block product_prerequisites %}
-{{ super() | replace("To set up the", "- To set up the EDB")}}
+- Set up the repository
+
+  Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. 
+  {%- filter indent(2) -%}
+  {% block repocheck %}
+  To determine if your repository exists, enter this command: 
+
+  `dnf repolist | grep enterprisedb`
+  {% endblock repocheck %}
+  {%- endfilter %}
+
+  - To set up the EDB repository:
 
-  - To set up the PostgreSQL community repository, go to [yum](https://www.postgresql.org/download/linux/redhat/) or [apt](https://wiki.postgresql.org/wiki/Apt).
+    1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads). 
+
+    1. Select the button that provides access to the EDB repo. 
+
+    1. Select the platform and software that you want to download.  
 
-  !!! Note
-  The PostgreSQL community repository is required only if you are using PostgreSQL as the backend database for PEM server.
-  !!!
+  -  To set up the PostgreSQL community repository, go to the [downloads page for PostgreSQL](https://www.postgresql.org/download/).
+
+     !!! Note
+
+     The PostgreSQL community repository is required only if you are using PostgreSQL as the backend database for PEM server.
 
 - Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/installing/) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/).
 
 - Review [configuration and authentication requirements](../prerequisites/) for PEM.
-  
+
 {% endblock product_prerequisites %}
 {% block postinstall %}
 ## Initial configuration

install_template/templates/products/postgres-enterprise-manager-server/debian-10.njk

@@ -1,2 +1,7 @@
 {% extends "products/postgres-enterprise-manager-server/base.njk" %}
-{% set platformBaseTemplate = "debian-10" %}
+{% set platformBaseTemplate = "debian-10" %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/debian-11.njk

@@ -1,2 +1,7 @@
 {% extends "products/postgres-enterprise-manager-server/base.njk" %}
-{% set platformBaseTemplate = "debian-11" %}
+{% set platformBaseTemplate = "debian-11" %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/sles-12.njk

@@ -6,3 +6,8 @@
     Postgres Enterprise Manager 8.3 and later is supported on SLES.
 
 {% endblock introductory_notes %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`zypper lr -E | grep enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/sles-15.njk

@@ -12,3 +12,8 @@ sudo SUSEConnect -p PackageHub/15.3/{{ platform.arch }}
 # You can use SLES 15 SP4 for PEM 8.6 and later:
 sudo SUSEConnect -p PackageHub/15.4/{{ platform.arch }}
 {% endblock activateSUSEmodule %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`zypper lr -E | grep enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/ubuntu-18.04.njk

@@ -1,2 +1,7 @@
 {% extends "products/postgres-enterprise-manager-server/base.njk" %}
 {% set platformBaseTemplate = "ubuntu-18.04" %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/ubuntu-20.04.njk

@@ -1,2 +1,7 @@
 {% extends "products/postgres-enterprise-manager-server/base.njk" %}
 {% set platformBaseTemplate = "ubuntu-20.04" %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/postgres-enterprise-manager-server/ubuntu-22.04.njk

@@ -1,2 +1,7 @@
 {% extends "products/postgres-enterprise-manager-server/base.njk" %}
-{% set platformBaseTemplate = "ubuntu-22.04" %}
+{% set platformBaseTemplate = "ubuntu-22.04" %}
+{% block repocheck %}
+To determine if your repository exists, enter this command: 
+
+`apt-cache search enterprisedb`
+{% endblock repocheck %}

install_template/templates/products/replication-server/base.njk

@@ -11,6 +11,7 @@ deployPath: eprs/{{ product.version }}/installing/linux_{{platform.arch}}/eprs_{
 redirects:
   - eprs/{{ product.version }}/03_installation/03_installing_rpm_package/{{deploy.expand_arch[platform.arch]}}/eprs_{{deploy.map_platform_old[platform.name]}}_{{platform.arch | replace(r/_?64/g, "")}}.mdx
 {% endblock frontmatter %}
+{% block postgresqlalternative %}{% endblock postgresqlalternative %}
 
 {% block installCommand %}
 You can install all Replication Server components with a single install command, or you may choose to install selected, individual components by installing only those particular packages.

product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx

@@ -15,6 +15,9 @@ With multiple projects within an organization you can:
 
 To access a BigAnimal organization, first each user needs to be added to the organization's identity provider. For more information, see [Setting up your identity provider](/biganimal/latest/getting_started/identity_provider/). Your identity provider establishes the identity of users that can log in to BigAnimal. 
 
+!!! Note
+    You can invite people to your organization by copying a link from the Users page in the BigAnimal portal and sending it to their email. They'll need to create an EDB account if they don't have one already.
+
 Once a user has logged in to BigAnimal, you can assign them a role. 
 
 ## Organization level roles
@@ -77,7 +80,6 @@ The following roles grant privileges within a project:
 
 Organization owners can assign users organization-level roles to complete certain tasks:
 
-
 1.  Select **User Management** from the menu next to your organization name in the top right of the portal.
 
 2.  Select the edit icon for the user.

product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx

@@ -3,6 +3,9 @@ title: Managing Superset access
 description: "Control access to Superset data sources using Superset roles and permissions"
 ---
 
+!!!note
+   If you're using BigAnimal's cloud account, you don't have access to Superset.
+
 You control access to Superset data sources by using Superset roles and permissions. 
 
 Superset has three roles mapped to BigAnimal roles:

product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx

@@ -10,7 +10,7 @@ navigation:
 
 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. 
+You can connect to BigAnimal clusters as you would any other Postgres database. 
 
 You can find all of the parameters you need to connect 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.
 

product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx

@@ -24,15 +24,7 @@ chmod +x $HOME/bin/biganimal
 Next, you need to create a credential on BigAnimal. You can pick any username you prefer.
 
 ```shell
-biganimal credential create- -a portal.biganimal.com -o 443 -n newuser
-__OUTPUT__
-? Freetrial:  [Use arrows to move, type to filter]
-> Yes
-  No
-```
-Select `Yes`.
-
-```
+biganimal credential create -n newuser
 __OUTPUT__
 Visit this URL to login: https://auth.biganimal.com/activate?user_code=XXXX-XXXX
 or press [Enter] to continue in the web browser 
@@ -61,61 +53,25 @@ __OUTPUT__
 !!! Note Caution
     If you add another credential, the newly created credential will be set as the new default context credential. You’ll need to add `--credential [newuser]` to the following commands to override the default credentials. If you have only one, the option isn't needed. You can change the default credential using `biganimal config set context_credential [name]`.
 
-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:
+Use the `biganimal region show` command to see the available active regions you can pick from for your cluster.
 
-```shell
-biganimal region show
-__OUTPUT__
-Use the arrow keys to navigate: ↓ ↑
-? Provider:  [Use arrows to move, type to filter]
-> All
-  AWS
-  Azure
-```
-Select `Azure`.
-
-```
-__OUTPUT__
-? Status:  [Use arrows to move, type to filter]
-> All
-  Active
-  Inactive
-  Suspended
-  Error
-```
-Select `Active`.
-
-```
-__OUTPUT__
-┌───────────────────────────────────────────────────────────────────────────┐
-│ Regions                                                                   │
-├─────────────┬──────────────────┬────────────┬─────────────┬───────────────┤
-│ Provider Id │ Region Continent │ Region Id  │ Region Name │ Region Status │
-├─────────────┼──────────────────┼────────────┼─────────────┼───────────────┤
-│ azure       │ Europe           │ westeurope │ West Europe │ ACTIVE        │
-│ azure       │ North America    │ eastus2    │ East US 2   │ ACTIVE        │
-└─────────────┴──────────────────┴────────────┴─────────────┴───────────────┘
-```
-
-Other options can be queried by using 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!
-clusterArchitecture: single
-postgresType: epas
-postgresVersion: "15"
-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
+clusterName: test_cluster # or a name of your choosing
+password: 
+clusterArchitecture: 
+postgresType: 
+postgresVersion: 
+provider: 
+region:  # Select from the options given by the `region show` command
+instanceType: 
+volumeProperties: 
+volumeType: 
+networking: 
+highAvailability:
 ```
 
 Use the config file to create a new cluster:
@@ -125,7 +81,10 @@ biganimal cluster create --config-file create_cluster.yaml
 __OUTPUT__
 Are you sure you want to create cluster "test_cluster"? [y|N]: 
 ```
-Select `y`.
+Select `y`. 
+
+If successful, `cluster create` 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. 
 
 ```
 __OUTPUT__
@@ -134,8 +93,7 @@ Cluster ID is "p-xxxxxxxxxx"
 To check current state, run: biganimal cluster show --id p-xxxxxxxxxx
 ```
 
-If successful, `cluster create` 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:
+Here's example output from the `cluster show` command:
 
 ```shell
 biganimal cluster show --id p-xxxxxxxxxx
@@ -145,15 +103,15 @@ __OUTPUT__
 ├──────────────┬──────────────┬──────────┬──────────────┬───────────────────────────────────┬─────────────┬───────────────┬──────────────────────────────────┬────────────────────┬────────────┤
 │ ID           │ Name         │ Provider │ Architecture │ Status                            │ Region      │ Instance Type │ Postgres Details                 │ Maintenance Window │ FAReplicas │
 ├──────────────┼──────────────┼──────────┼──────────────┼───────────────────────────────────┼─────────────┼───────────────┼──────────────────────────────────┼────────────────────┼────────────┤
-│ p-ng49wmjswh │ test_cluster │ Azure    │ single       │ Cluster creation request received │ East US 2   │ E2s v3        │ EDB Postgres Advanced Server v15 │ Disabled           │ N/A        │
+│ p-xxxxxxxxxx │ test_cluster │ Azure    │ single       │ Cluster creation request received │ East US 2   │ E2s v3        │ EDB Postgres Advanced Server v15 │ Disabled           │ N/A        │
 │              │              │          │              │                                   │             │               │                                  │                    │            │
 └──────────────┴──────────────┴──────────┴──────────────┴───────────────────────────────────┴─────────────┴───────────────┴──────────────────────────────────┴────────────────────┴────────────┘
 ```
 
 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:
+In the meantime, you can get the connection string for your cluster. For example:
 
 ```shell
 biganimal cluster show-connection --id p-xxxxxxxxxxx