From b4cfda78c497d8f44cb982278aec09287b40ecb4 Mon Sep 17 00:00:00 2001 From: Simon Notley <43099400+sonotley@users.noreply.github.com> Date: Wed, 17 Apr 2024 17:10:34 +0100 Subject: [PATCH 1/8] Add table of metric names for 3PM integrations --- .../third_party_integrations/index.mdx | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index 78775c40188..04b605aafea 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -14,3 +14,103 @@ The third-party integrations available in BigAnimal are: - [Datadog](./datadog) - [New Relic](./newrelic) + +## Metric naming + +When metrics from BigAnimal are exported to third-party monitoring services, they are renamed in accordance with the naming conventions of the target platform. + +The name below provides a mapping between [BigAnimal metric names](/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx) +and the name that metric will be assigned when exported to a third-party services. + +!!! Note Kubernetes metrics +In addition to the metrics listed below, which pertain to the Postgres instances, BigAnimal also exports metrics from the underlying Kubernetes infrastructure. These are prefixed with `k8s.`. +!!! + +| BigAnimal metric name | Metric name for third-party integrations | +| ------------------------------------------------ | --------------------------------------------------------- | +| cnp_pg_backends_waiting_total | postgres.raw.backends_waiting_total | +| cnp_pg_database_size_bytes | postgres.raw.pg_database_size_bytes | +| cnp_pg_database_xid_age | postgres.raw.pg_database_xid_age | +| cnp_pg_database_mxid_age | postgres.raw.pg_database_mxid_age | +| cnp_pg_postmaster_start_time | postgres.raw.pg_postmaster_start_time | +| cnp_pg_replication_lag | postgres.raw.pg_replication_lag | +| cnp_pg_replication_in_recovery | postgres.raw.pg_replication_in_recovery | +| cnp_pg_replication_slots_active | postgres.raw.pg_replication_slots_active | +| cnp_pg_replication_slots_pg_wal_lsn_diff | postgres.raw.pg_replication_slots_pg_wal_lsn_diff | +| cnp_pg_stat_archiver_archived_count | postgres.raw.pg_stat_archiver_archived_count | +| cnp_pg_stat_archiver_failed_count | postgres.raw.pg_stat_archiver_failed_count | +| cnp_pg_stat_archiver_seconds_since_last_archival | postgres.raw.pg_stat_archiver_seconds_since_last_archival | +| cnp_pg_stat_archiver_seconds_since_last_failure | postgres.raw.pg_stat_archiver_seconds_since_last_failure | +| cnp_pg_stat_archiver_last_archived_time | postgres.raw.pg_stat_archiver_last_archived_time | +| cnp_pg_stat_archiver_last_failed_time | postgres.raw.pg_stat_archiver_last_failed_time | +| cnp_pg_stat_archiver_last_archived_wal_start_lsn | postgres.raw.pg_stat_archiver_last_archived_wal_start_lsn | +| cnp_pg_stat_archiver_last_failed_wal_start_lsn | postgres.raw.pg_stat_archiver_last_failed_wal_start_lsn | +| cnp_pg_stat_archiver_stats_reset_time | postgres.raw.pg_stat_archiver_stats_reset_time | +| cnp_pg_stat_bgwriter_checkpoints_timed | postgres.raw.pg_stat_bgwriter_checkpoints_timed | +| cnp_pg_stat_bgwriter_checkpoints_req | postgres.raw.pg_stat_bgwriter_checkpoints_req | +| cnp_pg_stat_bgwriter_checkpoint_write_time | postgres.raw.pg_stat_bgwriter_checkpoint_write_time | +| cnp_pg_stat_bgwriter_checkpoint_sync_time | postgres.raw.pg_stat_bgwriter_checkpoint_sync_time | +| cnp_pg_stat_bgwriter_buffers_checkpoint | postgres.raw.pg_stat_bgwriter_buffers_checkpoint | +| cnp_pg_stat_bgwriter_buffers_clean | postgres.raw.pg_stat_bgwriter_buffers_clean | +| cnp_pg_stat_bgwriter_maxwritten_clean | postgres.raw.pg_stat_bgwriter_maxwritten_clean | +| cnp_pg_stat_bgwriter_buffers_backend | postgres.raw.pg_stat_bgwriter_buffers_backend | +| cnp_pg_stat_bgwriter_buffers_backend_fsync | postgres.raw.pg_stat_bgwriter_buffers_backend_fsync | +| cnp_pg_stat_bgwriter_buffers_alloc | postgres.raw.pg_stat_bgwriter_buffers_alloc | +| cnp_pg_stat_database_xact_commit | postgres.raw.pg_stat_database_xact_commit | +| cnp_pg_stat_database_xact_rollback | postgres.raw.pg_stat_database_xact_rollback | +| cnp_pg_stat_database_blks_read | postgres.raw.pg_stat_database_blks_read | +| cnp_pg_stat_database_blks_hit | postgres.raw.pg_stat_database_blks_hit | +| cnp_pg_stat_database_tup_returned | postgres.raw.pg_stat_database_tup_returned | +| cnp_pg_stat_database_tup_fetched | postgres.raw.pg_stat_database_tup_fetched | +| cnp_pg_stat_database_tup_inserted | postgres.raw.pg_stat_database_tup_inserted | +| cnp_pg_stat_database_tup_updated | postgres.raw.pg_stat_database_tup_updated | +| cnp_pg_stat_database_tup_deleted | postgres.raw.pg_stat_database_tup_deleted | +| cnp_pg_stat_database_conflicts | postgres.raw.pg_stat_database_conflicts | +| cnp_pg_stat_database_temp_files | postgres.raw.pg_stat_database_temp_files | +| cnp_pg_stat_database_temp_bytes | postgres.raw.pg_stat_database_temp_bytes | +| cnp_pg_stat_database_deadlocks | postgres.raw.pg_stat_database_deadlocks | +| cnp_pg_stat_database_blk_read_time | postgres.raw.pg_stat_database_blk_read_time | +| cnp_pg_stat_database_blk_write_time | postgres.raw.pg_stat_database_blk_write_time | +| cnp_pg_stat_database_conflicts_confl_tablespace | postgres.raw.pg_stat_database_conflicts_confl_tablespace | +| cnp_pg_stat_database_conflicts_confl_lock | postgres.raw.pg_stat_database_conflicts_confl_lock | +| cnp_pg_stat_database_conflicts_confl_snapshot | postgres.raw.pg_stat_database_conflicts_confl_snapshot | +| cnp_pg_stat_database_conflicts_confl_bufferpin | postgres.raw.pg_stat_database_conflicts_confl_bufferpin | +| cnp_pg_stat_database_conflicts_confl_deadlock | postgres.raw.pg_stat_database_conflicts_confl_deadlock | +| cnp_pg_stat_user_tables_seq_scan | postgres.raw.pg_stat_user_tables_seq_scan | +| cnp_pg_stat_user_tables_seq_tup_read | postgres.raw.pg_stat_user_tables_seq_tup_read | +| cnp_pg_stat_user_tables_idx_scan | postgres.raw.pg_stat_user_tables_idx_scan | +| cnp_pg_stat_user_tables_idx_tup_fetch | postgres.raw.pg_stat_user_tables_idx_tup_fetch | +| cnp_pg_stat_user_tables_n_tup_ins | postgres.raw.pg_stat_user_tables_n_tup_ins | +| cnp_pg_stat_user_tables_n_tup_upd | postgres.raw.pg_stat_user_tables_n_tup_upd | +| cnp_pg_stat_user_tables_n_tup_del | postgres.raw.pg_stat_user_tables_n_tup_del | +| cnp_pg_stat_user_tables_n_tup_hot_upd | postgres.raw.pg_stat_user_tables_n_tup_hot_upd | +| cnp_pg_stat_user_tables_n_live_tup | postgres.raw.pg_stat_user_tables_n_live_tup | +| cnp_pg_stat_user_tables_n_dead_tup | postgres.raw.pg_stat_user_tables_n_dead_tup | +| cnp_pg_stat_user_tables_n_mod_since_analyze | postgres.raw.pg_stat_user_tables_n_mod_since_analyze | +| cnp_pg_stat_user_tables_last_vacuum | postgres.raw.pg_stat_user_tables_last_vacuum | +| cnp_pg_stat_user_tables_last_autovacuum | postgres.raw.pg_stat_user_tables_last_autovacuum | +| cnp_pg_stat_user_tables_last_analyze | postgres.raw.pg_stat_user_tables_last_analyze | +| cnp_pg_stat_user_tables_last_autoanalyze | postgres.raw.pg_stat_user_tables_last_autoanalyze | +| cnp_pg_stat_user_tables_vacuum_count | postgres.raw.pg_stat_user_tables_vacuum_count | +| cnp_pg_stat_user_tables_autovacuum_count | postgres.raw.pg_stat_user_tables_autovacuum_count | +| cnp_pg_stat_user_tables_analyze_count | postgres.raw.pg_stat_user_tables_analyze_count | +| cnp_pg_stat_user_tables_autoanalyze_count | postgres.raw.pg_stat_user_tables_autoanalyze_count | +| cnp_pg_stat_replication_backend_start_age | postgres.raw.pg_stat_replication_backend_start_age | +| cnp_pg_stat_replication_backend_xmin_age | postgres.raw.pg_stat_replication_backend_xmin_age | +| cnp_pg_stat_replication_sent_diff_bytes | postgres.raw.pg_stat_replication_sent_diff_bytes | +| cnp_pg_stat_replication_write_diff_bytes | postgres.raw.pg_stat_replication_write_diff_bytes | +| cnp_pg_stat_replication_flush_diff_bytes | postgres.raw.pg_stat_replication_flush_diff_bytes | +| cnp_pg_stat_replication_replay_diff_bytes | postgres.raw.pg_stat_replication_replay_diff_bytes | +| cnp_pg_stat_replication_write_lag_seconds | postgres.raw.pg_stat_replication_write_lag_seconds | +| cnp_pg_stat_replication_flush_lag_seconds | postgres.raw.pg_stat_replication_flush_lag_seconds | +| cnp_pg_stat_replication_replay_lag_seconds | postgres.raw.pg_stat_replication_replay_lag_seconds | +| cnp_pg_statio_user_tables_heap_blks_read | postgres.raw.pg_statio_user_tables_heap_blks_read | +| cnp_pg_statio_user_tables_heap_blks_hit | postgres.raw.pg_statio_user_tables_heap_blks_hit | +| cnp_pg_statio_user_tables_idx_blks_read | postgres.raw.pg_statio_user_tables_idx_blks_read | +| cnp_pg_statio_user_tables_idx_blks_hit | postgres.raw.pg_statio_user_tables_idx_blks_hit | +| cnp_pg_statio_user_tables_toast_blks_read | postgres.raw.pg_statio_user_tables_toast_blks_read | +| cnp_pg_statio_user_tables_toast_blks_hit | postgres.raw.pg_statio_user_tables_toast_blks_hit | +| cnp_pg_statio_user_tables_tidx_blks_read | postgres.raw.pg_statio_user_tables_tidx_blks_read | +| cnp_pg_statio_user_tables_tidx_blks_hit | postgres.raw.pg_statio_user_tables_tidx_blks_hit | +| cnp_pg_settings_setting | postgres.raw.pg_settings_setting | +| cnp_xlog_insert_lsn | postgres.raw.xlog_insert_lsn | From 8571cdf6f3fd8d9d54faf0b8dc3d0f7144092003 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 17 Apr 2024 12:09:03 -0700 Subject: [PATCH 2/8] Remove "index.mdx" from end of URL tempted to just make including that filename work, but... for now, it does not. --- .../third_party_integrations/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index 04b605aafea..bdccf9712b6 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -19,7 +19,7 @@ The third-party integrations available in BigAnimal are: When metrics from BigAnimal are exported to third-party monitoring services, they are renamed in accordance with the naming conventions of the target platform. -The name below provides a mapping between [BigAnimal metric names](/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx) +The name below provides a mapping between [BigAnimal metric names](/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/) and the name that metric will be assigned when exported to a third-party services. !!! Note Kubernetes metrics From fd74e641425061addf3a7a6e58a345cd7bde1865 Mon Sep 17 00:00:00 2001 From: mlewandowski-edb <63003848+mlewandowski-edb@users.noreply.github.com> Date: Thu, 18 Apr 2024 10:52:45 -0400 Subject: [PATCH 3/8] Added PG/PGE/EPAS 16 to list of supported versions Updated the supported technologies table by adding version 16 to the list of PostgreSQL, EDB PostgreSQL Extended (PGE), and EDB Postgres Advanced Server (EPAS). LIV-239 [https://enterprisedb.atlassian.net/browse/LIV-239] indicates that support for version 16 has been tested and supported. Also, updated the Technology names for PGE and EPAS. --- .../livecompare/2/supported_technologies.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/livecompare/2/supported_technologies.mdx b/product_docs/docs/livecompare/2/supported_technologies.mdx index ec6a3711b44..08050941e1b 100644 --- a/product_docs/docs/livecompare/2/supported_technologies.mdx +++ b/product_docs/docs/livecompare/2/supported_technologies.mdx @@ -31,14 +31,14 @@ LiveCompare has three kinds of connections: The table shows versions and details about supported technologies and the context in which you can use them in LiveCompare. -| Technology | Versions | Possible connections | -| ------------------------------ | ------------------------------- | --------------------------- | -| PostgreSQL | 10, 11, 12, 13, 14, and 15 | Data and output | -| EDB PostgreSQL Extended | 10, 11, 12, 13, 14, and 15 | Data and output | -| EDB PostgreSQL Advanced (EPAS) | 11, 12, 13, 14, and 15 | Data and output | -| pglogical | 2 and 3 | Initial, data, and output | -| EDB Postgres Distributed (PGD) | 1, 2, 3, 4, and 5 | Initial, data, and output | -| Oracle | 11g, 12c, 18c, 19c, and 21c | A single data connection | +| Technology | Versions | Possible connections | +| ------------------------------------- | ------------------------------- | ------------------------- | +| PostgreSQL | 10, 11, 12, 13, 14, 15, and 16 | Data and output | +| EDB PostgreSQL Extended (PGE) | 10, 11, 12, 13, 14, 15, and 16 | Data and output | +| EDB PostgreSQL Advanced Server (EPAS) | 11, 12, 13, 14, 15, and 16 | Data and output | +| pglogical | 2 and 3 | Initial, data, and output | +| EDB Postgres Distributed (PGD) | 1, 2, 3, 4, and 5 | Initial, data, and output | +| Oracle | 11g, 12c, 18c, 19c, and 21c | A single data connection | ## PgBouncer support From 6cde02277f11210feed85e1f7f474332eb6925e3 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Thu, 18 Apr 2024 09:18:13 -0700 Subject: [PATCH 4/8] Sync CODEOWNERS with the Team Allocation spreadsheet --- CODEOWNERS | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index 53d4ea4fb93..a6c6a376c9c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,4 +1,40 @@ # First pass basic codeowners file -product_docs/docs/pgd/ @djw-m -product_docs/docs/epas/ @nidhibhammar +product_docs/docs/pgd/ @djw-m @jpe442 @piano35-edb +product_docs/docs/epas/ @nidhibhammar @gvasquezvargas +product_docs/docs/edb_plus/ @gvasquezvargas @nidhibhammar +product_docs/docs/pem/ @nidhibhammar @gvasquezvargas +product_docs/docs/net_connector/ @jpe442 @nidhibhammar +product_docs/docs/jdbc_connector/ @jpe442 @nidhibhammar +product_docs/docs/odbc_connector/ @jpe442 @nidhibhammar +product_docs/docs/ocl_connector/ @jpe442 @nidhibhammar +product_docs/docs/mongo_data_adapter/ @jpe442 @nidhibhammar +product_docs/docs/mysql_data_adapter/ @jpe442 @nidhibhammar +product_docs/docs/hadoop_data_adapter/ @jpe442 @nidhibhammar +product_docs/docs/tde/ @gvasquezvargas @nidhibhammar +product_docs/docs/postgis/ @piano35-edb @nidhibhammar +product_docs/docs/pgbouncer/ @piano35-edb @nidhibhammar +product_docs/docs/pgpool/ @piano35-edb @nidhibhammar +product_docs/docs/efm/ @nidhibhammar +product_docs/docs/language_pack/ @piano35-edb @nidhibhammar +product_docs/docs/tpa/ @djw-m +product_docs/docs/postgres_distributed_for_kubernetes/ @jpe442 @djw-m @gvasquezvargas +product_docs/docs/postgres_for_kubernetes/ @jpe442 @djw-m @gvasquezvargas +advocacy_docs/supported-open-source/cloud_native_pg/ @djw-m @piano35-edb @gvasquezvargas +advocacy_docs/tools/edb_sqlpatch/ @djw-m +security/ @djw-m +product_docs/docs/biganimal/ @jpe442 @nidhibhammar @piano35-edb +product_docs/docs/migration_portal/ @gvasquezvargas @nidhibhammar +product_docs/docs/migration_toolkit/ @gvasquezvargas @nidhibhammar +advocacy_docs/migrating/oracle/ @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/ldap_sync/ @piano35-edb @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/advanced_storage_pack/ @piano35-edb @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/pg_tuner/ @piano35-edb @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/query_advisor/ @piano35-edb @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/wait_states/ @piano35-edb @gvasquezvargas @nidhibhammar +advocacy_docs/pg_extensions/pg_failover_slots/ @nidhibhammar +**/installing @dwicinas +advocacy_docs/supported-open-source/barman/ @piano35-edb @jpe442 +product_docs/docs/pge/ @gvasquezvargas +advocacy_docs/supported-open-source/postgresql/ @piano35-edb + From 28e3de9eee22dab60c2232073202fa7a00449212 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 14:24:49 -0400 Subject: [PATCH 5/8] Edtis to BigAnimal PR5473 --- .../release/overview/05_database_version_policy.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 15535b17aa3..07ed5514885 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -8,9 +8,9 @@ We support the major Postgres versions from the date they're made available unti | Postgres distribution | Versions | | ---------------------------- | --------------------------------------------------------------------------------------------- | -| PostgreSQL | 12–16 for (Single, High-Availability) clusters | -| EDB Postgres Extended Server | 12–16 for (Single, High-Availability), 14-16 for (Distributed-High-Availability) clusters | -| EDB Postgres Advanced Server | 14-16 for all cluster types (Single, High-Availability, Distributed-High-Availability) | +| PostgreSQL | 12-16 for (single, high-availability) clusters | +| EDB Postgres Extended Server | 12-16 for (single, high-availability), 14-16 for (distributed high-availability) clusters | +| EDB Postgres Advanced Server | 14-16 for all cluster types (single, high-availability, distributed high-availability) | ## End-of-life policy From 284e5bdf918996253ed4b34a1894776f466d05dd Mon Sep 17 00:00:00 2001 From: mlewandowski-edb <63003848+mlewandowski-edb@users.noreply.github.com> Date: Mon, 22 Apr 2024 11:40:00 -0400 Subject: [PATCH 6/8] Corrected spelling Changed start of sentence in 2nd paragraph from "You co this" to "You do this" --- .../docs/eprs/7/06_mmr_operation/03_creating_primary_nodes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/eprs/7/06_mmr_operation/03_creating_primary_nodes.mdx b/product_docs/docs/eprs/7/06_mmr_operation/03_creating_primary_nodes.mdx index d8dd46c688b..93698ffa861 100644 --- a/product_docs/docs/eprs/7/06_mmr_operation/03_creating_primary_nodes.mdx +++ b/product_docs/docs/eprs/7/06_mmr_operation/03_creating_primary_nodes.mdx @@ -6,7 +6,7 @@ title: "Creating more primary nodes" Once you have created the primary definition node, you add more databases to the multi-master replication system by defining more primary nodes. -You co this by creating more publication database definitions subordinate to the MMR type node under the Publication Server node that contains the primary definition node. +You do this by creating more publication database definitions subordinate to the MMR type node under the Publication Server node that contains the primary definition node. After you create the publication database definition, a Publication Database node representing the primary node appears in the replication tree of the Replication Server console. The publication that was defined under the primary definition node appears under the Publication Database node. From b4b30dcb7a6e45535f459ea83fa4b904a84a01f9 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Wed, 10 Apr 2024 10:03:50 +0100 Subject: [PATCH 7/8] 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 8/8] 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