From b4b30dcb7a6e45535f459ea83fa4b904a84a01f9 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Wed, 10 Apr 2024 10:03:50 +0100 Subject: [PATCH 1/2] DOCS-350 belt and braces changes for installer Signed-off-by: Dj Walker-Morgan --- .../docs/pgd/5/cli/installing_cli.mdx | 48 +++++++++++++++++-- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/pgd/5/cli/installing_cli.mdx b/product_docs/docs/pgd/5/cli/installing_cli.mdx index df6e72ce0f0..a1f9b4e3412 100644 --- a/product_docs/docs/pgd/5/cli/installing_cli.mdx +++ b/product_docs/docs/pgd/5/cli/installing_cli.mdx @@ -1,6 +1,7 @@ --- title: "Installing PGD CLI" navTitle: "Installing PGD CLI" +deepToC: true --- You can install PGD CLI on any system that can connect to the PGD cluster. To use PGD CLI, you need a user with PGD superuser privileges or equivalent. The PGD user with superuser privileges is the [bdr_superuser role](../security). An example of an equivalent user is edb_admin on an EDB BigAnimal distributed high-availability cluster. @@ -13,22 +14,59 @@ By default, Trusted Postgres Architect installs and configures PGD CLI on each P PGD CLI is installable from the EDB repositories, which you can access with your EDB account. PGD users and BigAnimal users, including those on a free trial, have an EDB account and access to PGD CLI. - These repositories require a token to enable downloads from them. To obtain your token, log in to [EDB Repos 2.0](https://www.enterprisedb.com/repos-downloads). If this is your first time visiting the EDB Repos 2.0 page, you must select **Request Access** to generate your token. Once a generated token is available, select the **Copy** icon to copy it to your clipboard, or select the eye icon to view it. +### Obtain your EDB subscription token +These repositories require a token to enable downloads from them. To obtain your token, log in to [EDB Repos 2.0](https://www.enterprisedb.com/repos-downloads). If this is your first time visiting the EDB Repos 2.0 page, you must select **Request Access** to generate your token. Once a generated token is available, select the **Copy** icon to copy it to your clipboard, or select the eye icon to view it. + +### Set the EDB_SUBSCRIPTION_TOKEN environment variable Once you have the token, execute the command shown for your operating system, substituting your token for ``. -### Add repository and install PGD CLI on Debian or Ubuntu +``` +export EDB_SUBSCRIPTION_TOKEN= +``` + +Then run the appropriate commands for your operating system + +### Install on Debian or Ubuntu ```bash -curl -1sLf 'https://downloads.enterprisedb.com//postgres_distributed/setup.deb.sh' | sudo -E bash +curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/postgres_distributed/setup.deb.sh" | sudo -E bash +``` + +If this returns an error like `curl: (22) The requested URL returned error: 404`, check that you have entered the correct token. + +When successful, you will see output like this: + +``` +Executing the setup script for the 'enterprisedb/postgres_distributed' repository ... +... +``` + +You can now install the PGD CLI package using the command: + +``` sudo apt-get install edb-pgd5-cli ``` -### Add repository and install PGD CLI on RHEL, Rocky, AlmaLinux, or Oracle Linux +### Install on RHEL, Rocky, AlmaLinux, or Oracle Linux ```bash -curl -1sLf 'https://downloads.enterprisedb.com//postgres_distributed/setup.rpm.sh' | sudo -E bash +curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/postgres_distributed/setup.rpm.sh" | sudo -E bash +``` + +If this returns an error like `curl: (22) The requested URL returned error: 404`, check that you have entered the correct token. + +When successful, you will see output like this: + +``` +Executing the setup script for the 'enterprisedb/postgres_distributed' repository ... +... +``` + +You can now install the PGD CLI package using the command: + +``` sudo yum install edb-pgd5-cli ``` From e0fe2fbfa62ff1d0fa12fbf8aad5d3dd72d6f651 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Thu, 11 Apr 2024 15:08:45 +0100 Subject: [PATCH 2/2] Fix section presentation Signed-off-by: Dj Walker-Morgan --- product_docs/docs/pgd/5/cli/installing_cli.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/cli/installing_cli.mdx b/product_docs/docs/pgd/5/cli/installing_cli.mdx index a1f9b4e3412..115fcf26033 100644 --- a/product_docs/docs/pgd/5/cli/installing_cli.mdx +++ b/product_docs/docs/pgd/5/cli/installing_cli.mdx @@ -26,7 +26,7 @@ your token for ``. export EDB_SUBSCRIPTION_TOKEN= ``` -Then run the appropriate commands for your operating system +Then run the appropriate commands for your operating system: ### Install on Debian or Ubuntu