From b185b9ad4c8612292aa69c5c7b5a6de5ec59c0f4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 23 Jun 2021 18:35:19 -0400 Subject: [PATCH 001/317] docs(UPM-872): created skeletons for top level and overview folder Former-commit-id: 32f0cdb79a30caef0b0153c0355a015089c2280d --- build-sources.json | 3 ++- dev-sources.sample | 3 ++- gatsby-config.js | 1 + .../latest/administering_cluster/index.mdx | 5 +++++ .../edbcloud/latest/cloud_providers/index.mdx | 5 +++++ .../edbcloud/latest/getting_started/index.mdx | 5 +++++ product_docs/docs/edbcloud/latest/index.mdx | 22 +++++++++++++++++++ .../edbcloud/latest/overview/01_overview.mdx | 5 +++++ .../latest/overview/02_backup_and_restore.mdx | 5 +++++ .../latest/overview/03_high_availibility.mdx | 5 +++++ .../overview/04_security_compliance.mdx | 5 +++++ .../docs/edbcloud/latest/overview/index.mdx | 10 +++++++++ .../docs/edbcloud/latest/planning/index.mdx | 5 +++++ .../latest/pricing_and_billing/index.mdx | 5 +++++ .../edbcloud/latest/reference_api/index.mdx | 5 +++++ .../edbcloud/latest/reference_cli/index.mdx | 5 +++++ .../edbcloud/latest/release_notes/index.mdx | 5 +++++ .../edbcloud/latest/using_cluster/index.mdx | 5 +++++ scripts/source/config_sources.py | 2 ++ 19 files changed, 104 insertions(+), 2 deletions(-) create mode 100644 product_docs/docs/edbcloud/latest/administering_cluster/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/cloud_providers/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/getting_started/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/01_overview.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/planning/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/reference_api/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/reference_cli/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/release_notes/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/using_cluster/index.mdx diff --git a/build-sources.json b/build-sources.json index cff13cf9084..7a936d61600 100644 --- a/build-sources.json +++ b/build-sources.json @@ -20,5 +20,6 @@ "pgpool": true, "postgis": true, "repmgr": true, - "slony": true + "slony": true, + "edbcloud": true } diff --git a/dev-sources.sample b/dev-sources.sample index 0d0a992d7e2..d7b8df605fd 100644 --- a/dev-sources.sample +++ b/dev-sources.sample @@ -17,5 +17,6 @@ "pgbouncer": true, "pgpool": true, "postgis": true, - "slony": true + "slony": true, + "edbcloud": true } diff --git a/gatsby-config.js b/gatsby-config.js index f2b28f045c1..e8826907517 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -20,6 +20,7 @@ const sourceToPluginConfig = { bart: { name: 'bart', path: 'product_docs/docs/bart' }, bdr: { name: 'bdr', path: 'product_docs/docs/bdr' }, harp: { name: 'harp', path: 'product_docs/docs/harp' }, + edbcloud: { name: 'edbcloud', path: 'product_docs/docs/edbcloud' }, efm: { name: 'efm', path: 'product_docs/docs/efm' }, epas: { name: 'epas', path: 'product_docs/docs/epas' }, eprs: { name: 'eprs', path: 'product_docs/docs/eprs' }, diff --git a/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx b/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx new file mode 100644 index 00000000000..be0fc262c78 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Administering your cluster" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx b/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx new file mode 100644 index 00000000000..eb1c3efe317 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Cloud Providers" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/getting_started/index.mdx b/product_docs/docs/edbcloud/latest/getting_started/index.mdx new file mode 100644 index 00000000000..6cfbb5a3096 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/getting_started/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Getting Started" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/index.mdx b/product_docs/docs/edbcloud/latest/index.mdx new file mode 100644 index 00000000000..5f83b889891 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/index.mdx @@ -0,0 +1,22 @@ +--- +title: EDB Cloud +directoryDefaults: +description: "EDB Cloud: DBaaS for PostgresSQL " +navigation: + - "#Why EDB Cloud" + - overview + - "#Getting Started" + - getting_started + - "#Guides" + - planning + - using_cluster + - administering_cluster + - cloud_providers + - "#Pricing and Billing" + - pricing_and_billing + - "#Reference" + - reference_api + - reference_cli + - "#Relese Notes" + - release_notes +--- diff --git a/product_docs/docs/edbcloud/latest/overview/01_overview.mdx b/product_docs/docs/edbcloud/latest/overview/01_overview.mdx new file mode 100644 index 00000000000..14df9a3c99c --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/01_overview.mdx @@ -0,0 +1,5 @@ +--- +title: "Overview of Service" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx new file mode 100644 index 00000000000..3cc098fce6c --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx @@ -0,0 +1,5 @@ +--- +title: "Backup and Restore" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx new file mode 100644 index 00000000000..6c4571179ee --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx @@ -0,0 +1,5 @@ +--- +title: "High Availability" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx new file mode 100644 index 00000000000..2cbac89619f --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx @@ -0,0 +1,5 @@ +--- +title: "Security and Compliance " +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/index.mdx b/product_docs/docs/edbcloud/latest/overview/index.mdx new file mode 100644 index 00000000000..295721fd868 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/index.mdx @@ -0,0 +1,10 @@ +--- +title: "Overview" +--- + +Overview of service, run in customer's account, purchase through Azure Marketplace +
+ +overview backup_and_restore high_availibility security_compliance + +
diff --git a/product_docs/docs/edbcloud/latest/planning/index.mdx b/product_docs/docs/edbcloud/latest/planning/index.mdx new file mode 100644 index 00000000000..78b385b4a4b --- /dev/null +++ b/product_docs/docs/edbcloud/latest/planning/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Planning" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx new file mode 100644 index 00000000000..d5dad8d3333 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Pricing and Billing " +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/reference_api/index.mdx b/product_docs/docs/edbcloud/latest/reference_api/index.mdx new file mode 100644 index 00000000000..40ab895905e --- /dev/null +++ b/product_docs/docs/edbcloud/latest/reference_api/index.mdx @@ -0,0 +1,5 @@ +--- +title: "API Reference" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/reference_cli/index.mdx b/product_docs/docs/edbcloud/latest/reference_cli/index.mdx new file mode 100644 index 00000000000..fda15081dca --- /dev/null +++ b/product_docs/docs/edbcloud/latest/reference_cli/index.mdx @@ -0,0 +1,5 @@ +--- +title: "CLI Reference" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/release_notes/index.mdx b/product_docs/docs/edbcloud/latest/release_notes/index.mdx new file mode 100644 index 00000000000..22da4ee7244 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/release_notes/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Release Notes" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/using_cluster/index.mdx b/product_docs/docs/edbcloud/latest/using_cluster/index.mdx new file mode 100644 index 00000000000..3a287220539 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/using_cluster/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Using your cluster" +--- + +Document content diff --git a/scripts/source/config_sources.py b/scripts/source/config_sources.py index 6087356a245..fd6b956d8a3 100644 --- a/scripts/source/config_sources.py +++ b/scripts/source/config_sources.py @@ -26,6 +26,7 @@ 'pgpool', 'postgis', 'slony', + 'edbcloud', ] BASE_OUTPUT = {} @@ -53,6 +54,7 @@ { 'index': '1q', 'name': 'Mongo Data Adapter', 'key': 'mongo_data_adapter', 'indent': True }, { 'index': '1r', 'name': 'MySQL Data Adapter', 'key': 'mysql_data_adapter', 'indent': True }, { 'index': '1s', 'name': 'Replication Server', 'key': 'eprs', 'indent': True }, + { 'index': '1t', 'name': 'EDB Cloud', 'key': 'edbcloud', 'indent': True }, ] print('Which sources would you like loaded when you run `yarn develop`?') From c85666f9157ea064d1c3bc50642010abbaf9cf0b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 29 Jun 2021 17:52:46 -0400 Subject: [PATCH 002/317] docs(UPM-872): fixing version in TOC Former-commit-id: 97afb16a765fff60473329cc8917821c6c1caab4 --- .../edbcloud/{latest => beta}/administering_cluster/index.mdx | 0 .../docs/edbcloud/{latest => beta}/cloud_providers/index.mdx | 0 .../docs/edbcloud/{latest => beta}/getting_started/index.mdx | 0 product_docs/docs/edbcloud/{latest => beta}/index.mdx | 0 .../docs/edbcloud/{latest => beta}/overview/01_overview.mdx | 0 .../{latest => beta}/overview/02_backup_and_restore.mdx | 0 .../edbcloud/{latest => beta}/overview/03_high_availibility.mdx | 0 .../{latest => beta}/overview/04_security_compliance.mdx | 0 product_docs/docs/edbcloud/{latest => beta}/overview/index.mdx | 2 +- product_docs/docs/edbcloud/{latest => beta}/planning/index.mdx | 0 .../edbcloud/{latest => beta}/pricing_and_billing/index.mdx | 0 .../docs/edbcloud/{latest => beta}/reference_api/index.mdx | 0 .../docs/edbcloud/{latest => beta}/reference_cli/index.mdx | 0 .../docs/edbcloud/{latest => beta}/release_notes/index.mdx | 0 .../docs/edbcloud/{latest => beta}/using_cluster/index.mdx | 0 15 files changed, 1 insertion(+), 1 deletion(-) rename product_docs/docs/edbcloud/{latest => beta}/administering_cluster/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/cloud_providers/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/getting_started/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/01_overview.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/02_backup_and_restore.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/03_high_availibility.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/04_security_compliance.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/index.mdx (68%) rename product_docs/docs/edbcloud/{latest => beta}/planning/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/pricing_and_billing/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/reference_api/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/reference_cli/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/release_notes/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/using_cluster/index.mdx (100%) diff --git a/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/administering_cluster/index.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/index.mdx diff --git a/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/cloud_providers/index.mdx rename to product_docs/docs/edbcloud/beta/cloud_providers/index.mdx diff --git a/product_docs/docs/edbcloud/latest/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/getting_started/index.mdx rename to product_docs/docs/edbcloud/beta/getting_started/index.mdx diff --git a/product_docs/docs/edbcloud/latest/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/index.mdx rename to product_docs/docs/edbcloud/beta/index.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/01_overview.mdx b/product_docs/docs/edbcloud/beta/overview/01_overview.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/01_overview.mdx rename to product_docs/docs/edbcloud/beta/overview/01_overview.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx rename to product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx rename to product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx rename to product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx similarity index 68% rename from product_docs/docs/edbcloud/latest/overview/index.mdx rename to product_docs/docs/edbcloud/beta/overview/index.mdx index 295721fd868..b6cd802a1ad 100644 --- a/product_docs/docs/edbcloud/latest/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -5,6 +5,6 @@ title: "Overview" Overview of service, run in customer's account, purchase through Azure Marketplace
-overview backup_and_restore high_availibility security_compliance +01_overview 02_backup_and_restore high_availibility security_compliance
diff --git a/product_docs/docs/edbcloud/latest/planning/index.mdx b/product_docs/docs/edbcloud/beta/planning/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/planning/index.mdx rename to product_docs/docs/edbcloud/beta/planning/index.mdx diff --git a/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx rename to product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx diff --git a/product_docs/docs/edbcloud/latest/reference_api/index.mdx b/product_docs/docs/edbcloud/beta/reference_api/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/reference_api/index.mdx rename to product_docs/docs/edbcloud/beta/reference_api/index.mdx diff --git a/product_docs/docs/edbcloud/latest/reference_cli/index.mdx b/product_docs/docs/edbcloud/beta/reference_cli/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/reference_cli/index.mdx rename to product_docs/docs/edbcloud/beta/reference_cli/index.mdx diff --git a/product_docs/docs/edbcloud/latest/release_notes/index.mdx b/product_docs/docs/edbcloud/beta/release_notes/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/release_notes/index.mdx rename to product_docs/docs/edbcloud/beta/release_notes/index.mdx diff --git a/product_docs/docs/edbcloud/latest/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/using_cluster/index.mdx rename to product_docs/docs/edbcloud/beta/using_cluster/index.mdx From e3030b9620969eef601f7c5c54693de52ab1b566 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 29 Jun 2021 20:25:40 -0400 Subject: [PATCH 003/317] docs(UPM-872): overview section drafts and navigation Former-commit-id: 5e7f973c3324d259d1bb36a843123e970424c788 --- .../docs/edbcloud/beta/overview/01_overview.mdx | 5 ----- .../beta/overview/02_backup_and_restore.mdx | 5 ----- .../beta/overview/02_high_availibility.mdx | 15 +++++++++++++++ .../beta/overview/03_high_availibility.mdx | 5 ----- ...ompliance.mdx => 03_security_compliance.mdx} | 2 ++ .../beta/overview/04_responsibility_model.mdx | 14 ++++++++++++++ .../overview/05_database_version_policy.mdx | 17 +++++++++++++++++ .../docs/edbcloud/beta/overview/06_support.mdx | 12 ++++++++++++ .../docs/edbcloud/beta/overview/index.mdx | 16 +++++++++++----- 9 files changed, 71 insertions(+), 20 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/overview/01_overview.mdx delete mode 100644 product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx delete mode 100644 product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx rename product_docs/docs/edbcloud/beta/overview/{04_security_compliance.mdx => 03_security_compliance.mdx} (63%) create mode 100644 product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/06_support.mdx diff --git a/product_docs/docs/edbcloud/beta/overview/01_overview.mdx b/product_docs/docs/edbcloud/beta/overview/01_overview.mdx deleted file mode 100644 index 14df9a3c99c..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/01_overview.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Overview of Service" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx deleted file mode 100644 index 3cc098fce6c..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Backup and Restore" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx new file mode 100644 index 00000000000..d2e2bcab732 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -0,0 +1,15 @@ +--- +title: "High Availability" +--- + +Reference and link out to Terms of Service. + +High Availability Configuration: + +- EDB Cloud provides built in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. + +- Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. + +- Streaming replication is used + +Reference and link out to Terms of Service (once link is available). diff --git a/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx deleted file mode 100644 index 6c4571179ee..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "High Availability" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx similarity index 63% rename from product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx rename to product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 2cbac89619f..c8903d8d46c 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -3,3 +3,5 @@ title: "Security and Compliance " --- Document content + +Reference and link out to Terms  diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx new file mode 100644 index 00000000000..a8f7d2f86a2 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -0,0 +1,14 @@ +--- +title: "Responsibility Model" +--- + +EDB Cloud provisions resources in the customer’s cloud account. + +- Create a similar table to https://cloud.ibm.com/docs/databases-for-postgresql?topic=cloud-databases-responsibilities-cloud-databases +detailing out what EDB is responsible for and what the customer is responsible for + +Customers need to understand the problems involved with provisioning. + +Document the security implications of sharing powerful access credentials to their cloud account + + diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx new file mode 100644 index 00000000000..ff256e4e291 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -0,0 +1,17 @@ +--- +title: "Database Version Policy" +--- + +Versions Supported: + +- PostgreSQL versions supported: 10, 11, 12 + +- EDB Postgres Advanced versions supported: 10, 11, 12 + +Maintenance and upgrades: + +- EDB is committed to providing stable, up-to-date versions. We test, evaluate, and release new versions to clusters. + +- Major Version Upgrades: Major versions are supported from the date they are made available until the version is retired from the PostgreSQL community (for PostgreSQL) or until EDB retires a major version of EDB Postgres Advanced Server. + +- Minor Version Upgrades & Maintenance: Minor version and patch updates are handled automatically and are not user configurable. diff --git a/product_docs/docs/edbcloud/beta/overview/06_support.mdx b/product_docs/docs/edbcloud/beta/overview/06_support.mdx new file mode 100644 index 00000000000..d8c25425bce --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/06_support.mdx @@ -0,0 +1,12 @@ +--- +title: "Support" +--- + +Document how and where customers can open support tickets: + +- Support ticket Portal: support.edbcloud.com + +- Chat + + + diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index b6cd802a1ad..298df644b59 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -1,10 +1,16 @@ --- -title: "Overview" +title: "Overview of Service" --- + + +- EDB is a fully managed database as a service offering both PostgreSQL and EDB Postgres Advanced with Oracle Compatibility. + +- This service runs in your cloud account, but is fully managed and operated by the EDB team. + +- This service is available via the Microsoft Azure Marketplace. + + + -Overview of service, run in customer's account, purchase through Azure Marketplace -
-01_overview 02_backup_and_restore high_availibility security_compliance -
From 6f48d0f83822693da81eadb81f4327d53712d584 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 15:45:56 -0400 Subject: [PATCH 004/317] docs(UPM-872): overview section drafts and navigation Former-commit-id: 66917465b685602d0712b0548370ee960f40e963 --- .../beta/getting_started/01_connect_cloud_account.mdx | 7 +++++++ .../edbcloud/beta/getting_started/02_configure_acess.mdx | 9 +++++++++ .../edbcloud/beta/getting_started/03_create_cluster.mdx | 5 +++++ .../docs/edbcloud/beta/getting_started/index.mdx | 8 +++++++- 4 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx create mode 100644 product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx create mode 100644 product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx new file mode 100644 index 00000000000..5d83807728c --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -0,0 +1,7 @@ +--- +title: "Connect Cloud Account" +--- + + + +Marketplace Flow (check out confluence example: Get Started with Confluent Cloud on the Azure Marketplace with Commitments diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx new file mode 100644 index 00000000000..9ef6b779d1e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -0,0 +1,9 @@ +--- +title: "Configure Access" +--- + + + +- Explain how to invite users + +- Explain what default roles and permissions are given to new users diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx new file mode 100644 index 00000000000..8fcbc4149ff --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Create Cluster" +--- + +Provide step by step directions on where and how to create a cluster. diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 6cfbb5a3096..9973e740adb 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,5 +1,11 @@ --- +navTitle: Getting Started title: "Getting Started" --- -Document content + +
+ +connect_cloud_account configure_access create_cluster + +
From e7c65e1af44cc29688ca5a7b6aabd3b6747dc9a1 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 16:26:00 -0400 Subject: [PATCH 005/317] docs(UPM-909): using cluster section drafts and navigation Former-commit-id: 5da62a05c9fa3a5a5db085d9271df5e26207d593 --- .../edbcloud/beta/getting_started/index.mdx | 2 +- .../beta/using_cluster/01_cluster_sizing.mdx | 5 ++++ .../using_cluster/02_connect_to_cluster.mdx | 5 ++++ .../03_modify_and_scale_cluster.mdx | 5 ++++ .../using_cluster/04_backup_and_restore.mdx | 28 +++++++++++++++++++ .../05_monitoring_and_logging.mdx | 7 +++++ .../06_analyze_with_superset.mdx | 5 ++++ 7 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 9973e740adb..587561a1fa6 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,6 +1,6 @@ --- -navTitle: Getting Started title: "Getting Started" +indexCards: simple --- diff --git a/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx b/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx new file mode 100644 index 00000000000..588e8de4cca --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx @@ -0,0 +1,5 @@ +--- +title: "Cluster Sizing" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx new file mode 100644 index 00000000000..4cc7bc25134 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Connect to Cluster" +--- + +Explain where a customer can access connection details and connect to their cluster. diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx new file mode 100644 index 00000000000..94c20973713 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Modify & Scale Cluster" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx new file mode 100644 index 00000000000..9c461ef4337 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -0,0 +1,28 @@ +--- +title: "Backup and Restore" +--- + +PITR & Restore Points, Redundancy + +Backups: + +- EDB provides automatic backups. Backups are continuously (commit to time period?) taken on clusters. + +- Type of backups: WAL archiving? + +- Retention: Customers can specify the retention period for backups. Include timing of retention. + +- Where are backups stored? Backups are stored in Azure Blob Storage (include which type). Customers are responsible for the charges associated with backup storage, please reference the Azure Blob Storage page for more information. + +Restore: + +- Point in time recovery available. Customers can enter in a timestamp that they want to restore to. Include the increments of time and where a customer can initiate a restore. + +- Customers can restore backups into a new cluster in the same region or a new region. + +- Include which fields are editable by the customers. + +- Archived clusters can be restored to the most recent point in time available. + + + diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx new file mode 100644 index 00000000000..fef028cd55b --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -0,0 +1,7 @@ +--- +title: "Monitoring and Logging" +--- + +All metrics and logs are sent to Azure Monitor. Explain where a customer can navigate to view metrics and logs. + +- Explain what metrics and logs are sent diff --git a/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx new file mode 100644 index 00000000000..60b09ea58f1 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx @@ -0,0 +1,5 @@ +--- +title: "Analyze with Apache Superset" +--- + +Document content From cedb9134e23f31670c439b89d3d9f04fa1d6b26b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 16:33:53 -0400 Subject: [PATCH 006/317] docs(UPM-908): Planning section drafts and navigation Former-commit-id: 0451e55b86df96b9e24852f0bd118c422ec08e7d --- product_docs/docs/edbcloud/beta/planning/01_migration.mdx | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/planning/01_migration.mdx diff --git a/product_docs/docs/edbcloud/beta/planning/01_migration.mdx b/product_docs/docs/edbcloud/beta/planning/01_migration.mdx new file mode 100644 index 00000000000..030827e5bf8 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/planning/01_migration.mdx @@ -0,0 +1,5 @@ +--- +title: "Migration" +--- + +Document content From 8dae4eeb75ab562a7879c4eb4378f02296aa01cd Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:07:25 -0400 Subject: [PATCH 007/317] docs(UPM-910): Administring your cluster section drafts and navigation Former-commit-id: 0733ac1883a884fc22c058d80e0eae7ea580b3ce --- .../organization_and_access/01_organizations.mdx | 5 +++++ .../organization_and_access/02_users.mdx | 5 +++++ .../organization_and_access/03_roles.mdx | 5 +++++ .../organization_and_access/index.mdx | 5 +++++ .../security_and_networking/01_encryption.mdx | 5 +++++ .../security_and_networking/02_private_networking.mdx | 10 ++++++++++ .../security_and_networking/03_activity_log.mdx | 11 +++++++++++ .../security_and_networking/index.mdx | 5 +++++ 8 files changed, 51 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx new file mode 100644 index 00000000000..576cecf3578 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -0,0 +1,5 @@ +--- +title: "Organizations" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx new file mode 100644 index 00000000000..31079486d01 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -0,0 +1,5 @@ +--- +title: "Users" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx new file mode 100644 index 00000000000..b6a189ab0e8 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -0,0 +1,5 @@ +--- +title: "Roles" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx new file mode 100644 index 00000000000..b67ff359ce9 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Organization and Access" +--- + +Document content UPM-924 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx new file mode 100644 index 00000000000..9059f98347e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx @@ -0,0 +1,5 @@ +--- +title: "Encryption" +--- + +Define what is done for encryption keys. UPM-929 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx new file mode 100644 index 00000000000..f3506d278f1 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx @@ -0,0 +1,10 @@ +--- +title: "Private Networking" +--- + +Configuration: + +- Private network connectivity can be enabled or disabled +UPM-930 + + diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx new file mode 100644 index 00000000000..3076170e7fb --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx @@ -0,0 +1,11 @@ +--- +title: "Activity Log" +--- + +Also pgaudit / edb audit implications and what we allow customers to configure + +- What events are tracked in Activity Log + +- Define events + +UPM-931 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx new file mode 100644 index 00000000000..80f85bdddc6 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Security and Networking" +--- + +Document content UPM-925 From ed18442d74b54777d3108c06dbd587fc011d75c5 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:31:16 -0400 Subject: [PATCH 008/317] docs(UPM-911): Pricing and billing section drafts and navigation Former-commit-id: 876d578296c2965ff1f77716dbefb6fa8e6e532d --- .../beta/pricing_and_billing/01_pricing.mdx | 14 ++++++++++++++ .../beta/pricing_and_billing/02_billing.mdx | 8 ++++++++ 2 files changed, 22 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx create mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx new file mode 100644 index 00000000000..5823320b45e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx @@ -0,0 +1,14 @@ +--- +title: "Pricing/Billing" +--- + +UPM-932 + +Info on how we bill (including the price metrics), how we meter usage & how often. + +- Price Metric: Virtual Central Processing Unit (vCPU) + +- Hourly metering + +- All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. (We can reference the 'billing through Microsoft Azure docs page) + diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx new file mode 100644 index 00000000000..7294a4e01ab --- /dev/null +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx @@ -0,0 +1,8 @@ +--- +title: "Billing through Microsoft Azure" +--- +How is infrastructure (instances/storage) charged? + +EDB Cloud does not bill for cloud infrastructure costs, including compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run in your own cloud account, and thus infrastructure costs are billed to you by your respective cloud provider(s). + + From c7a72bce2e8415c57db82bd7d7f7439a24f7c7ee Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:43:10 -0400 Subject: [PATCH 009/317] docs(UPM-912): Cloud Providers section drafts and navigation Former-commit-id: bb656816379d21d7493659a30ca33c5547f03b77 --- .../beta/cloud_providers/microsoft_azure/01_regions.mdx | 6 ++++++ .../microsoft_azure/02_infrastructure_supported.mdx | 6 ++++++ .../edbcloud/beta/cloud_providers/microsoft_azure/index.mdx | 5 +++++ 3 files changed, 17 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx new file mode 100644 index 00000000000..17b057d0e0f --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx @@ -0,0 +1,6 @@ +--- +title: "Microsoft Azure - Regions" +navTitle: "Regions" +--- + +UPM-935 List supported region. diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx new file mode 100644 index 00000000000..56865efe274 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx @@ -0,0 +1,6 @@ +--- +title: "Microsoft Azure - Infrastructure Supported" +navTitle: "Infrastructure" +--- + +UPM-936 List supported infrastructure instance types diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx new file mode 100644 index 00000000000..5ba833cb26b --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Microsoft Azure" +--- + +Document content From f8687e9816e7e34a8368de29cd166820fd9e0882 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 13:12:39 -0400 Subject: [PATCH 010/317] docs(UPM-872): Changed left navigation bar Former-commit-id: c294582f37aeb43a73ea3851288152edf6428ef8 --- product_docs/docs/edbcloud/beta/index.mdx | 9 +-------- .../edbcloud/beta/{reference_api => reference}/index.mdx | 2 +- product_docs/docs/edbcloud/beta/reference_cli/index.mdx | 5 ----- 3 files changed, 2 insertions(+), 14 deletions(-) rename product_docs/docs/edbcloud/beta/{reference_api => reference}/index.mdx (53%) delete mode 100644 product_docs/docs/edbcloud/beta/reference_cli/index.mdx diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index 5f83b889891..fb0449da962 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -3,20 +3,13 @@ title: EDB Cloud directoryDefaults: description: "EDB Cloud: DBaaS for PostgresSQL " navigation: - - "#Why EDB Cloud" - overview - - "#Getting Started" - getting_started - - "#Guides" - planning - using_cluster - administering_cluster - cloud_providers - - "#Pricing and Billing" - pricing_and_billing - - "#Reference" - - reference_api - - reference_cli - - "#Relese Notes" + - reference - release_notes --- diff --git a/product_docs/docs/edbcloud/beta/reference_api/index.mdx b/product_docs/docs/edbcloud/beta/reference/index.mdx similarity index 53% rename from product_docs/docs/edbcloud/beta/reference_api/index.mdx rename to product_docs/docs/edbcloud/beta/reference/index.mdx index 40ab895905e..d20236bea27 100644 --- a/product_docs/docs/edbcloud/beta/reference_api/index.mdx +++ b/product_docs/docs/edbcloud/beta/reference/index.mdx @@ -1,5 +1,5 @@ --- -title: "API Reference" +title: "Reference" --- Document content diff --git a/product_docs/docs/edbcloud/beta/reference_cli/index.mdx b/product_docs/docs/edbcloud/beta/reference_cli/index.mdx deleted file mode 100644 index fda15081dca..00000000000 --- a/product_docs/docs/edbcloud/beta/reference_cli/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "CLI Reference" ---- - -Document content From c8157d43628f8307a1b557bbefe08d17ff0dd5c0 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 18:32:27 -0400 Subject: [PATCH 011/317] docs(UPM-876): Security and Compliance section draft Former-commit-id: cec10140832248001cb45ad574522bc494008bc8 --- .../beta/overview/03_security_compliance.mdx | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index c8903d8d46c..dafc1d0bf57 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -2,6 +2,27 @@ title: "Security and Compliance " --- -Document content +### Security Governance -Reference and link out to Terms  +- EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- EDB Cloud infrastructure periodically undergoes SOC2 audit trails to ensure that EDB Cloud is always compliant with security requirements. +- All EDB staff undergo background checks before they’re hired. +- All EDB staff required to take mandatory security training. +- EDB Software Development Life Cycle integrates continuous security scans of added/updated code. + + +### EDB Cloud Security Features +- **Customer Data Segregation**: EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. +- **Data Encryption:** EDB Cloud encrypts customer data at motion and at rest (Question about encryption policies). +- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves) +- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center +- **Disaster Recovery and Business Continuity** All components of EDB Cloud infrastructure are highly available and redundant. +- **Incident Response** EDB employs tools and process which monitor the platform and has a dedicated security team and incident response processes. + +### Shared Responsibility +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform, that enable our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model + + + +Reference and link out to Terms From 6cf70ee74c405ced83785b51444e5004cc70223b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 18:52:43 -0400 Subject: [PATCH 012/317] docs(UPM-876): Security and Compliance section draft (language fixes) Former-commit-id: ecf11ce4255d73201fb64d3c1fd70e5acfc0b40b --- .../beta/overview/03_security_compliance.mdx | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index dafc1d0bf57..48c4adab083 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -1,27 +1,27 @@ --- -title: "Security and Compliance " +title: "Security and Compliance" --- ### Security Governance -- EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. -- EDB Cloud infrastructure periodically undergoes SOC2 audit trails to ensure that EDB Cloud is always compliant with security requirements. -- All EDB staff undergo background checks before they’re hired. -- All EDB staff required to take mandatory security training. -- EDB Software Development Life Cycle integrates continuous security scans of added/updated code. +- The EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- EDB Cloud infrastructure periodically undergoes SOC2 audit trials to ensure that EDB Cloud is always compliant with security requirements. +- All EDB staff undergo background checks before they are hired. +- All EDB staff are required to take mandatory security training. +- The EDB Software Development Life Cycle integrates continuous security scans of added/updated code. ### EDB Cloud Security Features -- **Customer Data Segregation**: EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Customer Data Segregation:** EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Data Encryption:** EDB Cloud encrypts customer data at motion and at rest (Question about encryption policies). -- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves) -- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center -- **Disaster Recovery and Business Continuity** All components of EDB Cloud infrastructure are highly available and redundant. -- **Incident Response** EDB employs tools and process which monitor the platform and has a dedicated security team and incident response processes. +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question about encryption policies). +- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) +- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. +- **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. +- **Incident Response:** EDB employs tools and processes which monitor the platform and has a dedicated security team as well as incident response processes. ### Shared Responsibility -Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform, that enable our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model for more information. From 92812532eeebf51641955f804afd2227cc8a1358 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 2 Jul 2021 10:34:37 -0400 Subject: [PATCH 013/317] docs(UPM-876): Security and Compliance section - updates informed by Simon and Nick Former-commit-id: 98c72d8b17fa72eecbec5f8b69a40b741f39d5cc --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 48c4adab083..e6b048bdc22 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -4,7 +4,7 @@ title: "Security and Compliance" ### Security Governance -- The EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- Cloud Security Compliance officer is responsible for maintaining compliance targets for their entire organization. - EDB Cloud infrastructure periodically undergoes SOC2 audit trials to ensure that EDB Cloud is always compliant with security requirements. - All EDB staff undergo background checks before they are hired. - All EDB staff are required to take mandatory security training. @@ -12,9 +12,10 @@ title: "Security and Compliance" ### EDB Cloud Security Features -- **Customer Data Segregation:** EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question about encryption policies). +- **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers define their own set of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question: more details about encryption policies). - **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. - **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. From e89f4771f53b891ce6774ea080af38ac30786543 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Fri, 2 Jul 2021 16:32:43 +0000 Subject: [PATCH 014/317] Allow advo-style card nav for products Former-commit-id: a9f8bf8eacf0bb6d9cdf07a13a8610f53aec7440 --- product_docs/docs/edbcloud/beta/index.mdx | 3 +- src/templates/doc.js | 66 ++++++++++++++++++++++- 2 files changed, 66 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index fb0449da962..0a3dddbcb9f 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -1,7 +1,8 @@ --- title: EDB Cloud -directoryDefaults: description: "EDB Cloud: DBaaS for PostgresSQL " +indexCards: simple +directoryDefaults: navigation: - overview - getting_started diff --git a/src/templates/doc.js b/src/templates/doc.js index a4dae29c24a..05525f47ba5 100644 --- a/src/templates/doc.js +++ b/src/templates/doc.js @@ -3,6 +3,7 @@ import { Container, Row, Col, Dropdown, DropdownButton } from 'react-bootstrap'; import { graphql, Link } from 'gatsby'; import { MDXRenderer } from 'gatsby-plugin-mdx'; import { + CardDecks, DevOnly, DevFrontmatter, Footer, @@ -87,6 +88,58 @@ const ContentRow = ({ children }) => ( ); +const findDescendent = (root, predicate) => { + if (predicate(root)) return root; + + for (let node of root.items) + { + const result = findDescendent(node, predicate); + if (result) return result; + } + return null; +}; + +const getCards = (node, searchDepth) => { + const card = { + fields: { + path: node.path, + depth: node.depth, + + }, + frontmatter: { + navTitle: node.navTitle, + title: node.title, + description: node.description, + iconName: node.iconName, + interactive: node.interactive, + }, + children: searchDepth && node.items ? node.items.map(n => getCards(n, searchDepth-1)) : [], + }; + return card; +}; + +const TileModes = { + None: 'none', + Simple: 'simple', + Full: 'full', +}; +const Tiles = ({ mode, node }) => { + if (!node || !node.items) return null; + if (mode === TileModes.None) return null; + + if (!mode) { + if (node.depth === 2) mode = TileModes.Full; + else if (node.depth >= 3) mode = TileModes.Simple; + } + + if (Object.values(TileModes).includes(mode)) { + const tiles = node.items.map(n => getCards(n, mode === 'simple' ? 0 : 1)); + + return ; + } + return null; +}; + const Sections = ({ sections }) => ( <> {sections.map((section) => ( @@ -172,8 +225,16 @@ const DocTemplate = ({ data, pageContext }) => { navTree, prevNext, } = pageContext; + const navRoot = findDescendent(navTree, n => n.path === path); const versionArray = makeVersionArray(versions, path); const { product, version } = getProductAndVersion(path); + + const { + iconName, + description, + indexCards + } = frontmatter; + const sections = depth === 2 ? buildSections(navTree) : null; let title = frontmatter.title; @@ -189,7 +250,7 @@ const DocTemplate = ({ data, pageContext }) => { const pageMeta = { title: title, - description: frontmatter.description, + description: description, path: pagePath, isIndexPage: isIndexPage, canonicalPath: determineCanonicalPath( @@ -210,7 +271,7 @@ const DocTemplate = ({ data, pageContext }) => { path={path} pagePath={pagePath} versionArray={versionArray} - iconName={frontmatter.iconName} + iconName={iconName} /> @@ -235,6 +296,7 @@ const DocTemplate = ({ data, pageContext }) => { {body} + {showToc && ( From b78a9c3c6469c64d4231bba9a3c5d95e5fbf6a8a Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Fri, 2 Jul 2021 17:00:01 +0000 Subject: [PATCH 015/317] add capability for draft builds Former-commit-id: b247880703c608c0459bcb19303bd5ff7153a4ca --- .github/workflows/deploy-draft.yml | 86 ++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 .github/workflows/deploy-draft.yml diff --git a/.github/workflows/deploy-draft.yml b/.github/workflows/deploy-draft.yml new file mode 100644 index 00000000000..2823de164d3 --- /dev/null +++ b/.github/workflows/deploy-draft.yml @@ -0,0 +1,86 @@ +name: Deploy branch draft on Netlify +on: + pull_request: + types: [labeled, opened, synchronize] + +jobs: + build-deploy: + if: | + (github.event.action == 'labeled' && github.event.label.name == 'deploy') || + (github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'deploy')) + runs-on: ubuntu-latest + steps: + - name: inject slug/short variables + uses: rlespinasse/github-slug-action@v3.x + + - name: set STAGE variable in environment for next steps + run: echo "STAGE=pr-${{ github.event.number }}-${{ env.GITHUB_HEAD_REF_SLUG }}" >> $GITHUB_ENV + + - name: create a github deployment + uses: bobheadxi/deployments@v0.5.2 + id: deployment + with: + step: start + token: ${{ secrets.GITHUB_TOKEN }} + env: ${{ env.STAGE }} + ref: ${{ github.head_ref }} + + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # fetch whole repo so git-restore-mtime can work + + - name: Adjust file watchers limit + run: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p + + - uses: actions/setup-node@v1 + with: + node-version: '14.x' + - name: Install yarn + run: sudo npm -g install yarn + - name: Yarn install + run: yarn install --immutable + env: + NODE_ENV: ${{ secrets.NODE_ENV }} + + - name: Checking Gatsby cache + id: gatsby-cache-build + uses: actions/cache@v2 + with: + path: | + public + .cache + key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }} + restore-keys: | + ${{ runner.os }}-gatsby-build-develop- + + - name: Fix mtimes + run: yarn fix-mtimes --force + - name: Gatsby build + run: yarn build + env: + APP_ENV: staging + NODE_ENV: ${{ secrets.NODE_ENV }} + NODE_OPTIONS: --max-old-space-size=4096 + ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} + ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }} + ALGOLIA_INDEX_NAME: edb-docs-staging + INDEX_ON_BUILD: false + + - name: Netlify deploy + run: | + sudo yarn global add netlify-cli + netlify deploy --dir=public --json | tee deploy_results.json + echo "NETLIFY_DRAFT_URL=`jq -r '.deploy_url' deploy_results.json`" >> $GITHUB_ENV + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DEVELOP_SITE_ID }} + + - name: update the github deployment status + uses: bobheadxi/deployments@v0.5.2 + if: always() + with: + step: finish + token: ${{ secrets.GITHUB_TOKEN }} + status: ${{ job.status }} + deployment_id: ${{ steps.deployment.outputs.deployment_id }} + env_url: ${{ env.NETLIFY_DRAFT_URL }} From 1fb6d57e0eea9c2f71538671dd86414ae7ded44e Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 23 Jun 2021 18:35:19 -0400 Subject: [PATCH 016/317] docs(UPM-872): created skeletons for top level and overview folder Former-commit-id: 8201211b5fc6a0684a9b72c52acd505af6783894 --- build-sources.json | 3 ++- dev-sources.sample | 3 ++- gatsby-config.js | 1 + .../latest/administering_cluster/index.mdx | 5 +++++ .../edbcloud/latest/cloud_providers/index.mdx | 5 +++++ .../edbcloud/latest/getting_started/index.mdx | 5 +++++ product_docs/docs/edbcloud/latest/index.mdx | 22 +++++++++++++++++++ .../edbcloud/latest/overview/01_overview.mdx | 5 +++++ .../latest/overview/02_backup_and_restore.mdx | 5 +++++ .../latest/overview/03_high_availibility.mdx | 5 +++++ .../overview/04_security_compliance.mdx | 5 +++++ .../docs/edbcloud/latest/overview/index.mdx | 10 +++++++++ .../docs/edbcloud/latest/planning/index.mdx | 5 +++++ .../latest/pricing_and_billing/index.mdx | 5 +++++ .../edbcloud/latest/reference_api/index.mdx | 5 +++++ .../edbcloud/latest/reference_cli/index.mdx | 5 +++++ .../edbcloud/latest/release_notes/index.mdx | 5 +++++ .../edbcloud/latest/using_cluster/index.mdx | 5 +++++ scripts/source/config_sources.py | 2 ++ 19 files changed, 104 insertions(+), 2 deletions(-) create mode 100644 product_docs/docs/edbcloud/latest/administering_cluster/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/cloud_providers/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/getting_started/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/01_overview.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx create mode 100644 product_docs/docs/edbcloud/latest/overview/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/planning/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/reference_api/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/reference_cli/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/release_notes/index.mdx create mode 100644 product_docs/docs/edbcloud/latest/using_cluster/index.mdx diff --git a/build-sources.json b/build-sources.json index cff13cf9084..7a936d61600 100644 --- a/build-sources.json +++ b/build-sources.json @@ -20,5 +20,6 @@ "pgpool": true, "postgis": true, "repmgr": true, - "slony": true + "slony": true, + "edbcloud": true } diff --git a/dev-sources.sample b/dev-sources.sample index 0d0a992d7e2..d7b8df605fd 100644 --- a/dev-sources.sample +++ b/dev-sources.sample @@ -17,5 +17,6 @@ "pgbouncer": true, "pgpool": true, "postgis": true, - "slony": true + "slony": true, + "edbcloud": true } diff --git a/gatsby-config.js b/gatsby-config.js index f2b28f045c1..e8826907517 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -20,6 +20,7 @@ const sourceToPluginConfig = { bart: { name: 'bart', path: 'product_docs/docs/bart' }, bdr: { name: 'bdr', path: 'product_docs/docs/bdr' }, harp: { name: 'harp', path: 'product_docs/docs/harp' }, + edbcloud: { name: 'edbcloud', path: 'product_docs/docs/edbcloud' }, efm: { name: 'efm', path: 'product_docs/docs/efm' }, epas: { name: 'epas', path: 'product_docs/docs/epas' }, eprs: { name: 'eprs', path: 'product_docs/docs/eprs' }, diff --git a/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx b/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx new file mode 100644 index 00000000000..be0fc262c78 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Administering your cluster" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx b/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx new file mode 100644 index 00000000000..eb1c3efe317 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Cloud Providers" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/getting_started/index.mdx b/product_docs/docs/edbcloud/latest/getting_started/index.mdx new file mode 100644 index 00000000000..6cfbb5a3096 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/getting_started/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Getting Started" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/index.mdx b/product_docs/docs/edbcloud/latest/index.mdx new file mode 100644 index 00000000000..5f83b889891 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/index.mdx @@ -0,0 +1,22 @@ +--- +title: EDB Cloud +directoryDefaults: +description: "EDB Cloud: DBaaS for PostgresSQL " +navigation: + - "#Why EDB Cloud" + - overview + - "#Getting Started" + - getting_started + - "#Guides" + - planning + - using_cluster + - administering_cluster + - cloud_providers + - "#Pricing and Billing" + - pricing_and_billing + - "#Reference" + - reference_api + - reference_cli + - "#Relese Notes" + - release_notes +--- diff --git a/product_docs/docs/edbcloud/latest/overview/01_overview.mdx b/product_docs/docs/edbcloud/latest/overview/01_overview.mdx new file mode 100644 index 00000000000..14df9a3c99c --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/01_overview.mdx @@ -0,0 +1,5 @@ +--- +title: "Overview of Service" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx new file mode 100644 index 00000000000..3cc098fce6c --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx @@ -0,0 +1,5 @@ +--- +title: "Backup and Restore" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx new file mode 100644 index 00000000000..6c4571179ee --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx @@ -0,0 +1,5 @@ +--- +title: "High Availability" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx new file mode 100644 index 00000000000..2cbac89619f --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx @@ -0,0 +1,5 @@ +--- +title: "Security and Compliance " +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/overview/index.mdx b/product_docs/docs/edbcloud/latest/overview/index.mdx new file mode 100644 index 00000000000..295721fd868 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/overview/index.mdx @@ -0,0 +1,10 @@ +--- +title: "Overview" +--- + +Overview of service, run in customer's account, purchase through Azure Marketplace +
+ +overview backup_and_restore high_availibility security_compliance + +
diff --git a/product_docs/docs/edbcloud/latest/planning/index.mdx b/product_docs/docs/edbcloud/latest/planning/index.mdx new file mode 100644 index 00000000000..78b385b4a4b --- /dev/null +++ b/product_docs/docs/edbcloud/latest/planning/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Planning" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx new file mode 100644 index 00000000000..d5dad8d3333 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Pricing and Billing " +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/reference_api/index.mdx b/product_docs/docs/edbcloud/latest/reference_api/index.mdx new file mode 100644 index 00000000000..40ab895905e --- /dev/null +++ b/product_docs/docs/edbcloud/latest/reference_api/index.mdx @@ -0,0 +1,5 @@ +--- +title: "API Reference" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/reference_cli/index.mdx b/product_docs/docs/edbcloud/latest/reference_cli/index.mdx new file mode 100644 index 00000000000..fda15081dca --- /dev/null +++ b/product_docs/docs/edbcloud/latest/reference_cli/index.mdx @@ -0,0 +1,5 @@ +--- +title: "CLI Reference" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/release_notes/index.mdx b/product_docs/docs/edbcloud/latest/release_notes/index.mdx new file mode 100644 index 00000000000..22da4ee7244 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/release_notes/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Release Notes" +--- + +Document content diff --git a/product_docs/docs/edbcloud/latest/using_cluster/index.mdx b/product_docs/docs/edbcloud/latest/using_cluster/index.mdx new file mode 100644 index 00000000000..3a287220539 --- /dev/null +++ b/product_docs/docs/edbcloud/latest/using_cluster/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Using your cluster" +--- + +Document content diff --git a/scripts/source/config_sources.py b/scripts/source/config_sources.py index 6087356a245..fd6b956d8a3 100644 --- a/scripts/source/config_sources.py +++ b/scripts/source/config_sources.py @@ -26,6 +26,7 @@ 'pgpool', 'postgis', 'slony', + 'edbcloud', ] BASE_OUTPUT = {} @@ -53,6 +54,7 @@ { 'index': '1q', 'name': 'Mongo Data Adapter', 'key': 'mongo_data_adapter', 'indent': True }, { 'index': '1r', 'name': 'MySQL Data Adapter', 'key': 'mysql_data_adapter', 'indent': True }, { 'index': '1s', 'name': 'Replication Server', 'key': 'eprs', 'indent': True }, + { 'index': '1t', 'name': 'EDB Cloud', 'key': 'edbcloud', 'indent': True }, ] print('Which sources would you like loaded when you run `yarn develop`?') From b022ff841a594a4736da776b59e67a278d14c32f Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 29 Jun 2021 17:52:46 -0400 Subject: [PATCH 017/317] docs(UPM-872): fixing version in TOC Former-commit-id: 76ca357829dc610615d5d4a4f1c99cc2e5b8a722 --- .../edbcloud/{latest => beta}/administering_cluster/index.mdx | 0 .../docs/edbcloud/{latest => beta}/cloud_providers/index.mdx | 0 .../docs/edbcloud/{latest => beta}/getting_started/index.mdx | 0 product_docs/docs/edbcloud/{latest => beta}/index.mdx | 0 .../docs/edbcloud/{latest => beta}/overview/01_overview.mdx | 0 .../{latest => beta}/overview/02_backup_and_restore.mdx | 0 .../edbcloud/{latest => beta}/overview/03_high_availibility.mdx | 0 .../{latest => beta}/overview/04_security_compliance.mdx | 0 product_docs/docs/edbcloud/{latest => beta}/overview/index.mdx | 2 +- product_docs/docs/edbcloud/{latest => beta}/planning/index.mdx | 0 .../edbcloud/{latest => beta}/pricing_and_billing/index.mdx | 0 .../docs/edbcloud/{latest => beta}/reference_api/index.mdx | 0 .../docs/edbcloud/{latest => beta}/reference_cli/index.mdx | 0 .../docs/edbcloud/{latest => beta}/release_notes/index.mdx | 0 .../docs/edbcloud/{latest => beta}/using_cluster/index.mdx | 0 15 files changed, 1 insertion(+), 1 deletion(-) rename product_docs/docs/edbcloud/{latest => beta}/administering_cluster/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/cloud_providers/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/getting_started/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/01_overview.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/02_backup_and_restore.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/03_high_availibility.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/04_security_compliance.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/overview/index.mdx (68%) rename product_docs/docs/edbcloud/{latest => beta}/planning/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/pricing_and_billing/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/reference_api/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/reference_cli/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/release_notes/index.mdx (100%) rename product_docs/docs/edbcloud/{latest => beta}/using_cluster/index.mdx (100%) diff --git a/product_docs/docs/edbcloud/latest/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/administering_cluster/index.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/index.mdx diff --git a/product_docs/docs/edbcloud/latest/cloud_providers/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/cloud_providers/index.mdx rename to product_docs/docs/edbcloud/beta/cloud_providers/index.mdx diff --git a/product_docs/docs/edbcloud/latest/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/getting_started/index.mdx rename to product_docs/docs/edbcloud/beta/getting_started/index.mdx diff --git a/product_docs/docs/edbcloud/latest/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/index.mdx rename to product_docs/docs/edbcloud/beta/index.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/01_overview.mdx b/product_docs/docs/edbcloud/beta/overview/01_overview.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/01_overview.mdx rename to product_docs/docs/edbcloud/beta/overview/01_overview.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/02_backup_and_restore.mdx rename to product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/03_high_availibility.mdx rename to product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/overview/04_security_compliance.mdx rename to product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx diff --git a/product_docs/docs/edbcloud/latest/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx similarity index 68% rename from product_docs/docs/edbcloud/latest/overview/index.mdx rename to product_docs/docs/edbcloud/beta/overview/index.mdx index 295721fd868..b6cd802a1ad 100644 --- a/product_docs/docs/edbcloud/latest/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -5,6 +5,6 @@ title: "Overview" Overview of service, run in customer's account, purchase through Azure Marketplace
-overview backup_and_restore high_availibility security_compliance +01_overview 02_backup_and_restore high_availibility security_compliance
diff --git a/product_docs/docs/edbcloud/latest/planning/index.mdx b/product_docs/docs/edbcloud/beta/planning/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/planning/index.mdx rename to product_docs/docs/edbcloud/beta/planning/index.mdx diff --git a/product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/pricing_and_billing/index.mdx rename to product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx diff --git a/product_docs/docs/edbcloud/latest/reference_api/index.mdx b/product_docs/docs/edbcloud/beta/reference_api/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/reference_api/index.mdx rename to product_docs/docs/edbcloud/beta/reference_api/index.mdx diff --git a/product_docs/docs/edbcloud/latest/reference_cli/index.mdx b/product_docs/docs/edbcloud/beta/reference_cli/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/reference_cli/index.mdx rename to product_docs/docs/edbcloud/beta/reference_cli/index.mdx diff --git a/product_docs/docs/edbcloud/latest/release_notes/index.mdx b/product_docs/docs/edbcloud/beta/release_notes/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/release_notes/index.mdx rename to product_docs/docs/edbcloud/beta/release_notes/index.mdx diff --git a/product_docs/docs/edbcloud/latest/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx similarity index 100% rename from product_docs/docs/edbcloud/latest/using_cluster/index.mdx rename to product_docs/docs/edbcloud/beta/using_cluster/index.mdx From 441825192c3d2b8bd61a120523e27848b0c198ff Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 29 Jun 2021 20:25:40 -0400 Subject: [PATCH 018/317] docs(UPM-872): overview section drafts and navigation Former-commit-id: 33d45eeaa013db274cfdd584ea88dfcf23e418d1 --- .../docs/edbcloud/beta/overview/01_overview.mdx | 5 ----- .../beta/overview/02_backup_and_restore.mdx | 5 ----- .../beta/overview/02_high_availibility.mdx | 15 +++++++++++++++ .../beta/overview/03_high_availibility.mdx | 5 ----- ...ompliance.mdx => 03_security_compliance.mdx} | 2 ++ .../beta/overview/04_responsibility_model.mdx | 14 ++++++++++++++ .../overview/05_database_version_policy.mdx | 17 +++++++++++++++++ .../docs/edbcloud/beta/overview/06_support.mdx | 12 ++++++++++++ .../docs/edbcloud/beta/overview/index.mdx | 16 +++++++++++----- 9 files changed, 71 insertions(+), 20 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/overview/01_overview.mdx delete mode 100644 product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx delete mode 100644 product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx rename product_docs/docs/edbcloud/beta/overview/{04_security_compliance.mdx => 03_security_compliance.mdx} (63%) create mode 100644 product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx create mode 100644 product_docs/docs/edbcloud/beta/overview/06_support.mdx diff --git a/product_docs/docs/edbcloud/beta/overview/01_overview.mdx b/product_docs/docs/edbcloud/beta/overview/01_overview.mdx deleted file mode 100644 index 14df9a3c99c..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/01_overview.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Overview of Service" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx deleted file mode 100644 index 3cc098fce6c..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/02_backup_and_restore.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Backup and Restore" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx new file mode 100644 index 00000000000..d2e2bcab732 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -0,0 +1,15 @@ +--- +title: "High Availability" +--- + +Reference and link out to Terms of Service. + +High Availability Configuration: + +- EDB Cloud provides built in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. + +- Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. + +- Streaming replication is used + +Reference and link out to Terms of Service (once link is available). diff --git a/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx deleted file mode 100644 index 6c4571179ee..00000000000 --- a/product_docs/docs/edbcloud/beta/overview/03_high_availibility.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "High Availability" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx similarity index 63% rename from product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx rename to product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 2cbac89619f..c8903d8d46c 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -3,3 +3,5 @@ title: "Security and Compliance " --- Document content + +Reference and link out to Terms  diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx new file mode 100644 index 00000000000..a8f7d2f86a2 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -0,0 +1,14 @@ +--- +title: "Responsibility Model" +--- + +EDB Cloud provisions resources in the customer’s cloud account. + +- Create a similar table to https://cloud.ibm.com/docs/databases-for-postgresql?topic=cloud-databases-responsibilities-cloud-databases +detailing out what EDB is responsible for and what the customer is responsible for + +Customers need to understand the problems involved with provisioning. + +Document the security implications of sharing powerful access credentials to their cloud account + + diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx new file mode 100644 index 00000000000..ff256e4e291 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -0,0 +1,17 @@ +--- +title: "Database Version Policy" +--- + +Versions Supported: + +- PostgreSQL versions supported: 10, 11, 12 + +- EDB Postgres Advanced versions supported: 10, 11, 12 + +Maintenance and upgrades: + +- EDB is committed to providing stable, up-to-date versions. We test, evaluate, and release new versions to clusters. + +- Major Version Upgrades: Major versions are supported from the date they are made available until the version is retired from the PostgreSQL community (for PostgreSQL) or until EDB retires a major version of EDB Postgres Advanced Server. + +- Minor Version Upgrades & Maintenance: Minor version and patch updates are handled automatically and are not user configurable. diff --git a/product_docs/docs/edbcloud/beta/overview/06_support.mdx b/product_docs/docs/edbcloud/beta/overview/06_support.mdx new file mode 100644 index 00000000000..d8c25425bce --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/06_support.mdx @@ -0,0 +1,12 @@ +--- +title: "Support" +--- + +Document how and where customers can open support tickets: + +- Support ticket Portal: support.edbcloud.com + +- Chat + + + diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index b6cd802a1ad..298df644b59 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -1,10 +1,16 @@ --- -title: "Overview" +title: "Overview of Service" --- + + +- EDB is a fully managed database as a service offering both PostgreSQL and EDB Postgres Advanced with Oracle Compatibility. + +- This service runs in your cloud account, but is fully managed and operated by the EDB team. + +- This service is available via the Microsoft Azure Marketplace. + + + -Overview of service, run in customer's account, purchase through Azure Marketplace -
-01_overview 02_backup_and_restore high_availibility security_compliance -
From 9f0c3310448850fc77f341a2278bb1319ac16ac2 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 15:45:56 -0400 Subject: [PATCH 019/317] docs(UPM-872): overview section drafts and navigation Former-commit-id: 2c05286b567640a9839c210285ce8455bc0067aa --- .../beta/getting_started/01_connect_cloud_account.mdx | 7 +++++++ .../edbcloud/beta/getting_started/02_configure_acess.mdx | 9 +++++++++ .../edbcloud/beta/getting_started/03_create_cluster.mdx | 5 +++++ .../docs/edbcloud/beta/getting_started/index.mdx | 8 +++++++- 4 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx create mode 100644 product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx create mode 100644 product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx new file mode 100644 index 00000000000..5d83807728c --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -0,0 +1,7 @@ +--- +title: "Connect Cloud Account" +--- + + + +Marketplace Flow (check out confluence example: Get Started with Confluent Cloud on the Azure Marketplace with Commitments diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx new file mode 100644 index 00000000000..9ef6b779d1e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -0,0 +1,9 @@ +--- +title: "Configure Access" +--- + + + +- Explain how to invite users + +- Explain what default roles and permissions are given to new users diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx new file mode 100644 index 00000000000..8fcbc4149ff --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Create Cluster" +--- + +Provide step by step directions on where and how to create a cluster. diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 6cfbb5a3096..9973e740adb 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,5 +1,11 @@ --- +navTitle: Getting Started title: "Getting Started" --- -Document content + +
+ +connect_cloud_account configure_access create_cluster + +
From d7fd48dc0df841dcd9618356d9140031492e3bd1 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 16:26:00 -0400 Subject: [PATCH 020/317] docs(UPM-909): using cluster section drafts and navigation Former-commit-id: 1bbaa306504b1a3e8741733a0614f9672fc28086 --- .../edbcloud/beta/getting_started/index.mdx | 2 +- .../beta/using_cluster/01_cluster_sizing.mdx | 5 ++++ .../using_cluster/02_connect_to_cluster.mdx | 5 ++++ .../03_modify_and_scale_cluster.mdx | 5 ++++ .../using_cluster/04_backup_and_restore.mdx | 28 +++++++++++++++++++ .../05_monitoring_and_logging.mdx | 7 +++++ .../06_analyze_with_superset.mdx | 5 ++++ 7 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 9973e740adb..587561a1fa6 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,6 +1,6 @@ --- -navTitle: Getting Started title: "Getting Started" +indexCards: simple --- diff --git a/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx b/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx new file mode 100644 index 00000000000..588e8de4cca --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx @@ -0,0 +1,5 @@ +--- +title: "Cluster Sizing" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx new file mode 100644 index 00000000000..4cc7bc25134 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Connect to Cluster" +--- + +Explain where a customer can access connection details and connect to their cluster. diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx new file mode 100644 index 00000000000..94c20973713 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -0,0 +1,5 @@ +--- +title: "Modify & Scale Cluster" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx new file mode 100644 index 00000000000..9c461ef4337 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -0,0 +1,28 @@ +--- +title: "Backup and Restore" +--- + +PITR & Restore Points, Redundancy + +Backups: + +- EDB provides automatic backups. Backups are continuously (commit to time period?) taken on clusters. + +- Type of backups: WAL archiving? + +- Retention: Customers can specify the retention period for backups. Include timing of retention. + +- Where are backups stored? Backups are stored in Azure Blob Storage (include which type). Customers are responsible for the charges associated with backup storage, please reference the Azure Blob Storage page for more information. + +Restore: + +- Point in time recovery available. Customers can enter in a timestamp that they want to restore to. Include the increments of time and where a customer can initiate a restore. + +- Customers can restore backups into a new cluster in the same region or a new region. + +- Include which fields are editable by the customers. + +- Archived clusters can be restored to the most recent point in time available. + + + diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx new file mode 100644 index 00000000000..fef028cd55b --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -0,0 +1,7 @@ +--- +title: "Monitoring and Logging" +--- + +All metrics and logs are sent to Azure Monitor. Explain where a customer can navigate to view metrics and logs. + +- Explain what metrics and logs are sent diff --git a/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx new file mode 100644 index 00000000000..60b09ea58f1 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx @@ -0,0 +1,5 @@ +--- +title: "Analyze with Apache Superset" +--- + +Document content From b3aea3ecc5261451e906e8274343d6a8823949eb Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 16:33:53 -0400 Subject: [PATCH 021/317] docs(UPM-908): Planning section drafts and navigation Former-commit-id: 23745ed7e388d205acee43f4bfb46842a63a42c4 --- product_docs/docs/edbcloud/beta/planning/01_migration.mdx | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/planning/01_migration.mdx diff --git a/product_docs/docs/edbcloud/beta/planning/01_migration.mdx b/product_docs/docs/edbcloud/beta/planning/01_migration.mdx new file mode 100644 index 00000000000..030827e5bf8 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/planning/01_migration.mdx @@ -0,0 +1,5 @@ +--- +title: "Migration" +--- + +Document content From 763e77993b3250fc4b2a1c740a65a4a90bb36cf4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:07:25 -0400 Subject: [PATCH 022/317] docs(UPM-910): Administring your cluster section drafts and navigation Former-commit-id: c2a0730eb237eb69a909228b92d86959e7915332 --- .../organization_and_access/01_organizations.mdx | 5 +++++ .../organization_and_access/02_users.mdx | 5 +++++ .../organization_and_access/03_roles.mdx | 5 +++++ .../organization_and_access/index.mdx | 5 +++++ .../security_and_networking/01_encryption.mdx | 5 +++++ .../security_and_networking/02_private_networking.mdx | 10 ++++++++++ .../security_and_networking/03_activity_log.mdx | 11 +++++++++++ .../security_and_networking/index.mdx | 5 +++++ 8 files changed, 51 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx new file mode 100644 index 00000000000..576cecf3578 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -0,0 +1,5 @@ +--- +title: "Organizations" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx new file mode 100644 index 00000000000..31079486d01 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -0,0 +1,5 @@ +--- +title: "Users" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx new file mode 100644 index 00000000000..b6a189ab0e8 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -0,0 +1,5 @@ +--- +title: "Roles" +--- + +Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx new file mode 100644 index 00000000000..b67ff359ce9 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Organization and Access" +--- + +Document content UPM-924 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx new file mode 100644 index 00000000000..9059f98347e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx @@ -0,0 +1,5 @@ +--- +title: "Encryption" +--- + +Define what is done for encryption keys. UPM-929 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx new file mode 100644 index 00000000000..f3506d278f1 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx @@ -0,0 +1,10 @@ +--- +title: "Private Networking" +--- + +Configuration: + +- Private network connectivity can be enabled or disabled +UPM-930 + + diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx new file mode 100644 index 00000000000..3076170e7fb --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx @@ -0,0 +1,11 @@ +--- +title: "Activity Log" +--- + +Also pgaudit / edb audit implications and what we allow customers to configure + +- What events are tracked in Activity Log + +- Define events + +UPM-931 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx new file mode 100644 index 00000000000..80f85bdddc6 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Security and Networking" +--- + +Document content UPM-925 From c85a911e35790ee5893be7a2f904c9bf296ee66c Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:31:16 -0400 Subject: [PATCH 023/317] docs(UPM-911): Pricing and billing section drafts and navigation Former-commit-id: 0e7deda2f8a1c94d045d99a8436c741ef2f0f861 --- .../beta/pricing_and_billing/01_pricing.mdx | 14 ++++++++++++++ .../beta/pricing_and_billing/02_billing.mdx | 8 ++++++++ 2 files changed, 22 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx create mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx new file mode 100644 index 00000000000..5823320b45e --- /dev/null +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx @@ -0,0 +1,14 @@ +--- +title: "Pricing/Billing" +--- + +UPM-932 + +Info on how we bill (including the price metrics), how we meter usage & how often. + +- Price Metric: Virtual Central Processing Unit (vCPU) + +- Hourly metering + +- All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. (We can reference the 'billing through Microsoft Azure docs page) + diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx new file mode 100644 index 00000000000..7294a4e01ab --- /dev/null +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx @@ -0,0 +1,8 @@ +--- +title: "Billing through Microsoft Azure" +--- +How is infrastructure (instances/storage) charged? + +EDB Cloud does not bill for cloud infrastructure costs, including compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run in your own cloud account, and thus infrastructure costs are billed to you by your respective cloud provider(s). + + From d666987fb65b0b803127467a12b2f04cc7e80ae2 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 30 Jun 2021 17:43:10 -0400 Subject: [PATCH 024/317] docs(UPM-912): Cloud Providers section drafts and navigation Former-commit-id: 59e69a6c53188cd1703c1f06486be9bc76f024e2 --- .../beta/cloud_providers/microsoft_azure/01_regions.mdx | 6 ++++++ .../microsoft_azure/02_infrastructure_supported.mdx | 6 ++++++ .../edbcloud/beta/cloud_providers/microsoft_azure/index.mdx | 5 +++++ 3 files changed, 17 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx create mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx new file mode 100644 index 00000000000..17b057d0e0f --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx @@ -0,0 +1,6 @@ +--- +title: "Microsoft Azure - Regions" +navTitle: "Regions" +--- + +UPM-935 List supported region. diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx new file mode 100644 index 00000000000..56865efe274 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx @@ -0,0 +1,6 @@ +--- +title: "Microsoft Azure - Infrastructure Supported" +navTitle: "Infrastructure" +--- + +UPM-936 List supported infrastructure instance types diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx new file mode 100644 index 00000000000..5ba833cb26b --- /dev/null +++ b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Microsoft Azure" +--- + +Document content From 8f6b85763294bd0c28c63b94d6afc73e0b414e9c Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 13:12:39 -0400 Subject: [PATCH 025/317] docs(UPM-872): Changed left navigation bar Former-commit-id: 726e30adf063efcf82848ca1efde52e7c3553746 --- product_docs/docs/edbcloud/beta/index.mdx | 9 +-------- .../edbcloud/beta/{reference_api => reference}/index.mdx | 2 +- product_docs/docs/edbcloud/beta/reference_cli/index.mdx | 5 ----- 3 files changed, 2 insertions(+), 14 deletions(-) rename product_docs/docs/edbcloud/beta/{reference_api => reference}/index.mdx (53%) delete mode 100644 product_docs/docs/edbcloud/beta/reference_cli/index.mdx diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index 5f83b889891..fb0449da962 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -3,20 +3,13 @@ title: EDB Cloud directoryDefaults: description: "EDB Cloud: DBaaS for PostgresSQL " navigation: - - "#Why EDB Cloud" - overview - - "#Getting Started" - getting_started - - "#Guides" - planning - using_cluster - administering_cluster - cloud_providers - - "#Pricing and Billing" - pricing_and_billing - - "#Reference" - - reference_api - - reference_cli - - "#Relese Notes" + - reference - release_notes --- diff --git a/product_docs/docs/edbcloud/beta/reference_api/index.mdx b/product_docs/docs/edbcloud/beta/reference/index.mdx similarity index 53% rename from product_docs/docs/edbcloud/beta/reference_api/index.mdx rename to product_docs/docs/edbcloud/beta/reference/index.mdx index 40ab895905e..d20236bea27 100644 --- a/product_docs/docs/edbcloud/beta/reference_api/index.mdx +++ b/product_docs/docs/edbcloud/beta/reference/index.mdx @@ -1,5 +1,5 @@ --- -title: "API Reference" +title: "Reference" --- Document content diff --git a/product_docs/docs/edbcloud/beta/reference_cli/index.mdx b/product_docs/docs/edbcloud/beta/reference_cli/index.mdx deleted file mode 100644 index fda15081dca..00000000000 --- a/product_docs/docs/edbcloud/beta/reference_cli/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "CLI Reference" ---- - -Document content From 58de87e8c1efc8a61138796d887742c414b11f37 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 18:32:27 -0400 Subject: [PATCH 026/317] docs(UPM-876): Security and Compliance section draft Former-commit-id: 4643e437c36d65b6c7f676dca6824f7abc8491de --- .../beta/overview/03_security_compliance.mdx | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index c8903d8d46c..dafc1d0bf57 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -2,6 +2,27 @@ title: "Security and Compliance " --- -Document content +### Security Governance -Reference and link out to Terms  +- EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- EDB Cloud infrastructure periodically undergoes SOC2 audit trails to ensure that EDB Cloud is always compliant with security requirements. +- All EDB staff undergo background checks before they’re hired. +- All EDB staff required to take mandatory security training. +- EDB Software Development Life Cycle integrates continuous security scans of added/updated code. + + +### EDB Cloud Security Features +- **Customer Data Segregation**: EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. +- **Data Encryption:** EDB Cloud encrypts customer data at motion and at rest (Question about encryption policies). +- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves) +- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center +- **Disaster Recovery and Business Continuity** All components of EDB Cloud infrastructure are highly available and redundant. +- **Incident Response** EDB employs tools and process which monitor the platform and has a dedicated security team and incident response processes. + +### Shared Responsibility +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform, that enable our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model + + + +Reference and link out to Terms From 3e103c3a3555e96be94c39b41cb9b34a3a12a995 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 1 Jul 2021 18:52:43 -0400 Subject: [PATCH 027/317] docs(UPM-876): Security and Compliance section draft (language fixes) Former-commit-id: ea68962586f58fd7d00f48e67a201ec737c10453 --- .../beta/overview/03_security_compliance.mdx | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index dafc1d0bf57..48c4adab083 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -1,27 +1,27 @@ --- -title: "Security and Compliance " +title: "Security and Compliance" --- ### Security Governance -- EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. -- EDB Cloud infrastructure periodically undergoes SOC2 audit trails to ensure that EDB Cloud is always compliant with security requirements. -- All EDB staff undergo background checks before they’re hired. -- All EDB staff required to take mandatory security training. -- EDB Software Development Life Cycle integrates continuous security scans of added/updated code. +- The EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- EDB Cloud infrastructure periodically undergoes SOC2 audit trials to ensure that EDB Cloud is always compliant with security requirements. +- All EDB staff undergo background checks before they are hired. +- All EDB staff are required to take mandatory security training. +- The EDB Software Development Life Cycle integrates continuous security scans of added/updated code. ### EDB Cloud Security Features -- **Customer Data Segregation**: EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Customer Data Segregation:** EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Data Encryption:** EDB Cloud encrypts customer data at motion and at rest (Question about encryption policies). -- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves) -- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center -- **Disaster Recovery and Business Continuity** All components of EDB Cloud infrastructure are highly available and redundant. -- **Incident Response** EDB employs tools and process which monitor the platform and has a dedicated security team and incident response processes. +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question about encryption policies). +- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) +- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. +- **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. +- **Incident Response:** EDB employs tools and processes which monitor the platform and has a dedicated security team as well as incident response processes. ### Shared Responsibility -Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform, that enable our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model for more information. From 37b1718cad2250189c8f888a3bb0d34d31bd82db Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 2 Jul 2021 10:34:37 -0400 Subject: [PATCH 028/317] docs(UPM-876): Security and Compliance section - updates informed by Simon and Nick Former-commit-id: db357e6e53e17ffde61a4ebbfbd2e651addf029e --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 48c4adab083..e6b048bdc22 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -4,7 +4,7 @@ title: "Security and Compliance" ### Security Governance -- The EDB security/compliance officer is responsible for maintaining compliance targets for their entire organization. +- Cloud Security Compliance officer is responsible for maintaining compliance targets for their entire organization. - EDB Cloud infrastructure periodically undergoes SOC2 audit trials to ensure that EDB Cloud is always compliant with security requirements. - All EDB staff undergo background checks before they are hired. - All EDB staff are required to take mandatory security training. @@ -12,9 +12,10 @@ title: "Security and Compliance" ### EDB Cloud Security Features -- **Customer Data Segregation:** EDB Cloud is a multi-tenant application Database as a Service (DBaaS) with logical access segregating each customer’s data. +- **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question about encryption policies). +- **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers define their own set of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question: more details about encryption policies). - **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. - **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. From cf4e8528605a2ee993c84b1ca9def3177b8a69f8 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 2 Jul 2021 12:04:43 -0400 Subject: [PATCH 029/317] docs(UPM-876): Security and Compliance section - language fixes Former-commit-id: f6cae409fa662b4545b8758e23658aa41e6a947f --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index e6b048bdc22..408a7e78860 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -14,7 +14,7 @@ title: "Security and Compliance" ### EDB Cloud Security Features - **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers define their own set of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. +- **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. - **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question: more details about encryption policies). - **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. From 9b546ee71cb74e477e8ccbf0aaa1675d54e733ee Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 6 Jul 2021 10:03:22 -0400 Subject: [PATCH 030/317] docs(UPM-876): Security and Compliance section - addition by Simon Former-commit-id: 0cc72e312baee0d9b44e2c90e2786674f10896f8 --- product_docs/docs/edbcloud/beta/getting_started/index.mdx | 1 + .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 1 + product_docs/docs/edbcloud/beta/overview/index.mdx | 1 + static/edb-icons | 2 +- 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 587561a1fa6..7cb5d7936c7 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,6 +1,7 @@ --- title: "Getting Started" indexCards: simple +description: "Configure your account and create a Postgres cluster" --- diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 74c7b208ea0..a46d262a938 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -12,6 +12,7 @@ title: "Security and Compliance" ### EDB Cloud Security Features +EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud account, isolating your data from other users & giving you control over our access to it. The key security features of EDB Cloud are as follows: - **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. - **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index 298df644b59..69a97bd18ea 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -1,5 +1,6 @@ --- title: "Overview of Service" +description: "Learn about EDB Cloud " --- diff --git a/static/edb-icons b/static/edb-icons index a2b8bbaaaee..334830887c2 160000 --- a/static/edb-icons +++ b/static/edb-icons @@ -1 +1 @@ -Subproject commit a2b8bbaaaee2b60ee11496ecc04d67aa5c753a28 +Subproject commit 334830887c28a38ae37d219065460c9a58c6a270 From 7584c137c8b692460684256453ddc97b702c10d4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 6 Jul 2021 12:53:08 -0400 Subject: [PATCH 031/317] docs(UPM-876): Security and Compliance section - addition by NIck + from Security RACI Former-commit-id: adc220e17d76f09e215f5a82904c870fa871b1fd --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index a46d262a938..cd867202a26 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -14,10 +14,9 @@ title: "Security and Compliance" ### EDB Cloud Security Features EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud account, isolating your data from other users & giving you control over our access to it. The key security features of EDB Cloud are as follows: - **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. -- **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. -- **Multi-tenancy:** EDB Cloud control plane is a multi-tenant application. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. +- **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. -- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest (Question: more details about encryption policies). +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. all network traffic is encrypted using Transport Layer Security (TLS). Encryption for data at rest is automated using encrypted storage volumes. Users can bring their own encryption keys for an additional level of control. - **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. - **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. From d725f03b08001df579116afb4fea6c0ec2c100dc Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 6 Jul 2021 12:57:54 -0400 Subject: [PATCH 032/317] docs(UPM-876): Security and Compliance section - addition by NIck + from Security RACI Former-commit-id: cfc99b9772217c0b46a6e847eae13fc12de2abc5 --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index cd867202a26..8e3ad227198 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -16,7 +16,7 @@ EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud accoun - **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. -- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. all network traffic is encrypted using Transport Layer Security (TLS). Encryption for data at rest is automated using encrypted storage volumes. Users can bring their own encryption keys for an additional level of control. +- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. - **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. - **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. From 321d6824216658081f5cb39803f4ede31ebfcf40 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 6 Jul 2021 13:56:09 -0400 Subject: [PATCH 033/317] docs(UPM-877): Responsibility Model- public summary of Security RACI Former-commit-id: d9fe4622b2ef444b95ea5b7fcd1c6fe4adad0a0f --- .../beta/overview/04_responsibility_model.mdx | 152 +++++++++++++++++- 1 file changed, 146 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index a8f7d2f86a2..fdaf1018ae2 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -1,14 +1,154 @@ --- -title: "Responsibility Model" +title: "EDB Cloud Responsibility Model" --- -EDB Cloud provisions resources in the customer’s cloud account. +Security and confidentiality is a shared responsibility between EDB and our customers. -- Create a similar table to https://cloud.ibm.com/docs/databases-for-postgresql?topic=cloud-databases-responsibilities-cloud-databases -detailing out what EDB is responsible for and what the customer is responsible for +The following EDB Cloud Responsibility Model describes the distribution of specific responsibilities between EDB Cloud and EDB Customers. -Customers need to understand the problems involved with provisioning. -Document the security implications of sharing powerful access credentials to their cloud account +## Planning and Operations Management + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Task + EDB Cloud Responsibility + Customer Responsibility +
Cloud infrastructure availability: compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary + Yes + No +
Database service availability: customers can connect to a database cluster and read / write data + Yes + Yes +
Planning database schema: database query performance is acceptable for the customer's business needs. + No + Yes +
Database cluster capacity planning: the database clusters deployed on the platform are allocated sufficient resources (CPU/RAM/disk) to achieve acceptable performance. Disk space is monitored for exhaustion. + No + Yes +
Database cluster backups: database clusters are configured to back up data at intervals that meet the customer's recovery point objective. + No + Yes +
Database cluster backups: data in database clusters is backed up and made available for restore in a timely manner consistent with the configuration of the database cluster. + Yes + No +
Database cluster backups: database backups can be restored in a timely fashion consistent with the customer's recovery time objective. + No + Yes +
+ + + +## Security and Compliance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Task + EDB Cloud Responsibility + Customer Responsibility +
SOC2 Audit Compliance + Yes + No +
Database cluster credential management: credentials for database clusters are kept secret and rotated as appropriate. + Yes + Yes +
Encryption of customer data at-rest: Data stored in database clusters is encrypted appropriately. + Configuring encryption with appropriate keys + Only in "bring your own key" configurations +
Vulnerability management: operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. + Yes + No +
Vulnerability management: database software is kept up-to-date in accordance with policy. + Yes + No +
Network security: firewalls are configured to appropriately restrict east / west network traffic. + Yes + No +
Network security: firewalls are configured to appropriately restrict north / south network traffic. + Given a customer's network ingress configuration, Starlight is responsible for implementing the correct set of firewall rules. + Customers must configure network ingress policies via the Starlight API to allow traffic only from appropriate sources. +
+ From 406636193d5116d03014d76aab3a98f79bb1a55d Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 6 Jul 2021 14:19:10 -0400 Subject: [PATCH 034/317] docs(UPM-877): Responsibility Model- fixes Former-commit-id: 6a2c9503fe098c8bec4ecdce877c5a140d1e7989 --- .../docs/edbcloud/beta/overview/04_responsibility_model.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index fdaf1018ae2..2fe62d3e0f3 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -143,9 +143,9 @@ The following EDB Cloud Responsibility Model describes the distribution of speci Network security: firewalls are configured to appropriately restrict north / south network traffic. - Given a customer's network ingress configuration, Starlight is responsible for implementing the correct set of firewall rules. + Given a customer's network ingress configuration, EDB Cloud is responsible for implementing the correct set of firewall rules. - Customers must configure network ingress policies via the Starlight API to allow traffic only from appropriate sources. + Customers must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. From f0a98004bb13981c9007524839a4ae58f7a6e7ea Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 6 Jul 2021 22:27:41 +0000 Subject: [PATCH 035/317] Use branch name in edit links Former-commit-id: 9a40b50b25c9d91fbadab49a233ea9245aac189b --- gatsby-node.js | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/gatsby-node.js b/gatsby-node.js index a769df86bb0..a3c15eb30e0 100644 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -28,6 +28,23 @@ const { const isBuild = process.env.NODE_ENV === 'production'; const isProduction = process.env.APP_ENV === 'production'; +const currentBranchName = (() => { + // if this build was triggered by a GH action in response to a PR, + // use the head ref (the branch that someone is requesting be merged) + let branch = process.env.GITHUB_HEAD_REF; + // if this process was otherwise triggered by a GH action, use the current branch name + if (!branch) branch = process.env.GITHUB_REF; + // non-GH Action build? Try actually running Git for the name... + if (!branch) { + try { + branch = execSync('git rev-parse --abbrev-ref HEAD').toString(); + } catch {} + } + if (!branch) branch = isProduction ? 'main' : 'develop'; + + return branch.replace(/^refs\/heads\//, '').replace(/^refs\/tags\//, ''); +})(); + exports.onCreateNode = async ({ node, getNode, actions, loadNodeContent }) => { const { createNodeField } = actions; @@ -238,12 +255,11 @@ const createDoc = (navTree, prevNext, doc, productVersions, actions) => { const isIndexPage = isPathAnIndexPage(doc.fileAbsolutePath); const docsRepoUrl = 'https://github.com/EnterpriseDB/docs'; - const branch = isProduction ? 'main' : 'develop'; const fileUrlSegment = removeTrailingSlash(doc.fields.path) + (isIndexPage ? '/index.mdx' : '.mdx'); - const githubFileLink = `${docsRepoUrl}/commits/${branch}/product_docs/docs${fileUrlSegment}`; - const githubEditLink = `${docsRepoUrl}/edit/${branch}/product_docs/docs${fileUrlSegment}`; + const githubFileLink = `${docsRepoUrl}/commits/${currentBranchName}/product_docs/docs${fileUrlSegment}`; + const githubEditLink = `${docsRepoUrl}/edit/${currentBranchName}/product_docs/docs${fileUrlSegment}`; const githubIssuesLink = `${docsRepoUrl}/issues/new?title=Feedback%20on%20${encodeURIComponent( fileUrlSegment, )}`; @@ -297,13 +313,12 @@ const createAdvocacy = (navTree, prevNext, doc, learn, actions) => { ); const advocacyDocsRepoUrl = 'https://github.com/EnterpriseDB/docs'; - const branch = isProduction ? 'main' : 'develop'; const isIndexPage = isPathAnIndexPage(doc.fileAbsolutePath); const fileUrlSegment = removeTrailingSlash(doc.fields.path) + (isIndexPage ? '/index.mdx' : '.mdx'); - const githubFileLink = `${advocacyDocsRepoUrl}/commits/${branch}/advocacy_docs${fileUrlSegment}`; - const githubEditLink = `${advocacyDocsRepoUrl}/edit/${branch}/advocacy_docs${fileUrlSegment}`; + const githubFileLink = `${advocacyDocsRepoUrl}/commits/${currentBranchName}/advocacy_docs${fileUrlSegment}`; + const githubEditLink = `${advocacyDocsRepoUrl}/edit/${currentBranchName}/advocacy_docs${fileUrlSegment}`; const githubIssuesLink = `${advocacyDocsRepoUrl}/issues/new?title=Regarding%20${encodeURIComponent( fileUrlSegment, )}`; From f3698bdb5e9a70be8c7ac29caddfcbbd93f895a4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 7 Jul 2021 09:36:57 -0400 Subject: [PATCH 036/317] docs(UPM-876): fixes Former-commit-id: 82a0444315753c733565b0a54f0e70bd85a80d1f --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 8e3ad227198..9eac433553d 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -17,7 +17,7 @@ EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud accoun - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. - **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. -- **Logging and Auditing:** EDB Cloud supports Logging and Auditing (Question: Do we provide audit logs to customers or use them for ourselves?) +- **Logging and Auditing:** EDB Cloud supports Logging and Auditing - **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. - **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. - **Incident Response:** EDB employs tools and processes which monitor the platform and has a dedicated security team as well as incident response processes. From 9bbd0f836840632eaf9fcda383f0bae885080375 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 12 Jul 2021 18:07:38 -0400 Subject: [PATCH 037/317] docs(UPM-914): connect to cloud account Former-commit-id: df64820edff4d3c7b27652172ddf3a11653fad49 --- .../01_connect_cloud_account.mdx | 111 +++++++++++++++++- .../beta/getting_started/images/image1.png | 3 + .../beta/getting_started/images/image2.png | 3 + .../beta/getting_started/images/image3.png | 3 + .../beta/getting_started/images/image4.png | 3 + 5 files changed, 121 insertions(+), 2 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/image1.png create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/image2.png create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/image3.png create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/image4.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 5d83807728c..c95df879800 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -2,6 +2,113 @@ title: "Connect Cloud Account" --- - +This topic shows you how to set up UPM Cloud subscription on Azure Marketplace. -Marketplace Flow (check out confluence example: Get Started with Confluent Cloud on the Azure Marketplace with Commitments +## Prerequisites + +EDB Cloud account setup depends on three Azure objects: +1. _Azure Subscription_ - to connect to Azure. + +2. [Azure Active Directory (AD) Application ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal) - to create Azure AD Service principal that provides identity to your organization. + +3. [Azure Resource Group ](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group)- to identify the region and resources to be used by EDB Cloud. + +Ensure that you have an Azure subscription. Secondly, use the instructions in the following link to create [Azure Active Directory (AD) Application and a Service Principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). The Azure AD app should have a _Contributor_ role. As an authentication option for the application, choose _application secret. _Thirdly, create [Azure Resource Group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group). The later can also be created during the subscription. The following table describes the parameters that need to be entered in EDB Cloud subscription form. All, but last one are properties of Azure objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter + Property Of + Name in Azure Portal Form +
Service Principal Name + Azure AD App + Application (client) ID +
Service Principal Secret + Azure AD App + Secret name your assign +
Azure Subscription ID + Azure Subscription + Directory (tenant) ID +
Azure Resource Group + Azure Resource Group + Name you assign +
Your EDB Cloud Organization Name + NA + + Name you assign +
+ + +Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. + + +## Procedure + + + +1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** +2. On the left navigation pane click link **Private Offers + Plans**. Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. You should see the following form: + + + +![*EDB PostgresQL-as-service (preview)*](images/image1.png) + +3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. + + + + + +![*Subscribe to EDB PostgresQL-as-service*](images/image2.png "image_tooltip") + + + +Enter or create a Resource** Group** for your subscription. Select SaaS subscription **Name. **Press the button at the bottom **Review+ subscribe** at the bottom of the form. This will lead to the confirmation form that describes **Terms of use. **Review the terms of use and press the **Subscribe** button at the bottom. This will complete your Azure SaaS subscription and lead you to the following form. \ + + + + +![*Subscription progress](images/image3.png "image_tooltip") + + +4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. Before you click the Configure** account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. +5. After clicking the Configure** account now **button, you should see a form to enter prerequisite parameters. + + + + +![*EDB Cloud Account Form*](images/image4.png "image_tooltip") + + +Fill in the values of your parameters and press **Submit. **If you fill in your parameters correctly, this will lead you to EDB Cloud login form where you can login to your EDB Cloud account using your Azure AD identity. diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image1.png b/product_docs/docs/edbcloud/beta/getting_started/images/image1.png new file mode 100644 index 00000000000..5d4eea5dcca --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/image1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25fbcb44bffd12dcb02b34e25c21cb9bc09d35d20de7427fbdfcddaaeeb3d158 +size 39126 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image2.png b/product_docs/docs/edbcloud/beta/getting_started/images/image2.png new file mode 100644 index 00000000000..98f0fbe1908 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/image2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:126318b8dba65be21b624ae49e5e74ee1bddb93eb0ecdc16766d2e93febcdcf7 +size 80494 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image3.png b/product_docs/docs/edbcloud/beta/getting_started/images/image3.png new file mode 100644 index 00000000000..92db0dfc4ce --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/image3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f96c2121786f0b7d5fff627ff22f3993f6563407567f7ce2fc52550102d749b +size 68212 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image4.png b/product_docs/docs/edbcloud/beta/getting_started/images/image4.png new file mode 100644 index 00000000000..cf4114cbdec --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/image4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78fa39f67b0797336f90e6c520ca3e1dd17cdeacb9dbf47400e3818a3a6cd2a7 +size 45993 From d9fad525928a29dca42a283add70398309986d77 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 12 Jul 2021 18:10:58 -0400 Subject: [PATCH 038/317] docs(UPM-914): connect to cloud account Former-commit-id: 9a3cad3864fa580c304d302b308f1d9ce02bdee5 --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index c95df879800..c5c4ac5917e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -60,7 +60,6 @@ Ensure that you have an Azure subscription. Secondly, use the instructions in t Your EDB Cloud Organization Name - NA From 44e22be37bf9c7a3a7eacfba78bb24328dee388e Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 13 Jul 2021 15:34:51 -0400 Subject: [PATCH 039/317] docs(UPM-914): connect to cloud account, styling text Former-commit-id: a56a49c9ce86faef8d0f66a53eadcb37ddb43223 --- .../01_connect_cloud_account.mdx | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index c5c4ac5917e..79e453bcdc3 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -58,7 +58,7 @@ Ensure that you have an Azure subscription. Secondly, use the instructions in t - Your EDB Cloud Organization Name + Your EDB Cloud Organization Name NA @@ -76,14 +76,14 @@ Ensure that you know where to find the values of the parameters listed in the ta -1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** -2. On the left navigation pane click link **Private Offers + Plans**. Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. You should see the following form: +1. Sign in to Azure portal portal.azure.com and go to Azure `Marketplace` +2. On the left navigation pane click link `Private Offers + Plans`. Find an offer for `EDB PostgresQL-as-service (preview)` from `EnterpriseDB Corporation` and click on it. You should see the following form: ![*EDB PostgresQL-as-service (preview)*](images/image1.png) -3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. +3. In `Select Plan` input, select `Trial` option. Click on `Set up +subscribe` button. That should lead to the form. @@ -93,7 +93,11 @@ Ensure that you know where to find the values of the parameters listed in the ta -Enter or create a Resource** Group** for your subscription. Select SaaS subscription **Name. **Press the button at the bottom **Review+ subscribe** at the bottom of the form. This will lead to the confirmation form that describes **Terms of use. **Review the terms of use and press the **Subscribe** button at the bottom. This will complete your Azure SaaS subscription and lead you to the following form. \ +Enter or create a Resource** Group** for your subscription. Select SaaS subscription `Name.` +Press the button at the bottom `Review+ subscribe` at the bottom of the form. +This will lead to the confirmation form that describes **Terms of use. +**Review the terms of use and press the `Subscribe` button at the bottom. +This will complete your Azure SaaS subscription and lead you to the following form. @@ -101,8 +105,9 @@ Enter or create a Resource** Group** for your subscription. Select SaaS subscrip ![*Subscription progress](images/image3.png "image_tooltip") -4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. Before you click the Configure** account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. -5. After clicking the Configure** account now **button, you should see a form to enter prerequisite parameters. +4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. +Before you click the `Configure account now` button, ensure that you have access to the values of parameters described in the prerequisite section above. +5. After clicking the `Configure account now` button, you should see a form to enter prerequisite parameters. From 07bf8d972e671ae3e96b0aba8797bc47717d34f1 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 13 Jul 2021 18:13:53 -0400 Subject: [PATCH 040/317] docs(UPM-915): configure access Former-commit-id: 750d574f36278d5a689cad86406c504d4dea0861 --- .../01_connect_cloud_account.mdx | 8 ++-- .../getting_started/02_configure_acess.mdx | 38 ++++++++++++++++++- .../{image4.png => configure-edbcloud.png} | 0 .../images/edit-user-roles.png | 3 ++ .../{image1.png => marketplace-preview.png} | 0 .../beta/getting_started/images/roles.png | 3 ++ .../{image2.png => subscribe-to-dbaas.png} | 0 .../{image3.png => subscription-process.png} | 0 .../beta/getting_started/images/users.png | 3 ++ 9 files changed, 49 insertions(+), 6 deletions(-) rename product_docs/docs/edbcloud/beta/getting_started/images/{image4.png => configure-edbcloud.png} (100%) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png rename product_docs/docs/edbcloud/beta/getting_started/images/{image1.png => marketplace-preview.png} (100%) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/roles.png rename product_docs/docs/edbcloud/beta/getting_started/images/{image2.png => subscribe-to-dbaas.png} (100%) rename product_docs/docs/edbcloud/beta/getting_started/images/{image3.png => subscription-process.png} (100%) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/users.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 79e453bcdc3..ec3bf7bf28c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -81,7 +81,7 @@ Ensure that you know where to find the values of the parameters listed in the ta -![*EDB PostgresQL-as-service (preview)*](images/image1.png) +![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) 3. In `Select Plan` input, select `Trial` option. Click on `Set up +subscribe` button. That should lead to the form. @@ -89,7 +89,7 @@ Ensure that you know where to find the values of the parameters listed in the ta -![*Subscribe to EDB PostgresQL-as-service*](images/image2.png "image_tooltip") +![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") @@ -102,7 +102,7 @@ This will complete your Azure SaaS subscription and lead you to the following fo -![*Subscription progress](images/image3.png "image_tooltip") +![*Subscription progress](images/subscription-process.png "image_tooltip") 4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. @@ -112,7 +112,7 @@ Before you click the `Configure account now` button, ensure that you have access -![*EDB Cloud Account Form*](images/image4.png "image_tooltip") +![*EDB Cloud Account Form*](images/configure-edbcloud.png "image_tooltip") Fill in the values of your parameters and press **Submit. **If you fill in your parameters correctly, this will lead you to EDB Cloud login form where you can login to your EDB Cloud account using your Azure AD identity. diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx index 9ef6b779d1e..22db98e209e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -4,6 +4,40 @@ title: "Configure Access" -- Explain how to invite users +EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud Role Based Access Control to grant users access to different parts of the application. + +### Procedure + +After you created your Azure subscription and logged in into EDB Cloud for the first time you should do the following: + +1. Configure organization-wide `Roles`. +2. Invite users from your organization to sign in to EDB Cloud. +3. Assign roles to users using the `Users` screen. + + +### Configure Roles + +Organization wide roles are configured in the following screen: + +![Roles](images/roles.png "organization roles") + + +Use the `Edit` button with a pen icon to edit permissions for a specific role. + + +### Invite Users + +When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud `Users` screen they need to sign in to EDB Cloud using their organization emails. New users signed in to EDB Cloud have a minimum set of permissions. + + +### Assign Roles to Users + +All users logged in to EDB Cloud will be listed in the following screen, sorted by the time of the latest login. + +![Users](images/users.png "list users") + + +To assign appropriate roles to users, first find the right user and click `Edit` button with the pen icon. In the user screen, use the button `Assign Roles` to edit user roles. + +![User Roles](images/edit-user-roles.png "edit user roles") -- Explain what default roles and permissions are given to new users diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image4.png b/product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/images/image4.png rename to product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png b/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png new file mode 100644 index 00000000000..7c539a61b26 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a376c8ea80ff5f35dbc160c8d254526d15906af1292d114b951ee9d49fd13176 +size 57634 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image1.png b/product_docs/docs/edbcloud/beta/getting_started/images/marketplace-preview.png similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/images/image1.png rename to product_docs/docs/edbcloud/beta/getting_started/images/marketplace-preview.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/roles.png b/product_docs/docs/edbcloud/beta/getting_started/images/roles.png new file mode 100644 index 00000000000..eb810f62cfb --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/roles.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef389627a8d41a05f63b8e962fe25eaa937522b8232bba14a30c64495ad0fec6 +size 155970 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image2.png b/product_docs/docs/edbcloud/beta/getting_started/images/subscribe-to-dbaas.png similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/images/image2.png rename to product_docs/docs/edbcloud/beta/getting_started/images/subscribe-to-dbaas.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/image3.png b/product_docs/docs/edbcloud/beta/getting_started/images/subscription-process.png similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/images/image3.png rename to product_docs/docs/edbcloud/beta/getting_started/images/subscription-process.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/users.png b/product_docs/docs/edbcloud/beta/getting_started/images/users.png new file mode 100644 index 00000000000..b2508e4d471 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/users.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c706f713d2af58abb48afc08b0afdae1bf5768de92f73ff7635ce6fbf18c527 +size 171020 From a860bcac8f724af726b2ff761a6226bc50306b42 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 13 Jul 2021 18:32:45 -0400 Subject: [PATCH 041/317] docs(UPM-915): configure access Former-commit-id: e65b13dd35d61709cc6a3206269dea8c78c25e42 --- .../docs/edbcloud/beta/getting_started/02_configure_acess.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx index 22db98e209e..7a299ce12a4 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -36,7 +36,6 @@ All users logged in to EDB Cloud will be listed in the following screen, sorted ![Users](images/users.png "list users") - To assign appropriate roles to users, first find the right user and click `Edit` button with the pen icon. In the user screen, use the button `Assign Roles` to edit user roles. ![User Roles](images/edit-user-roles.png "edit user roles") From fb0c7fd830a4ed2d68aaf7642b4ee41ca7e949ff Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 15 Jul 2021 15:06:44 -0400 Subject: [PATCH 042/317] docs(UPM-915): configure access :new images Former-commit-id: 210e237ec1f0c0ba8785e1b3cba155b9698d74d8 --- .../edbcloud/beta/getting_started/02_configure_acess.mdx | 6 +++++- .../docs/edbcloud/beta/getting_started/images/roles.png | 4 ++-- .../docs/edbcloud/beta/getting_started/images/users.png | 4 ++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx index 7a299ce12a4..b1f13e9a875 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -38,5 +38,9 @@ All users logged in to EDB Cloud will be listed in the following screen, sorted To assign appropriate roles to users, first find the right user and click `Edit` button with the pen icon. In the user screen, use the button `Assign Roles` to edit user roles. -![User Roles](images/edit-user-roles.png "edit user roles") + + + + + diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/roles.png b/product_docs/docs/edbcloud/beta/getting_started/images/roles.png index eb810f62cfb..54ce305b9f8 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/images/roles.png +++ b/product_docs/docs/edbcloud/beta/getting_started/images/roles.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ef389627a8d41a05f63b8e962fe25eaa937522b8232bba14a30c64495ad0fec6 -size 155970 +oid sha256:67f855b34e09ba465e6b17a25aeaef6c28a0210a27c72b86f85b2748faacfa99 +size 47295 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/users.png b/product_docs/docs/edbcloud/beta/getting_started/images/users.png index b2508e4d471..5d00a9e7bcc 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/images/users.png +++ b/product_docs/docs/edbcloud/beta/getting_started/images/users.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2c706f713d2af58abb48afc08b0afdae1bf5768de92f73ff7635ce6fbf18c527 -size 171020 +oid sha256:064865d5ac5192fd7a772fe5c8765e445e4577093ab73001192a8c2bed83b655 +size 55022 From 2ef5a6d50127ad16fb9d8fd191fd87895d680bcd Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 19 Jul 2021 10:54:26 -0400 Subject: [PATCH 043/317] docs(UPM-916): create cluster 1 Former-commit-id: a9e3365f636be1a1db77762d3906529bbf32db6e --- .../beta/getting_started/03_create_cluster.mdx | 15 ++++++++++++++- .../beta/getting_started/images/clusters.png | 3 +++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/clusters.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 8fcbc4149ff..bfd7ef1a106 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,4 +2,17 @@ title: "Create Cluster" --- -Provide step by step directions on where and how to create a cluster. + +### List Clusters +To see all clusters deployed by your organization press `Clusters` in the left navigation panel. + +![Clusters](images/clusters.png "list clusters") + +### Creating New Cluster + +To create new cluster press button `Create New Cluster` on top right. + +!!! Note + Button `Create New Cluster` is also accessible from the `Overview` screen. + +asas diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/clusters.png b/product_docs/docs/edbcloud/beta/getting_started/images/clusters.png new file mode 100644 index 00000000000..5630738020a --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/clusters.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:efd4e3cc5d4ed1a5b4d59bdeca7226304b554d8b66bdd2abc28a900870f213dd +size 66049 From 4f56dc4e2a090ac14eb167886043cd59d5362a58 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 19 Jul 2021 11:52:31 -0400 Subject: [PATCH 044/317] docs(UPM-916): create cluster 2 Former-commit-id: 209b433262516d2ae31325da7a93badf7d6f4725 --- .../beta/getting_started/03_create_cluster.mdx | 12 +++++++++++- .../beta/getting_started/images/create-cluster-1.png | 3 +++ .../beta/getting_started/images/create-cluster-2.png | 3 +++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-1.png create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-2.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index bfd7ef1a106..41ab950376c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -15,4 +15,14 @@ To create new cluster press button `Create New Cluster` on top right. !!! Note Button `Create New Cluster` is also accessible from the `Overview` screen. -asas +Enter `Cluster Name` and `Password`. Select `Database Type` and `Version` of PostgreSQL. Select `Provider` (Azure) and `Region`. + + +![Create Cluster- Name, Password, Database type, Provider and Region](images/create-cluster-1.png "Create Cluster- Name, Password, Db type, Provider and Region") + + +Select `Instance Type`, specify `Storage` and `Profile`. + +![Create Cluster- Instance Type, Storage and Profile](images/create-cluster-2.png "Create Cluster- Create Cluster- Instance Type, Storage and Profile") + +Press `Create Cluster`. diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-1.png b/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-1.png new file mode 100644 index 00000000000..83c5df26799 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c15d2826de005a40a0192802e2a444eb5d7391e5efe2df84ea721778f932f5b +size 86948 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-2.png b/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-2.png new file mode 100644 index 00000000000..e26442434fe --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/create-cluster-2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27e7c6e20c3526e9b14d5e50909e7d779f4ddd40b334587dcc316726942ebd23 +size 78499 From 2eb3162b168418ce2cee1fdf6ddf313a027b5b9f Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 19 Jul 2021 12:33:06 -0400 Subject: [PATCH 045/317] docs(UPM-916): create cluster 3 Former-commit-id: 481b071364903d539a8108ad834b23c05e2b9789 --- .../getting_started/03_create_cluster.mdx | 86 ++++++++++++++++--- 1 file changed, 73 insertions(+), 13 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 41ab950376c..adf1901226e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -1,28 +1,88 @@ --- title: "Create Cluster" --- - -### List Clusters -To see all clusters deployed by your organization press `Clusters` in the left navigation panel. + -![Create Cluster- Name, Password, Database type, Provider and Region](images/create-cluster-1.png "Create Cluster- Name, Password, Db type, Provider and Region") +

Creating a Cluster

-Select `Instance Type`, specify `Storage` and `Profile`. -![Create Cluster- Instance Type, Storage and Profile](images/create-cluster-2.png "Create Cluster- Create Cluster- Instance Type, Storage and Profile") +

First Steps

+ + + + +1. Sign into the [EDB Cloud portal](https://portal.edbcloud.com). + + _Note: You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner._ +2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. +3. Enter a name and password for your cluster. + +

Configure Your Cluster

+ + + + +4. Under **Database Type**, select a type of database. + 2. **PostgreSQL** is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. + 3. **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS, … +5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. +6. Under **Provider**, select a cloud provider for your cluster. + 4. _Note: For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure._ +7. Under **Region**, select the region in which you want your cluster to be deployed. + 5. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. + 6. _Note: Zone-redundant High Availability is on by default. EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region._ +8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. +9. Under **Storage**, select the type and amount of storage needed for your cluster. +10. Under **Profile**, select the database use that best applies to your cluster. +7. **OLAP** (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. +8. **OLTP** (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. +9. **Web** databases are used by web applications and are accessible through a local network or internet connection. + +

Advanced Configuration (Optional)

+ + + + +11. Click on **Advanced Customization** to open more options for your cluster. +12. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. +13. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. The default number of days is 100. +14. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. + +

Create Cluster

+ + + + +15. Click **Create Cluster**. It might take a few minutes to deploy. + +

What’s Next

+ + +Now that you’ve created your cluster, here are some additional resources for cluster use and management: + + + +* [Using your cluster]( ) +* [Administering your cluster]( ) + -Press `Create Cluster`. From f2e1d3d1fd3fdbddf28d2f3004a130ee57930658 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 19 Jul 2021 12:42:15 -0400 Subject: [PATCH 046/317] docs(UPM-916): create cluster 3 Former-commit-id: 539a19267c3214b8421239dbb1aca2479cd962a8 --- .../getting_started/03_create_cluster.mdx | 34 +------------------ 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index adf1901226e..6eb77fc1791 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -1,36 +1,9 @@ --- -title: "Create Cluster" +title: "Creating a Cluster" --- - - - -

Creating a Cluster

- -

First Steps

- - - 1. Sign into the [EDB Cloud portal](https://portal.edbcloud.com). _Note: You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner._ @@ -60,9 +33,6 @@ Conversion notes:

Advanced Configuration (Optional)

- - - 11. Click on **Advanced Customization** to open more options for your cluster. 12. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. 13. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. The default number of days is 100. @@ -71,8 +41,6 @@ Conversion notes:

Create Cluster

- - 15. Click **Create Cluster**. It might take a few minutes to deploy.

What’s Next

From 336a538276224856d5878d978d0610fbdf33fe33 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 19 Jul 2021 15:37:18 -0400 Subject: [PATCH 047/317] docs(UPM-916): create cluster : formatting Former-commit-id: f3917c5b3f758b111b7334545551bb258779c314 --- .../getting_started/03_create_cluster.mdx | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 6eb77fc1791..9458c1a3f45 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,46 +2,46 @@ title: "Creating a Cluster" --- +

First Steps

1. Sign into the [EDB Cloud portal](https://portal.edbcloud.com). +!!! Note + You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner. - _Note: You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner._ -2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. +2. Click the `Create New Cluster` button in the top right of the`Overview` page or `Clusters` page. 3. Enter a name and password for your cluster.

Configure Your Cluster

- - - -4. Under **Database Type**, select a type of database. - 2. **PostgreSQL** is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. - 3. **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS, … +4. Under `Database Type`, select a type of database. + - `PostgreSQL` is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. + - `EnterpriseDB PostgreSQL Advanced Server (EPAS)` is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS. 5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. -6. Under **Provider**, select a cloud provider for your cluster. - 4. _Note: For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure._ -7. Under **Region**, select the region in which you want your cluster to be deployed. - 5. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. - 6. _Note: Zone-redundant High Availability is on by default. EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region._ -8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. -9. Under **Storage**, select the type and amount of storage needed for your cluster. +6. Under `Provider`, select a cloud provider for your cluster. + !!! Note + For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure. +7. Under `Region`, select the region in which you want your cluster to be deployed. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. + !!! Note + Zone-redundant High Availability is on by default. EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. +8. Under `Instance Type`, select the desired instance based on the number of vCPUs and amount of memory offered. +9. Under `Storage`, select the type and amount of storage needed for your cluster. 10. Under **Profile**, select the database use that best applies to your cluster. -7. **OLAP** (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. -8. **OLTP** (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. -9. **Web** databases are used by web applications and are accessible through a local network or internet connection. +- `OLAP` (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. +- `OLTP` (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. +- `Web` databases are used by web applications and are accessible through a local network or internet connection.

Advanced Configuration (Optional)

-11. Click on **Advanced Customization** to open more options for your cluster. -12. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -13. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. The default number of days is 100. -14. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +11. Click on `Advanced Customization` to open more options for your cluster. +12. Under `Number of Connections`, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. +13. Under `Backups`, type or use the arrows to enter the desired number of days you want your data to be retained for backups. +14. Click the toggle under `Networking` to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet.

Create Cluster

-15. Click **Create Cluster**. It might take a few minutes to deploy. +15. Click `Create Cluster`. It might take a few minutes to deploy.

What’s Next

From 53c52a0c83a17c2004008351c032b337d98c44ae Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 20 Jul 2021 09:42:05 -0400 Subject: [PATCH 048/317] docs(UPM-916): create cluster : formatting back to bold Former-commit-id: d8cf79b449e87ae18048809c19f99e2661223555 --- .../getting_started/03_create_cluster.mdx | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 9458c1a3f45..7bb6f8a1c80 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -9,39 +9,39 @@ title: "Creating a Cluster" !!! Note You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner. -2. Click the `Create New Cluster` button in the top right of the`Overview` page or `Clusters` page. +2. Click the **Create New Cluster** button in the top right of the**Overview** page or **Clusters** page. 3. Enter a name and password for your cluster.

Configure Your Cluster

-4. Under `Database Type`, select a type of database. - - `PostgreSQL` is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. - - `EnterpriseDB PostgreSQL Advanced Server (EPAS)` is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS. +4. Under **Database Type**, select a type of database. + - **PostgreSQL** is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. + - **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS. 5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. -6. Under `Provider`, select a cloud provider for your cluster. +6. Under **Provider**, select a cloud provider for your cluster. !!! Note For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure. -7. Under `Region`, select the region in which you want your cluster to be deployed. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. +7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. !!! Note Zone-redundant High Availability is on by default. EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. -8. Under `Instance Type`, select the desired instance based on the number of vCPUs and amount of memory offered. -9. Under `Storage`, select the type and amount of storage needed for your cluster. +8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. +9. Under **Storage**, select the type and amount of storage needed for your cluster. 10. Under **Profile**, select the database use that best applies to your cluster. -- `OLAP` (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. -- `OLTP` (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. -- `Web` databases are used by web applications and are accessible through a local network or internet connection. +- **OLAP** (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. +- **OLTP** (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. +- **Web** databases are used by web applications and are accessible through a local network or internet connection.

Advanced Configuration (Optional)

-11. Click on `Advanced Customization` to open more options for your cluster. -12. Under `Number of Connections`, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -13. Under `Backups`, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -14. Click the toggle under `Networking` to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +11. Click on **Advanced Customization** to open more options for your cluster. +12. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. +13. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. +14. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet.

Create Cluster

-15. Click `Create Cluster`. It might take a few minutes to deploy. +15. Click **Create Cluster**. It might take a few minutes to deploy.

What’s Next

From 190236301db82f1a76f377ff80455f94c0a43e0d Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 20 Jul 2021 09:52:38 -0400 Subject: [PATCH 049/317] docs(UPM-915): configuring access : formatting back to bold Former-commit-id: 6da0f88628fc08701882b5dfd3b24e23c30f32ac --- .../beta/getting_started/02_configure_acess.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx index b1f13e9a875..0dd84ef60e8 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -10,9 +10,9 @@ EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud R After you created your Azure subscription and logged in into EDB Cloud for the first time you should do the following: -1. Configure organization-wide `Roles`. +1. Configure organization-wide **Roles**. 2. Invite users from your organization to sign in to EDB Cloud. -3. Assign roles to users using the `Users` screen. +3. Assign roles to users using the **Users** screen. ### Configure Roles @@ -22,12 +22,12 @@ Organization wide roles are configured in the following screen: ![Roles](images/roles.png "organization roles") -Use the `Edit` button with a pen icon to edit permissions for a specific role. +Use the **Edit** button with a pen icon to edit permissions for a specific role. ### Invite Users -When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud `Users` screen they need to sign in to EDB Cloud using their organization emails. New users signed in to EDB Cloud have a minimum set of permissions. +When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using their organization emails. New users signed in to EDB Cloud have a minimum set of permissions. ### Assign Roles to Users @@ -36,7 +36,7 @@ All users logged in to EDB Cloud will be listed in the following screen, sorted ![Users](images/users.png "list users") -To assign appropriate roles to users, first find the right user and click `Edit` button with the pen icon. In the user screen, use the button `Assign Roles` to edit user roles. +To assign appropriate roles to users, first find the right user and click **Edit** button with the pen icon. In the user screen, use the button **Assign Roles** to edit user roles. From 04ececdcd7231d158f02257df0d506d9a77393f4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 20 Jul 2021 09:54:40 -0400 Subject: [PATCH 050/317] docs(UPM-914): connect cloud account : formatting back to bold Former-commit-id: be9c42d9c7e2908027d8104145454ef7c8f4679e --- .../getting_started/01_connect_cloud_account.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index ec3bf7bf28c..7e8527a221e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -76,14 +76,14 @@ Ensure that you know where to find the values of the parameters listed in the ta -1. Sign in to Azure portal portal.azure.com and go to Azure `Marketplace` -2. On the left navigation pane click link `Private Offers + Plans`. Find an offer for `EDB PostgresQL-as-service (preview)` from `EnterpriseDB Corporation` and click on it. You should see the following form: +1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** +2. On the left navigation pane click link **Private Offers + Plans**. Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. You should see the following form: ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) -3. In `Select Plan` input, select `Trial` option. Click on `Set up +subscribe` button. That should lead to the form. +3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. @@ -93,10 +93,10 @@ Ensure that you know where to find the values of the parameters listed in the ta -Enter or create a Resource** Group** for your subscription. Select SaaS subscription `Name.` -Press the button at the bottom `Review+ subscribe` at the bottom of the form. +Enter or create a Resource** Group** for your subscription. Select SaaS subscription **Name.** +Press the button at the bottom **Review+ subscribe** at the bottom of the form. This will lead to the confirmation form that describes **Terms of use. -**Review the terms of use and press the `Subscribe` button at the bottom. +**Review the terms of use and press the **Subscribe** button at the bottom. This will complete your Azure SaaS subscription and lead you to the following form. @@ -106,8 +106,8 @@ This will complete your Azure SaaS subscription and lead you to the following fo 4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. -Before you click the `Configure account now` button, ensure that you have access to the values of parameters described in the prerequisite section above. -5. After clicking the `Configure account now` button, you should see a form to enter prerequisite parameters. +Before you click the **Configure account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. +5. After clicking the **Configure account now** button, you should see a form to enter prerequisite parameters. From 345cb7f10061bde9f77da087997e89b69071335b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 20 Jul 2021 16:44:25 -0400 Subject: [PATCH 051/317] docs(UPM-916): language fix Former-commit-id: ad68b762f8fc0aed002b51ea943e04d260737346 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 7bb6f8a1c80..41ff5d53c31 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -9,7 +9,7 @@ title: "Creating a Cluster" !!! Note You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner. -2. Click the **Create New Cluster** button in the top right of the**Overview** page or **Clusters** page. +2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster.

Configure Your Cluster

From 23a24080fdc4f80139de1c1265e3740bae7e23e9 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 20 Jul 2021 22:15:26 +0000 Subject: [PATCH 052/317] Improve build action Former-commit-id: 08d6a78d065d4fe2cab2e05e3dfe485ece8ee245 --- .github/workflows/deploy-draft.yml | 68 +++++++++++++++--------------- package.json | 3 +- yarn.lock | 5 +++ 3 files changed, 42 insertions(+), 34 deletions(-) diff --git a/.github/workflows/deploy-draft.yml b/.github/workflows/deploy-draft.yml index 2823de164d3..48f8e1880f7 100644 --- a/.github/workflows/deploy-draft.yml +++ b/.github/workflows/deploy-draft.yml @@ -2,7 +2,11 @@ name: Deploy branch draft on Netlify on: pull_request: types: [labeled, opened, synchronize] - + +concurrency: + group: ${{ github.head_ref }} + cancel-in-progress: true + jobs: build-deploy: if: | @@ -13,20 +17,12 @@ jobs: - name: inject slug/short variables uses: rlespinasse/github-slug-action@v3.x - - name: set STAGE variable in environment for next steps - run: echo "STAGE=pr-${{ github.event.number }}-${{ env.GITHUB_HEAD_REF_SLUG }}" >> $GITHUB_ENV - - - name: create a github deployment - uses: bobheadxi/deployments@v0.5.2 - id: deployment - with: - step: start - token: ${{ secrets.GITHUB_TOKEN }} - env: ${{ env.STAGE }} - ref: ${{ github.head_ref }} + - name: compose a name for the build environment + run: echo "BUILD_ENV_NAME=pr-${{ github.event.number }}-${{ env.GITHUB_HEAD_REF_SLUG }}" >> $GITHUB_ENV - uses: actions/checkout@v2 with: + ref: ${{ github.event.pull_request.head.sha }} fetch-depth: 0 # fetch whole repo so git-restore-mtime can work - name: Adjust file watchers limit @@ -35,10 +31,22 @@ jobs: - uses: actions/setup-node@v1 with: node-version: '14.x' - - name: Install yarn - run: sudo npm -g install yarn + + # ref: https://github.com/actions/cache/blob/main/examples.md#node---yarn + - name: Get yarn cache directory + id: yarn-cache-dir-path + run: echo "::set-output name=dir::$(yarn cache dir)" + + - name: Checking Yarn cache + uses: actions/cache@v2 + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + - name: Yarn install - run: yarn install --immutable + run: npx yarn install --immutable env: NODE_ENV: ${{ secrets.NODE_ENV }} @@ -49,12 +57,11 @@ jobs: path: | public .cache - key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }} - restore-keys: | - ${{ runner.os }}-gatsby-build-develop- + key: ${{ runner.os }}-gatsby-build-draft-${{ github.head_ref }} - name: Fix mtimes run: yarn fix-mtimes --force + - name: Gatsby build run: yarn build env: @@ -66,21 +73,16 @@ jobs: ALGOLIA_INDEX_NAME: edb-docs-staging INDEX_ON_BUILD: false - - name: Netlify deploy - run: | - sudo yarn global add netlify-cli - netlify deploy --dir=public --json | tee deploy_results.json - echo "NETLIFY_DRAFT_URL=`jq -r '.deploy_url' deploy_results.json`" >> $GITHUB_ENV + - name: Deploy to Netlify + id: netlify-deploy + uses: nwtgck/actions-netlify@v1.2.2 + with: + publish-dir: './public' + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: ${{ github.event.pull_request.title }} + enable-commit-comment: false + github-deployment-environment: ${{ env.BUILD_ENV_NAME }} env: NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DEVELOP_SITE_ID }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DEVELOP_SITE_ID }} - - name: update the github deployment status - uses: bobheadxi/deployments@v0.5.2 - if: always() - with: - step: finish - token: ${{ secrets.GITHUB_TOKEN }} - status: ${{ job.status }} - deployment_id: ${{ steps.deployment.outputs.deployment_id }} - env_url: ${{ env.NETLIFY_DRAFT_URL }} diff --git a/package.json b/package.json index 8e8472a2d54..396e7cf98a0 100644 --- a/package.json +++ b/package.json @@ -85,7 +85,8 @@ "remark-stringify": "^8.1.1", "semver-compare": "^1.0.0", "to-vfile": "^6.1.0", - "typescript": "^4.1.3" + "typescript": "^4.1.3", + "yarn": "^1.22.10" }, "repository": { "type": "git", diff --git a/yarn.lock b/yarn.lock index 940459fbad0..c396bcb28f2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -15290,6 +15290,11 @@ yargs@^16.1.0: y18n "^5.0.5" yargs-parser "^20.2.2" +yarn@^1.22.10: + version "1.22.10" + resolved "https://registry.yarnpkg.com/yarn/-/yarn-1.22.10.tgz#c99daa06257c80f8fa2c3f1490724e394c26b18c" + integrity sha512-IanQGI9RRPAN87VGTF7zs2uxkSyQSrSPsju0COgbsKQOOXr5LtcVPeyXWgwVa0ywG3d8dg6kSYKGBuYK021qeA== + yauzl@^2.4.2: version "2.10.0" resolved "https://registry.yarnpkg.com/yauzl/-/yauzl-2.10.0.tgz#c7eb17c93e112cb1086fa6d8e51fb0667b79a5f9" From a6f5aab8bb5030ce7eb0baf58c089475cd57a309 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 20 Jul 2021 22:17:05 +0000 Subject: [PATCH 053/317] avoid need to merge main for auto-build Former-commit-id: d1d6ebf27549a8dd1b8f53172425e9f44568927e --- .github/workflows/deploy-draft.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-draft.yml b/.github/workflows/deploy-draft.yml index 48f8e1880f7..3bbb0154dae 100644 --- a/.github/workflows/deploy-draft.yml +++ b/.github/workflows/deploy-draft.yml @@ -1,6 +1,6 @@ name: Deploy branch draft on Netlify on: - pull_request: + pull_request_target: types: [labeled, opened, synchronize] concurrency: From 9f39c365c31a87ab05da5a522c40baf031d96258 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Tue, 20 Jul 2021 22:18:42 +0000 Subject: [PATCH 054/317] forget it, gonna just fix merge Former-commit-id: 24067d5d8b06de6bc4246bdcff7395b61598966b --- .github/workflows/deploy-draft.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-draft.yml b/.github/workflows/deploy-draft.yml index 3bbb0154dae..48f8e1880f7 100644 --- a/.github/workflows/deploy-draft.yml +++ b/.github/workflows/deploy-draft.yml @@ -1,6 +1,6 @@ name: Deploy branch draft on Netlify on: - pull_request_target: + pull_request: types: [labeled, opened, synchronize] concurrency: From ff3cd5e791a08da4150a0f2678e398f1f67b8c18 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 20 Jul 2021 19:50:54 -0400 Subject: [PATCH 055/317] docs(UPM-926): organizations 1 Former-commit-id: 21b68580baded935e847d55eb89b6ca48525d7e0 --- .../organization_and_access/01_organizations.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index 576cecf3578..f47d91f97fa 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -2,4 +2,10 @@ title: "Organizations" --- -Document content + +* For each customer subscribed to EDB Cloud there is a unique **Organization**. Thus an **Organization** is synonymous with a customer. +* **Organizations** subscribed to EDB Cloud are completely isolated from each other. Each **Organization’s** database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. +* The identity of the **Organization** is established through Azure Active Directory (AD). +* During subscription to EDB Cloud, the Azure AD owned by the **Organization** is linked to EDB Cloud and users which belong to that AD can login to EDB Cloud with minimum access privileges. +* EDB Cloud supports Role Based Access Control policies. A user with **owner** Role may define their own sets of Roles which will be applied across the **Organization**. +* A user with **owner** Role may assign Roles to other users from the same **Organization** to grant them access to different parts of EDB Cloud. From 17092afb55409fc594cb4aa09b4c583566063165 Mon Sep 17 00:00:00 2001 From: skrivov-edb <62944071+skrivov-edb@users.noreply.github.com> Date: Thu, 22 Jul 2021 15:29:50 -0400 Subject: [PATCH 056/317] Update index.mdx Former-commit-id: 29a9cea9aab7cd297215124ad442abb29bce605d --- product_docs/docs/edbcloud/beta/release_notes/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/release_notes/index.mdx b/product_docs/docs/edbcloud/beta/release_notes/index.mdx index 22da4ee7244..abc7ba26cbd 100644 --- a/product_docs/docs/edbcloud/beta/release_notes/index.mdx +++ b/product_docs/docs/edbcloud/beta/release_notes/index.mdx @@ -2,4 +2,4 @@ title: "Release Notes" --- -Document content +Document content test From ade4806fe0a6633f0660eaa5bf5f15fa70b3c926 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 22 Jul 2021 16:07:06 -0400 Subject: [PATCH 057/317] docs(UPM-916): crete cluster edit Former-commit-id: 8ec8c22c1470092b7fdbabc254873ef8ef5ea83e --- .../organization_and_access/images/map1.puml | 56 +++++++++++++++++++ .../images/assign-roles.png | 3 + .../security_and_networking/images/users.png | 3 + .../getting_started/03_create_cluster.mdx | 4 +- 4 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml new file mode 100644 index 00000000000..76508bc667a --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml @@ -0,0 +1,56 @@ +@startuml +left to right direction +rectangle "EDB Cloud" as src { + + + rectangle "EDB Cloud Clusters" as edbclusters { + database "PG Cluster" as edbcl1 + database "EPAS Cluster" as edbcl2 + + } + + rectangle "EDB Cloud Users" { + (Tom:{reader}) + (Jerry:{owner}) + (Louis:{}) + + } + + [EDB Cloud org: acmebank-com] as org + +} + +rectangle Azure as tgt { + + rectangle "Azure AD" { + (Tom:member) + (Jerry:member) + (Louis:member) + + } + + rectangle "k8s Clusters" as azureclusters { + rectangle "us-east" as k1 { + database "PG Cluster" as azuredbcl1 + + } + rectangle "japan-west" as k2 { + database "EPAS Cluster" as azuredbcl2 + } + } + [Azure AD tenant:: acmebank.com] as AD + + (Jerry:member) -> azureclusters: owns +} + +src -[hidden]d-> tgt +azureclusters -[hidden]u-> edbclusters +org <-> AD: "1:1" +(Tom:{reader}) <- (Tom:member) +(Jerry:{owner})<- (Jerry:member) +(Louis:{}) <- (Louis:member) + + +edbcl1 <- azuredbcl1 +edbcl2 <- azuredbcl2 +@enduml diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png new file mode 100644 index 00000000000..c88c0e1665b --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28e916e18c2d8f6b45677b146e22bcdee4281f44dd90d1c830524f8bc7cdeae0 +size 57147 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png new file mode 100644 index 00000000000..d7991f425df --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:664251a723276272129cc79d30446d102ca4936b9946a8017abaddb34441baf7 +size 44124 diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 41ff5d53c31..9cb019e3584 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -15,8 +15,8 @@ title: "Creating a Cluster"

Configure Your Cluster

4. Under **Database Type**, select a type of database. - - **PostgreSQL** is an open-source object-relational database management system. Choosing this option will build your cloud on a Postgres engine. - - **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible server built on top of Postgres. If your organization already uses EPAS. + - **PostgreSQL** is an open-source object-relational database management system. + - **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note From dd9dfe801e6e680698dd0c5723f02567223ca5f3 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 22 Jul 2021 16:37:39 -0400 Subject: [PATCH 058/317] set up structure for release notes Former-commit-id: f9d3fba7010200cafeb130f3099fcb69add2b867 --- .../docs/edbcloud/beta/release_notes/index.mdx | 6 ++++++ .../edbcloud/beta/release_notes/prev_rel_notes.mdx | 13 +++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx diff --git a/product_docs/docs/edbcloud/beta/release_notes/index.mdx b/product_docs/docs/edbcloud/beta/release_notes/index.mdx index abc7ba26cbd..1ad37dcef56 100644 --- a/product_docs/docs/edbcloud/beta/release_notes/index.mdx +++ b/product_docs/docs/edbcloud/beta/release_notes/index.mdx @@ -2,4 +2,10 @@ title: "Release Notes" --- +<<<<<<< Updated upstream Document content test +======= +| Version | Release Date | +| ------- | ------------ | +| [Preview](prev_rel_notes) | Aug 2021 | | +>>>>>>> Stashed changes diff --git a/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx b/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx new file mode 100644 index 00000000000..e17aa22fe20 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx @@ -0,0 +1,13 @@ +--- +title: "Preview" +--- + +New features in the preview release include: + +| Description | Type | ID | +| ----------- | ---- | -- | +| Backup and Restore | New Feature | +| Backend logic for cluster creation and editing clusters | New Feature | +| Automated data plane provisioning | New Feature | + + From 089bb6c0dc3cd91f5c1a51f37c678393a2773383 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 23 Jul 2021 09:58:35 -0400 Subject: [PATCH 059/317] docs(UPM-876): removed most content from security and compliance Former-commit-id: 65ea75280ee2900bb2ecdd5c6488f97d7d983031 --- .../beta/overview/03_security_compliance.mdx | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 9eac433553d..863fe0b67ef 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -1,26 +1,14 @@ --- -title: "Security and Compliance" +title: "Security Features" --- -### Security Governance - -- Cloud Security Compliance officer is responsible for maintaining compliance targets for their entire organization. -- EDB Cloud infrastructure periodically undergoes SOC2 audit trials to ensure that EDB Cloud is always compliant with security requirements. -- All EDB staff undergo background checks before they are hired. -- All EDB staff are required to take mandatory security training. -- The EDB Software Development Life Cycle integrates continuous security scans of added/updated code. - - ### EDB Cloud Security Features EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud account, isolating your data from other users & giving you control over our access to it. The key security features of EDB Cloud are as follows: - **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. - **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. - + - **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. - **Logging and Auditing:** EDB Cloud supports Logging and Auditing -- **Backups:** EDB Cloud data is continuously replicated from the production to the hot standby data center. -- **Disaster Recovery and Business Continuity:** All components of EDB Cloud infrastructure are highly available and redundant. -- **Incident Response:** EDB employs tools and processes which monitor the platform and has a dedicated security team as well as incident response processes. ### Shared Responsibility Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model for more information. From 02404614a97ca9d61a0081bd990b7b09f40eb80d Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 23 Jul 2021 15:12:33 -0400 Subject: [PATCH 060/317] docs(UPM-925): organization diagram and caption Former-commit-id: 1e26dbde5cc03332207e8813df24e6f21a9919b7 --- .../01_organizations.mdx | 12 +++++ .../organization_and_access/images/map1.puml | 50 +++++++++++-------- .../images/org-map.png | 3 ++ 3 files changed, 44 insertions(+), 21 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index f47d91f97fa..90894711be3 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -9,3 +9,15 @@ title: "Organizations" * During subscription to EDB Cloud, the Azure AD owned by the **Organization** is linked to EDB Cloud and users which belong to that AD can login to EDB Cloud with minimum access privileges. * EDB Cloud supports Role Based Access Control policies. A user with **owner** Role may define their own sets of Roles which will be applied across the **Organization**. * A user with **owner** Role may assign Roles to other users from the same **Organization** to grant them access to different parts of EDB Cloud. + + +![*EDB Cloud and Azure*](images/org-map.png ) + +The diagram illustrates a mapping between objects that exist within EDB Cloud (box on the left) and Azure cloud (box on the right). +Organization AcmeBank owns Azure subscription and Azure Active directory (Azure AD) acmebank.com. +After AcmeBank purchased subscribe to EDB Cloud, an Organization (org) acmebank-com was created. +After that, members of acmebank.com Azure AD Tom and Jerry can sign in to EDB Cloud. +Users Tom and Jerry have different privileges within EDB Cloud, defined by EDB Cloud Roles. +Jerry, a user with owner Role can create and own PostgreSQL and EPAS clusters. +Those clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB Cloud. + diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml index 76508bc667a..61103847d67 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml @@ -1,54 +1,62 @@ @startuml -left to right direction -rectangle "EDB Cloud" as src { +!pragma revision 1 +!includeurl https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml + +!define AzurePuml https://raw.githubusercontent.com/plantuml-stdlib/Azure-PlantUML/master/dist +!includeurl AzurePuml/AzureCommon.puml +!includeurl AzurePuml/Databases/AzureDatabaseForPostgreSQL.puml +!includeurl AzurePuml/Identity/AzureActiveDirectoryB2C.puml +!includeurl AzurePuml/Identity/AzureActiveDirectoryDomainServices.puml +left to right direction +LAYOUT_WITH_LEGEND() +rectangle "EDB Cloud" as src { rectangle "EDB Cloud Clusters" as edbclusters { - database "PG Cluster" as edbcl1 - database "EPAS Cluster" as edbcl2 + AzureDatabaseForPostgreSQL(edbcl1, "PG Cluster","DB cluster1" ) + AzureDatabaseForPostgreSQL(edbcl2, "EPAS Cluster","DB cluster2" ) } rectangle "EDB Cloud Users" { - (Tom:{reader}) - (Jerry:{owner}) - (Louis:{}) + Person(tom2, "Tom:{reader}") + Person(jerry2, "Jerry:{owner}") } - [EDB Cloud org: acmebank-com] as org + + AzureActiveDirectoryB2C(org, "EDB Cloud Organization ", "org acmebank-com") } rectangle Azure as tgt { - rectangle "Azure AD" { - (Tom:member) - (Jerry:member) - (Louis:member) + rectangle "Azure AD Members" { + Person(tom, "Tom") + Person(jerry, "Jerry") } - rectangle "k8s Clusters" as azureclusters { + rectangle "Regions" as regions { rectangle "us-east" as k1 { - database "PG Cluster" as azuredbcl1 + AzureDatabaseForPostgreSQL(azuredbcl1, "PG Cluster","DB cluster1" ) } rectangle "japan-west" as k2 { - database "EPAS Cluster" as azuredbcl2 + AzureDatabaseForPostgreSQL(azuredbcl2, "EPAS Cluster","DB cluster2" ) } } - [Azure AD tenant:: acmebank.com] as AD - (Jerry:member) -> azureclusters: owns + AzureActiveDirectoryDomainServices(AD, "Azure AD Tenant", "tenant acmebank.com") + jerry -> regions: owns } src -[hidden]d-> tgt -azureclusters -[hidden]u-> edbclusters +regions -[hidden]u-> edbclusters org <-> AD: "1:1" -(Tom:{reader}) <- (Tom:member) -(Jerry:{owner})<- (Jerry:member) -(Louis:{}) <- (Louis:member) +tom2<- tom +jerry2<- jerry + edbcl1 <- azuredbcl1 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png new file mode 100644 index 00000000000..5b7294122bc --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27cb7cedaf70161734a2a3691f232cc396232996bfaa74f4b41bc1e6b990b66b +size 79714 From a925dbca139363fcc87d38bb25c8f5fe0a4e3b51 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 23 Jul 2021 17:09:31 -0400 Subject: [PATCH 061/317] docs(UPM-925): organization diagram ratio fix Former-commit-id: 537fbf8e309cdb18378dd5838039a0ab0cab78e7 --- .../organization_and_access/01_organizations.mdx | 2 +- .../organization_and_access/images/map1.puml | 3 +++ .../organization_and_access/images/org-map.png | 3 --- .../organization_and_access/images/orgmap.png | 3 +++ 4 files changed, 7 insertions(+), 4 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index 90894711be3..c8fe61cc576 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -11,7 +11,7 @@ title: "Organizations" * A user with **owner** Role may assign Roles to other users from the same **Organization** to grant them access to different parts of EDB Cloud. -![*EDB Cloud and Azure*](images/org-map.png ) +![*EDB Cloud and Azure*](images/orgmap.png ) The diagram illustrates a mapping between objects that exist within EDB Cloud (box on the left) and Azure cloud (box on the right). Organization AcmeBank owns Azure subscription and Azure Active directory (Azure AD) acmebank.com. diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml index 61103847d67..a65df61cb2f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml @@ -1,6 +1,9 @@ @startuml + +!pragma ratio 1 !pragma revision 1 + !includeurl https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml !define AzurePuml https://raw.githubusercontent.com/plantuml-stdlib/Azure-PlantUML/master/dist diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png deleted file mode 100644 index 5b7294122bc..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:27cb7cedaf70161734a2a3691f232cc396232996bfaa74f4b41bc1e6b990b66b -size 79714 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png new file mode 100644 index 00000000000..bab6d813386 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:389ca801162844471e3f50c4720c7984e550fb22b952d51cf0c305f90a0458b1 +size 47838 From 584cc8a0965061b340fb616d3592cade364325c6 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 23 Jul 2021 19:29:21 -0400 Subject: [PATCH 062/317] docs(UPM-925): organization diagram ratio fix Former-commit-id: 0a33db8fe6abf31dcbddf090708849f8de91aa44 --- .../organization_and_access/01_organizations.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index c8fe61cc576..d3d556702e1 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -10,10 +10,11 @@ title: "Organizations" * EDB Cloud supports Role Based Access Control policies. A user with **owner** Role may define their own sets of Roles which will be applied across the **Organization**. * A user with **owner** Role may assign Roles to other users from the same **Organization** to grant them access to different parts of EDB Cloud. +The following diagram illustrates a mapping between objects that exist within EDB Cloud (box on the left) and Azure cloud (box on the right). ![*EDB Cloud and Azure*](images/orgmap.png ) -The diagram illustrates a mapping between objects that exist within EDB Cloud (box on the left) and Azure cloud (box on the right). + Organization AcmeBank owns Azure subscription and Azure Active directory (Azure AD) acmebank.com. After AcmeBank purchased subscribe to EDB Cloud, an Organization (org) acmebank-com was created. After that, members of acmebank.com Azure AD Tom and Jerry can sign in to EDB Cloud. From 4fcd3646d9cf89e215e7e5269ca7fa55fd9713e2 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 23 Jul 2021 19:41:04 -0400 Subject: [PATCH 063/317] docs(UPM-926): Users Former-commit-id: d48a373803f3478bddfc1ed817ac99febafda17e --- .../organization_and_access/02_users.mdx | 17 ++++++++++++++++- .../images/edit-user.png | 3 +++ .../organization_and_access/images/users.png | 3 +++ 3 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 31079486d01..d4525518873 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,5 +1,20 @@ --- title: "Users" --- +Users with access to Admin screen can view all users logged in to EDB Cloud. The list of users is sorted by the time of the latest login. + +!!! Note + Preview release of EDB Cloud contains only minimum viable functionality for managing Users and Role Based Access Control to EDB Cloud. + +!!! Note + In the upcoming release version of EDB Cloud we will add search functionality as well as many other features to the users list. + +![Users](images/users.png "Users") + +To assign appropriate roles to users, first find the right user and click the **Edit ** button with the pen icon. In the user screen, use the button **Assign Roles** to edit user roles. + + +![Edit User Roles](images/edit-user.png "Edit User Roles") + +To learn about Roles and how roles define User permissions to various functionalities of EDB Cloud [click here](https://docs.google.com/document/d/13GyHBRYt8fpNINQU6JcqEnuJI7fv33tJzIaPF4_Pcp4/edit#) -Document content diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png new file mode 100644 index 00000000000..0158b184e12 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:549cd6499692f3f80b26ed52ffed6f9007d499bd3441f7f4ed9f02d565cfa1d5 +size 70814 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png new file mode 100644 index 00000000000..fff36422bcf --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7bf715c2f35f52511dac5b1736d7850fb83763a08d2989f9efd19e78075db08 +size 55153 From 83a369e0b387fd62d5f92ff499bee22e093d2b40 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 26 Jul 2021 21:13:08 -0400 Subject: [PATCH 064/317] docs(UPM-916): Create cluster. Fixing select value style Former-commit-id: 63e288c4af966778cb2e184e53d9f0e1f6f33f01 --- .../beta/getting_started/03_create_cluster.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 9cb019e3584..b09b3fb39f6 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -15,8 +15,8 @@ title: "Creating a Cluster"

Configure Your Cluster

4. Under **Database Type**, select a type of database. - - **PostgreSQL** is an open-source object-relational database management system. - - **EnterpriseDB PostgreSQL Advanced Server (EPAS)** is EDB’s secure, Oracle-compatible PostgreSQL. + - *PostgreSQL* is an open-source object-relational database management system. + - *EnterpriseDB PostgreSQL Advanced Server (EPAS)* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note @@ -27,9 +27,9 @@ title: "Creating a Cluster" 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. 10. Under **Profile**, select the database use that best applies to your cluster. -- **OLAP** (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. -- **OLTP** (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. -- **Web** databases are used by web applications and are accessible through a local network or internet connection. +- *OLAP* (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. +- *OLTP* (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. +- *Web* databases are used by web applications and are accessible through a local network or internet connection.

Advanced Configuration (Optional)

From 0f34582d3aee06912dcf0ebd2c0b132c0e5ab4e4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 26 Jul 2021 21:47:46 -0400 Subject: [PATCH 065/317] docs(UPM-914): Formatting table Former-commit-id: 64e69430384ca7a736ea27a78bd76df377da8d47 --- .../01_connect_cloud_account.mdx | 58 +++---------------- 1 file changed, 7 insertions(+), 51 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 7e8527a221e..b0f36b46472 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -16,57 +16,13 @@ EDB Cloud account setup depends on three Azure objects: Ensure that you have an Azure subscription. Secondly, use the instructions in the following link to create [Azure Active Directory (AD) Application and a Service Principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). The Azure AD app should have a _Contributor_ role. As an authentication option for the application, choose _application secret. _Thirdly, create [Azure Resource Group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group). The later can also be created during the subscription. The following table describes the parameters that need to be entered in EDB Cloud subscription form. All, but last one are properties of Azure objects. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter - Property Of - Name in Azure Portal Form -
Service Principal Name - Azure AD App - Application (client) ID -
Service Principal Secret - Azure AD App - Secret name your assign -
Azure Subscription ID - Azure Subscription - Directory (tenant) ID -
Azure Resource Group - Azure Resource Group - Name you assign -
Your EDB Cloud Organization Name - NA - - Name you assign -
+| Parameter | Property Of | Name in Azure Portal Form | +| ----------------------------- | ----------------------------- | ------------------------- | +| **Service Principal Name** | Azure AD App | Application (client) ID | +| **Service Principal Secret** | Azure AD App | Secret name your assign | +| **Azure Subscription ID** | Azure Subscription | Directory (tenant) ID | +| **Azure Resource Group** | Azure Resource Group | Name you assign | +| **Your EDB Cloud Organization Name** | NA | Name you assign | Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. From 4369f24f645db5e705e67354bb25c3797da7dec1 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 26 Jul 2021 21:57:21 -0400 Subject: [PATCH 066/317] docs(UPM-877): Formatting table Former-commit-id: 2bd4446b4c2952e879613933bf77e36c27ff42ca --- .../beta/overview/04_responsibility_model.mdx | 152 +++--------------- 1 file changed, 20 insertions(+), 132 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index 2fe62d3e0f3..308a22a9132 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -10,72 +10,16 @@ The following EDB Cloud Responsibility Model describes the distribution of speci ## Planning and Operations Management - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Task - EDB Cloud Responsibility - Customer Responsibility -
Cloud infrastructure availability: compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary - Yes - No -
Database service availability: customers can connect to a database cluster and read / write data - Yes - Yes -
Planning database schema: database query performance is acceptable for the customer's business needs. - No - Yes -
Database cluster capacity planning: the database clusters deployed on the platform are allocated sufficient resources (CPU/RAM/disk) to achieve acceptable performance. Disk space is monitored for exhaustion. - No - Yes -
Database cluster backups: database clusters are configured to back up data at intervals that meet the customer's recovery point objective. - No - Yes -
Database cluster backups: data in database clusters is backed up and made available for restore in a timely manner consistent with the configuration of the database cluster. - Yes - No -
Database cluster backups: database backups can be restored in a timely fashion consistent with the customer's recovery time objective. - No - Yes -
+| Task | EDB Cloud Responsibility | Customer Responsibility | +| ----- | ------------------------- | ------------------------ | +| **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary | Yes | No | +| **Database service availability:** customers can connect to a database cluster and read / write data | Yes | Yes | +| **Planning database schema:** database query performance is acceptable for the customer's business needs. | No | Yes | +| **Database cluster capacity planning:** the database clusters deployed on the platform are allocated sufficient resources (CPU/RAM/disk) to achieve acceptable performance. Disk space is monitored for exhaustion. | No | Yes | +| **Database cluster backups:** database clusters are configured to back up data at intervals that meet the customer's recovery point objective. | No | Yes | +| **Database cluster backups:** data in database clusters is backed up and made available for restore in a timely manner consistent with the configuration of the database cluster. | Yes | No | +| **Database cluster backups:** database backups can be restored in a timely fashion consistent with the customer's recovery time objective. | No | Yes | + @@ -83,72 +27,16 @@ The following EDB Cloud Responsibility Model describes the distribution of speci - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Task - EDB Cloud Responsibility - Customer Responsibility -
SOC2 Audit Compliance - Yes - No -
Database cluster credential management: credentials for database clusters are kept secret and rotated as appropriate. - Yes - Yes -
Encryption of customer data at-rest: Data stored in database clusters is encrypted appropriately. - Configuring encryption with appropriate keys - Only in "bring your own key" configurations -
Vulnerability management: operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. - Yes - No -
Vulnerability management: database software is kept up-to-date in accordance with policy. - Yes - No -
Network security: firewalls are configured to appropriately restrict east / west network traffic. - Yes - No -
Network security: firewalls are configured to appropriately restrict north / south network traffic. - Given a customer's network ingress configuration, EDB Cloud is responsible for implementing the correct set of firewall rules. - Customers must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. -
+| Task | EDB Cloud Responsibility | Customer Responsibility | +| ----- | ------------------------- | ------------------------ | +| **SOC2 Audit Compliance** | Yes | No | +| **Database cluster credential management:** credentials for database clusters are kept secret and rotated as appropriate. | Yes | Yes | +| **Encryption of customer data at-rest:** Data stored in database clusters is encrypted appropriately. | Configuring encryption with appropriate keys | Only in "bring your own key" configurations | +| **Vulnerability management:** operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. | Yes | No | +| **Vulnerability management:** database software is kept up-to-date in accordance with policy. | Yes | No | +| **Network security:** firewalls are configured to appropriately restrict east / west network traffic. | Yes | No | +| **Network security:** firewalls are configured to appropriately restrict north / south network traffic. | Given a customer's network ingress configuration, EDB Cloud is responsible for implementing the correct set of firewall rules. | Customers must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. | + From 10d8bc9ffbc44bf1993812630a3df5c81e61330b Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 27 Jul 2021 14:56:52 -0400 Subject: [PATCH 067/317] Update 02_users.mdx Former-commit-id: 000d9f52a85587de54ff79092644fe426f8eda47 --- .../organization_and_access/02_users.mdx | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index d4525518873..abd4de51214 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,20 +1,25 @@ --- title: "Users" --- -Users with access to Admin screen can view all users logged in to EDB Cloud. The list of users is sorted by the time of the latest login. +Users with access to the Admin screen can view all users that are logged in. The list of users is sorted by the time of the latest login. !!! Note - Preview release of EDB Cloud contains only minimum viable functionality for managing Users and Role Based Access Control to EDB Cloud. +The preview release contains only the minimum viable functionality for managing users and role based access control. -!!! Note - In the upcoming release version of EDB Cloud we will add search functionality as well as many other features to the users list. +EDB will add search functionality as well as many other features for managing users in subsequent releases. +!!! ![Users](images/users.png "Users") -To assign appropriate roles to users, first find the right user and click the **Edit ** button with the pen icon. In the user screen, use the button **Assign Roles** to edit user roles. +To assign appropriate roles to users: +1. Navigate to Admin > Users. +2. Select the edit icon for the user. +3. Select **Assign Roles**. +4. Select or deselect roles for the user. +5. Select **Submit**. ![Edit User Roles](images/edit-user.png "Edit User Roles") -To learn about Roles and how roles define User permissions to various functionalities of EDB Cloud [click here](https://docs.google.com/document/d/13GyHBRYt8fpNINQU6JcqEnuJI7fv33tJzIaPF4_Pcp4/edit#) +To learn about roles and how roles define user permissions to various functionalities [click here](https://docs.google.com/document/d/13GyHBRYt8fpNINQU6JcqEnuJI7fv33tJzIaPF4_Pcp4/edit#) From 24264f769dfee73b88cb8545a9dcafe8a5f0de54 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 27 Jul 2021 20:03:43 -0400 Subject: [PATCH 068/317] docs(UPM-928): Roles first draft Former-commit-id: 847191b6eef25a218cc005a59facbf01b8a22503 --- .../organization_and_access/03_roles.mdx | 47 ++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx index b6a189ab0e8..2687533655c 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -2,4 +2,49 @@ title: "Roles" --- -Document content +Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Role is a convenient abstraction to manage permissions assigned to users. + +* EDB Cloud preview uses 3 template roles _reader_, _contributor_ and _owner_ +* These roles can be edited, including changing their name and changing set of associated permissions + +!!! Note + The release version of EDB Cloud will allow adding new Roles and Delete new Roles. + + +### Structure of Permissions + +In general a permission is a string made of prefix and suffix separated by column. Most permissions have format _action:object, _The available _actions_ are: + + + +* _create _ +* _read _ +* _update _ +* _delete_ + +The prefix _object_ defines a part of EDB Cloud functionality. The available _objects_ are as follows: + + + +* _databases_ +* _backups_ +* _events_ +* _permissions_ +* _roles_ +* _users_ +* _tickets_ +* _billing_ +* _versions_ + +There are two special permissions for superset, where suffix defines superset role. There are only two such permission: + +* _superset:alpha_ +* _superset:admin_ + +### Roles Edit Screen + +There are three tabs: **Settings, Permissions, **and** Users** + +1. **Settings** tab allows to change **Name** and **Description** of the **Role ** +2. **Permissions** tab allows to edit a set of permissions assigned to the role +3. **Users** tab list users associated with the **Role** From fd7746ce81362fa5d8f4a4f6cee2700a4f88d355 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 27 Jul 2021 21:03:36 -0400 Subject: [PATCH 069/317] docs(UPM-928): Roles first draft v2. Former-commit-id: da689441efa228aac3c103dfff75fd91764f4c11 --- .../organization_and_access/03_roles.mdx | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx index 2687533655c..e0145a33a1f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -11,12 +11,11 @@ Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. The release version of EDB Cloud will allow adding new Roles and Delete new Roles. -### Structure of Permissions +## Structure of Permissions In general a permission is a string made of prefix and suffix separated by column. Most permissions have format _action:object, _The available _actions_ are: - * _create _ * _read _ * _update _ @@ -41,10 +40,26 @@ There are two special permissions for superset, where suffix defines superset ro * _superset:alpha_ * _superset:admin_ -### Roles Edit Screen +## Roles Edit Screen +To edit roles: +1. Navigate to Admin > Roles. +2. Select the edit icon for the role in the list. + +### Changing Role Name +To change **Name** and **Description** of the role: +1. Select **Settings** tab. +2. Edit **Name** and **Description** +3. Press **Save**. + +### Changing Permissions + +To change permissions associated with the role: +1. Select **Permissions** tab. +2. Press **Change Permissions** button in the top right. +3. Select the list of permissions you want to be associated with the role. +4. Press **Submit** -There are three tabs: **Settings, Permissions, **and** Users** +### Finding Users in the Role -1. **Settings** tab allows to change **Name** and **Description** of the **Role ** -2. **Permissions** tab allows to edit a set of permissions assigned to the role -3. **Users** tab list users associated with the **Role** +* To find users associated with the role, select **Users** tab. +* To assign appropriate roles to a user, select the edit icon for the user. From 4266003dc62146c777bbfb2534c64ac187340f45 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 27 Jul 2021 21:09:18 -0400 Subject: [PATCH 070/317] docs(UPM-928): Roles first draft v3. Former-commit-id: 7884194c831ed420a650116c732774bc99f9cb21 --- .../organization_and_access/03_roles.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx index e0145a33a1f..82ba86c75b0 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -13,7 +13,8 @@ Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. ## Structure of Permissions -In general a permission is a string made of prefix and suffix separated by column. Most permissions have format _action:object, _The available _actions_ are: +In general a permission is a string made of prefix and suffix separated by column. +Most permissions have format _action:object_. The available _actions_ are: * _create _ @@ -35,7 +36,7 @@ The prefix _object_ defines a part of EDB Cloud functionality. The available _ * _billing_ * _versions_ -There are two special permissions for superset, where suffix defines superset role. There are only two such permission: +There are two special permissions for superset, where suffix defines superset role: * _superset:alpha_ * _superset:admin_ From bd82661567c77630feda7fe4067f6285def8380e Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 28 Jul 2021 11:22:44 -0400 Subject: [PATCH 071/317] Update 02_users.mdx Changed first paragraph to active voice. Former-commit-id: 123982a8a9967489c533d28d67b517021a6fa06a --- .../administering_cluster/organization_and_access/02_users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index abd4de51214..a996ad7f395 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,7 +1,7 @@ --- title: "Users" --- -Users with access to the Admin screen can view all users that are logged in. The list of users is sorted by the time of the latest login. +View all users that are logged in, sorted by the time of the latest login, on the Admin screen. !!! Note The preview release contains only the minimum viable functionality for managing users and role based access control. From efe6998ddad9335b8fc4dee2f519265a1ee9d1a7 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 28 Jul 2021 13:56:15 -0400 Subject: [PATCH 072/317] Update 02_users.mdx Former-commit-id: 1d4f6e7b5fb41872ce9b72268bf6c7c781d0c4ac --- .../administering_cluster/organization_and_access/02_users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index a996ad7f395..6ea6a375ed0 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,7 +1,7 @@ --- title: "Users" --- -View all users that are logged in, sorted by the time of the latest login, on the Admin screen. +You can view all users that are logged in, sorted by the time of the latest login, on the Admin screen. !!! Note The preview release contains only the minimum viable functionality for managing users and role based access control. From 89117c00a97230a3449181df93a951f5eb665345 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 28 Jul 2021 16:40:18 -0400 Subject: [PATCH 073/317] Update 01_organizations.mdx initial editing pass Former-commit-id: 8efa21446562b1b9b2343ca0b387bd29f3df2703 --- .../01_organizations.mdx | 26 +++++++++---------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index d3d556702e1..64aebc73fcd 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -3,22 +3,20 @@ title: "Organizations" --- -* For each customer subscribed to EDB Cloud there is a unique **Organization**. Thus an **Organization** is synonymous with a customer. -* **Organizations** subscribed to EDB Cloud are completely isolated from each other. Each **Organization’s** database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. -* The identity of the **Organization** is established through Azure Active Directory (AD). -* During subscription to EDB Cloud, the Azure AD owned by the **Organization** is linked to EDB Cloud and users which belong to that AD can login to EDB Cloud with minimum access privileges. -* EDB Cloud supports Role Based Access Control policies. A user with **owner** Role may define their own sets of Roles which will be applied across the **Organization**. -* A user with **owner** Role may assign Roles to other users from the same **Organization** to grant them access to different parts of EDB Cloud. +Each subscribed customer has a unique *organization* object in the cloud. An organization is synonymous with a customer. Organizations are completely isolated from each other. Each organization’s database clusters are installed and managed in their own cloud environment ensuring complete segregation of customer data. -The following diagram illustrates a mapping between objects that exist within EDB Cloud (box on the left) and Azure cloud (box on the right). +Azure Active Directory (AD) establishes the identity of an organization. During subscription, you link your Azure AD and users that belong to that AD can login with minimum access privileges. -![*EDB Cloud and Azure*](images/orgmap.png ) +EDB Cloud supports role based access control policies. A user with the **owner** role may define their own sets of roles which can be applied across the organization. A user with the **owner** role may assign roles to other users in the same organization. +Example scenario: +1. AcmeBank owns a subcription to Azure and the acmebank.com Azure AD. +1. AcmeBank purchases a subscription to the EDB cloud and assigns the name acmebank-com for their organization. +1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. +1. Users Tom and Jerry have different roles with different priviledges. +1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced (EPAS) clusters. +2. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. -Organization AcmeBank owns Azure subscription and Azure Active directory (Azure AD) acmebank.com. -After AcmeBank purchased subscribe to EDB Cloud, an Organization (org) acmebank-com was created. -After that, members of acmebank.com Azure AD Tom and Jerry can sign in to EDB Cloud. -Users Tom and Jerry have different privileges within EDB Cloud, defined by EDB Cloud Roles. -Jerry, a user with owner Role can create and own PostgreSQL and EPAS clusters. -Those clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB Cloud. +The following diagram illustrates a mapping between objects that exist within the EDB cloud and Azure cloud for AcmeBank example scenario. +![*EDB Cloud and Azure*](images/orgmap.png ) From ca004f95e1b67ceeaca63c8c7cc929ec73becca3 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 28 Jul 2021 19:22:23 -0400 Subject: [PATCH 074/317] docs(UPM-875):High Availibility section, new version Former-commit-id: ea2bf80772779963c64ec1cf6a3a5f6067795f5c --- .../beta/overview/02_high_availibility.mdx | 17 +++++++--- .../overview/images/high-availibility.png | 3 ++ .../overview/images/high-availibility.puml | 33 +++++++++++++++++++ 3 files changed, 48 insertions(+), 5 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/overview/images/high-availibility.png create mode 100644 product_docs/docs/edbcloud/beta/overview/images/high-availibility.puml diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index d2e2bcab732..a969b00a2c1 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -2,14 +2,21 @@ title: "High Availability" --- -Reference and link out to Terms of Service. +EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. +An EDB Cloud _cluster_ is a PostgreSQL cluster made up of a single _primary_ and an optional number of _replicas_. +Streaming replication is used to ensure that the primary and replicas have the same data. -High Availability Configuration: -- EDB Cloud provides built in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. +* The primary cluster is often called the _leader_. +* Replicas are usually called _standby servers_ and can also be used for read-only workloads. +* In case of temporary or permanent unavailability of the primary, a standby server will become the leader. -- Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. +![*EDB Cloud Cluster4*](images/high-availibility.png ) -- Streaming replication is used +EDB Cloud clusters with the _High Availability_ option enabled have the following configuration: + +* Each cluster is provisioned with 3 instances - 1 primary and 2 standby servers, within a single region. +* Clusters are configured across availability zones in regions with availability zones. +* Streaming replication is used. Reference and link out to Terms of Service (once link is available). diff --git a/product_docs/docs/edbcloud/beta/overview/images/high-availibility.png b/product_docs/docs/edbcloud/beta/overview/images/high-availibility.png new file mode 100644 index 00000000000..edf5a92e004 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/images/high-availibility.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5831ca4bdbe9fdb87a1e7c677560c0f2990879ccb675faeee3c66ec74a1e002 +size 24743 diff --git a/product_docs/docs/edbcloud/beta/overview/images/high-availibility.puml b/product_docs/docs/edbcloud/beta/overview/images/high-availibility.puml new file mode 100644 index 00000000000..8b7d388d2aa --- /dev/null +++ b/product_docs/docs/edbcloud/beta/overview/images/high-availibility.puml @@ -0,0 +1,33 @@ +@startuml + + +!pragma revision 1 + +!includeurl https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml + +!define AzurePuml https://raw.githubusercontent.com/plantuml-stdlib/Azure-PlantUML/master/dist +!includeurl AzurePuml/AzureCommon.puml +!includeurl AzurePuml/AzureSimplified.puml +!includeurl AzurePuml/Databases/AzureDatabaseForPostgreSQL.puml +!includeurl AzurePuml/Networking/AzureLoadBalancer.puml +!includeurl AzurePuml/Web/AzureWebApp.puml + + +AzureWebApp(app1, "App","") +AzureWebApp(app2, "App","") +AzureWebApp(app3, "App","") +rectangle "EDB Cloud cluster" as src { + AzureLoadBalancer(service, "Service", "") + AzureDatabaseForPostgreSQL(primary,"PostgreSQL Primary", "Primary" ) + AzureDatabaseForPostgreSQL(standby1, "PostgreSQL Standby", "Standby" ) + AzureDatabaseForPostgreSQL(standby2, "PostgreSQL Standby", "Standby" ) + + primary -> standby1 + primary -> standby2 + service <-d->primary +} + +app1-d->service +app2-d->service +app3-d->service +@enduml From 7f50b8e0d6fa517ff93ee8067d268ccd686295cf Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Thu, 29 Jul 2021 10:30:57 -0400 Subject: [PATCH 075/317] Update 03_create_cluster.mdx Edited the description for high availability because it will be an optional selection. Former-commit-id: 07da53001348b810f96effe95ecc1fc00b83e34f --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index b09b3fb39f6..7c292602006 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -23,7 +23,7 @@ title: "Creating a Cluster" For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure. 7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. !!! Note - Zone-redundant High Availability is on by default. EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. Each cluster is provisioned with 3 instances, 1 primary and 2 standby instances, within a single region. + High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. 10. Under **Profile**, select the database use that best applies to your cluster. From b9ead20bc0685cbbb356d74b4606a675273031ee Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Thu, 29 Jul 2021 12:06:17 -0400 Subject: [PATCH 076/317] Update index.mdx added content for pricing Former-commit-id: fc63e9a29e3a2f0d3d5ca6d6a9dd7e5985b21818 --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index d5dad8d3333..9196abead7d 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -2,4 +2,5 @@ title: "Pricing and Billing " --- -Document content +## Pricing +A default EDB Cloud deployment is one PostgreSQL or EDB Postgres Advanced Server cluster, composed of one leader and two follower instances. Pricing is based on the database type and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. Since each cluster has three instances, the price per vCPU should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: From c43914c6fbf82d10f9060fa3d2d8703635a46a87 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Thu, 29 Jul 2021 13:32:57 -0400 Subject: [PATCH 077/317] Update index.mdx Add content for pricing and billing Former-commit-id: 77f62b966879dc7225bb5db05ccb9d71ef392d23 --- .../edbcloud/beta/pricing_and_billing/index.mdx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 9196abead7d..4625482c678 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -4,3 +4,16 @@ title: "Pricing and Billing " ## Pricing A default EDB Cloud deployment is one PostgreSQL or EDB Postgres Advanced Server cluster, composed of one leader and two follower instances. Pricing is based on the database type and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. Since each cluster has three instances, the price per vCPU should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: + +| Database Type | Hourly Price | Monthly Price* | +| --------------------- | -------------- | -------------- | +| PostgreSQL | $0.1655 / vCPU | $120.82 / vCPU | +| EDB Postgres Advanced | $0.2397 / vCPU | $174.98 / vCPU | + +*The monthly cost is approximate and assumes 730 hours in a month. + +## Billing +All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) + +## Cloud Infrastructure Costs +EDB Cloud does not bill you for cloud infrastructure such as compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run out of your Microsoft Azure account, so Azure will handle billing for cloud infrastructure used. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) From dca71f98451effec48e13fbcfecd7635f04474bd Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 29 Jul 2021 13:45:55 -0400 Subject: [PATCH 078/317] docs(UPM-908):Trimming content for preview Former-commit-id: 9af9d2f17f1960a8b103654a8baf4a430e78f3f0 --- product_docs/docs/edbcloud/beta/index.mdx | 5 ++--- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 +- .../edbcloud/beta/using_cluster/06_analyze_with_superset.mdx | 5 ----- 3 files changed, 3 insertions(+), 9 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index 5715fc0b1c0..e17d8227975 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -1,12 +1,11 @@ --- -title: EDB Cloud +title: EDB Cloud description: "EDB Cloud: DBaaS for PostgresSQL " indexCards: simple -directoryDefaults: +directoryDefaults: navigation: - overview - getting_started - - planning - using_cluster - administering_cluster - cloud_providers diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 94c20973713..daa5edd37f0 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -1,5 +1,5 @@ --- -title: "Modify & Scale Cluster" +title: "Edit Cluster" --- Document content diff --git a/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx deleted file mode 100644 index 60b09ea58f1..00000000000 --- a/product_docs/docs/edbcloud/beta/using_cluster/06_analyze_with_superset.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Analyze with Apache Superset" ---- - -Document content From 60cf8d0832681d512fc42ee73b190bc6e819ce42 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 29 Jul 2021 15:44:37 -0400 Subject: [PATCH 079/317] docs(UPM-911):Trimming content for pricing and billing Former-commit-id: 13243d5b6802e97e1db2d8379c1d6c1d6acf7584 --- .../beta/pricing_and_billing/01_pricing.mdx | 14 -------------- .../beta/pricing_and_billing/02_billing.mdx | 8 -------- 2 files changed, 22 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx delete mode 100644 product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx deleted file mode 100644 index 5823320b45e..00000000000 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/01_pricing.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Pricing/Billing" ---- - -UPM-932 - -Info on how we bill (including the price metrics), how we meter usage & how often. - -- Price Metric: Virtual Central Processing Unit (vCPU) - -- Hourly metering - -- All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. (We can reference the 'billing through Microsoft Azure docs page) - diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx deleted file mode 100644 index 7294a4e01ab..00000000000 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/02_billing.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Billing through Microsoft Azure" ---- -How is infrastructure (instances/storage) charged? - -EDB Cloud does not bill for cloud infrastructure costs, including compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run in your own cloud account, and thus infrastructure costs are billed to you by your respective cloud provider(s). - - From 9726deae2ca8a121437fb2d6450282d362ca0796 Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Thu, 29 Jul 2021 16:25:40 -0400 Subject: [PATCH 080/317] Update 02_high_availibility.mdx There was repetitive content towards the end. CNPO uses primary so I think we should stick with that language. Former-commit-id: a8be9489b864748d28ee9b47a6301c25724d25fd --- .../beta/overview/02_high_availibility.mdx | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index a969b00a2c1..9a408fb980f 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -2,21 +2,11 @@ title: "High Availability" --- -EDB Cloud provides built-in high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. -An EDB Cloud _cluster_ is a PostgreSQL cluster made up of a single _primary_ and an optional number of _replicas_. -Streaming replication is used to ensure that the primary and replicas have the same data. +EDB provides optional high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. High availability clusters are configured with one _primary_ and two _replicas_ with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. - -* The primary cluster is often called the _leader_. * Replicas are usually called _standby servers_ and can also be used for read-only workloads. -* In case of temporary or permanent unavailability of the primary, a standby server will become the leader. +* In case of temporary or permanent unavailability of the leader, a standby replica will become the primary. ![*EDB Cloud Cluster4*](images/high-availibility.png ) -EDB Cloud clusters with the _High Availability_ option enabled have the following configuration: - -* Each cluster is provisioned with 3 instances - 1 primary and 2 standby servers, within a single region. -* Clusters are configured across availability zones in regions with availability zones. -* Streaming replication is used. -Reference and link out to Terms of Service (once link is available). From 3f63feaba6857fece185932770f4b07654437838 Mon Sep 17 00:00:00 2001 From: skrivov-edb <62944071+skrivov-edb@users.noreply.github.com> Date: Thu, 29 Jul 2021 17:05:55 -0400 Subject: [PATCH 081/317] Update product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 84b46af3439c6d82dfc781a9e81180c2dcccac85 --- .../docs/edbcloud/beta/overview/02_high_availibility.mdx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index 9a408fb980f..85aac8ab25a 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -2,11 +2,14 @@ title: "High Availability" --- -EDB provides optional high availability aimed to reduce downtime in the event of a zone or instance becoming unavailable. High availability clusters are configured with one _primary_ and two _replicas_ with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. +EDB provides optional high availability to minimize downtime in case of failures. High availability clusters are configured with three database instances - one _primary_ and two _replicas_ - with streaming replication from the primary to the replicas. In cloud regions with availability zones, instances are provisioned across multiple availability zones to provide fault tolerance in the face of datacenter failure. + +Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica will automatically be promoted to primary and new connections will be routed to the new primary. When the old primary recovers, it will re-join the cluster as a secondary. + + By default, transactions must synchronously commit to one replica before acknowledgement - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. Customers can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. * Replicas are usually called _standby servers_ and can also be used for read-only workloads. * In case of temporary or permanent unavailability of the leader, a standby replica will become the primary. ![*EDB Cloud Cluster4*](images/high-availibility.png ) - From 7350b0d0b237db7603adbc5a3433838c038c39f3 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 29 Jul 2021 17:20:02 -0400 Subject: [PATCH 082/317] docs(UPM-875):High avalibility change text order Former-commit-id: 7c01ef7e73cb1914ab9f89e80c773cc71ab62b2d --- .../docs/edbcloud/beta/overview/02_high_availibility.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index 85aac8ab25a..484813b02e0 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -4,12 +4,14 @@ title: "High Availability" EDB provides optional high availability to minimize downtime in case of failures. High availability clusters are configured with three database instances - one _primary_ and two _replicas_ - with streaming replication from the primary to the replicas. In cloud regions with availability zones, instances are provisioned across multiple availability zones to provide fault tolerance in the face of datacenter failure. -Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica will automatically be promoted to primary and new connections will be routed to the new primary. When the old primary recovers, it will re-join the cluster as a secondary. - - By default, transactions must synchronously commit to one replica before acknowledgement - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. Customers can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. * Replicas are usually called _standby servers_ and can also be used for read-only workloads. * In case of temporary or permanent unavailability of the leader, a standby replica will become the primary. ![*EDB Cloud Cluster4*](images/high-availibility.png ) +Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica will automatically be promoted to primary and new connections will be routed to the new primary. When the old primary recovers, it will re-join the cluster as a secondary. + +By default, transactions must synchronously commit to one replica before acknowledgement - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. Customers can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. + + From 30d6e334b9f668f6749f79f807ceb72efa643e47 Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:23:32 -0400 Subject: [PATCH 083/317] Update 03_create_cluster.mdx Removed the profiles section. Former-commit-id: 1e10d2ca6b6528cfe5103e94203cbd39c9f40b0d --- .../beta/getting_started/03_create_cluster.mdx | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 7c292602006..3bf1022f0a1 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -26,22 +26,18 @@ title: "Creating a Cluster" High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. -10. Under **Profile**, select the database use that best applies to your cluster. -- *OLAP* (Online Analytical Processing) is used for analysis on large amounts of data, such as complex querying or data mining. -- *OLTP* (Online Transactional Processing) is used for updating large amounts of data in real time, such as logging transactions or password changes. -- *Web* databases are used by web applications and are accessible through a local network or internet connection.

Advanced Configuration (Optional)

-11. Click on **Advanced Customization** to open more options for your cluster. -12. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -13. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -14. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +10. Click on **Advanced Customization** to open more options for your cluster. +11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. +12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. +13. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet.

Create Cluster

-15. Click **Create Cluster**. It might take a few minutes to deploy. +14. Click **Create Cluster**. It might take a few minutes to deploy.

What’s Next

From bf6ba418826fdedad62eb84e7b723ecd1e42531d Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:26:28 -0400 Subject: [PATCH 084/317] Delete 01_cluster_sizing.mdx Out of scope for preview Former-commit-id: 633349dd0bf0b8455125c23e0a5f54688bbf2552 --- .../docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx diff --git a/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx b/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx deleted file mode 100644 index 588e8de4cca..00000000000 --- a/product_docs/docs/edbcloud/beta/using_cluster/01_cluster_sizing.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Cluster Sizing" ---- - -Document content From 27f0f89587cb2fd3119c4e9aa26608352226d57b Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:28:52 -0400 Subject: [PATCH 085/317] Update 02_high_availibility.mdx Removed reference to leader to be consistent with CNPO docs. Former-commit-id: f2edadb6851c75c12403593cb8929453afeb1b69 --- .../docs/edbcloud/beta/overview/02_high_availibility.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index 484813b02e0..572c759182e 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -6,7 +6,7 @@ EDB provides optional high availability to minimize downtime in case of failures * Replicas are usually called _standby servers_ and can also be used for read-only workloads. -* In case of temporary or permanent unavailability of the leader, a standby replica will become the primary. +* In case of temporary or permanent unavailability of the primary, a standby replica will become the primary. ![*EDB Cloud Cluster4*](images/high-availibility.png ) From a51d93b730f0cad25d0c6f58b41736b67b956c08 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:29:22 -0400 Subject: [PATCH 086/317] Delete 01_encryption.mdx Encryption content should go in index.mdx Former-commit-id: 945db6d25ffee4261688ad7a25c56234f9230030 --- .../security_and_networking/01_encryption.mdx | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx deleted file mode 100644 index 9059f98347e..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/01_encryption.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Encryption" ---- - -Define what is done for encryption keys. UPM-929 From 53b0e704a003c5eacee2120d2a441c303516ac4e Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:33:13 -0400 Subject: [PATCH 087/317] Delete 01_regions.mdx Content should go on index.mdx Former-commit-id: 11de5276e5fb3d3084f000827498b788613111d7 --- .../beta/cloud_providers/microsoft_azure/01_regions.mdx | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx deleted file mode 100644 index 17b057d0e0f..00000000000 --- a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/01_regions.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Microsoft Azure - Regions" -navTitle: "Regions" ---- - -UPM-935 List supported region. From 40c2a0f68483f8f045cafe403a42841a8904a1e7 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Fri, 30 Jul 2021 15:34:32 -0400 Subject: [PATCH 088/317] Delete 02_infrastructure_supported.mdx Content should go directly on Azure page Former-commit-id: d4d95c13d777c9cea2941889dba8d79e39c18d6c --- .../microsoft_azure/02_infrastructure_supported.mdx | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx deleted file mode 100644 index 56865efe274..00000000000 --- a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/02_infrastructure_supported.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Microsoft Azure - Infrastructure Supported" -navTitle: "Infrastructure" ---- - -UPM-936 List supported infrastructure instance types From 3202cdff79f163d008cbccd4543963891901094b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 30 Jul 2021 15:55:02 -0400 Subject: [PATCH 089/317] deleted planning directory Former-commit-id: 5425249862ec330709eff843a373d1b3b24c9fe0 --- product_docs/docs/edbcloud/beta/planning/01_migration.mdx | 5 ----- product_docs/docs/edbcloud/beta/planning/index.mdx | 5 ----- 2 files changed, 10 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/planning/01_migration.mdx delete mode 100644 product_docs/docs/edbcloud/beta/planning/index.mdx diff --git a/product_docs/docs/edbcloud/beta/planning/01_migration.mdx b/product_docs/docs/edbcloud/beta/planning/01_migration.mdx deleted file mode 100644 index 030827e5bf8..00000000000 --- a/product_docs/docs/edbcloud/beta/planning/01_migration.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Migration" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/planning/index.mdx b/product_docs/docs/edbcloud/beta/planning/index.mdx deleted file mode 100644 index 78b385b4a4b..00000000000 --- a/product_docs/docs/edbcloud/beta/planning/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Planning" ---- - -Document content From bb9f986d5007b154f80f8dcb80b861d1f0a2af59 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 2 Aug 2021 15:15:39 -0400 Subject: [PATCH 090/317] doc(UPM-914): Connect cloud account rewrite Former-commit-id: 08fb18670d3c68428099fab868f3fdf1ac469741 --- .../01_connect_cloud_account.mdx | 94 ++++++++++++++----- .../images/configure-edbcloud.png | 3 - .../getting_started/images/setup-edbcloud.png | 3 + 3 files changed, 74 insertions(+), 26 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/setup-edbcloud.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index b0f36b46472..da8ac3913f7 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -6,48 +6,95 @@ This topic shows you how to set up UPM Cloud subscription on Azure Marketplace. ## Prerequisites -EDB Cloud account setup depends on three Azure objects: -1. _Azure Subscription_ - to connect to Azure. -2. [Azure Active Directory (AD) Application ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal) - to create Azure AD Service principal that provides identity to your organization. -3. [Azure Resource Group ](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group)- to identify the region and resources to be used by EDB Cloud. +1. You should have an Azure subscription to be able to subscribe to EDB Cloud. +2. You should ensure that your Azure subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses as described below. +3. You should create Azure Active Directory Application (client) to manage the identity of your users within EDB Cloud. -Ensure that you have an Azure subscription. Secondly, use the instructions in the following link to create [Azure Active Directory (AD) Application and a Service Principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). The Azure AD app should have a _Contributor_ role. As an authentication option for the application, choose _application secret. _Thirdly, create [Azure Resource Group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group). The later can also be created during the subscription. The following table describes the parameters that need to be entered in EDB Cloud subscription form. All, but last one are properties of Azure objects. +### Azure Limits on Resources -| Parameter | Property Of | Name in Azure Portal Form | -| ----------------------------- | ----------------------------- | ------------------------- | -| **Service Principal Name** | Azure AD App | Application (client) ID | -| **Service Principal Secret** | Azure AD App | Secret name your assign | -| **Azure Subscription ID** | Azure Subscription | Directory (tenant) ID | -| **Azure Resource Group** | Azure Resource Group | Name you assign | -| **Your EDB Cloud Organization Name** | NA | Name you assign | +By default, Azure sets a very low limit on the number of virtual machines and on the number of public Public IP Addresses that are available in a given subscription. Being in a role Owner, Contributor or[ Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) account you could send requests to increase those limits. Please ensure that the _Default subscription filter_ is updated for expected _subscription id_. +You can check the current Azure limits for Virtual Machines and Public IP Addresses using the following steps. + + +1. In Azure Portal, select _Subscription_. +2. Under **Settings**, select _Usage + quotas_ +3. To view Virtual Machines Limits enter the search term _vCPU_ in the **Search** box**.** +4. To view Networks Limits enter the search term _Public IP_ in the **Search** box**.** + + +### Increasing Virtual Machines Limits + +Default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. This limit has to be increased to at least 50 virtual machines per region. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your Virtual Machines Limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. + +Below is an example of request to increase Virtual Machines Limits: + + +``` +Request Summary / New Limit: +Resource Manager, EASTUS, DSv2 Series / 50 +Resource Manager, EASTUS, ESv3 Series / 50 +Resource Manager, EASTUS, ESv4 Series / 50 +Resource Manager, UKSOUTH, DSv2 Series / 50 +Resource Manager, UKSOUTH, ESv3 Series / 50 +Resource Manager, UKSOUTH, ESv4 Series / 50 +``` + + + +### Increasing Private Network Limits + +The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). + + +### Required Parameters + + + +The following table describes the parameters that need to be entered in the EDB Cloud subscription form. Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. -## Procedure +| Parameter | Description | +| ------------------------------------- | ---------------------------------------------------------------------------- | +| **Azure AD App ID** | Application (client) ID | +| **Azure AD App Secret** | Value of application (client) secret | +| **Azure Subscription ID** | You can get Azure subscription ID from the overview page of a subscription. | +| **Your EDB Cloud Organization Name** | Name you assign to your EDB Cloud Organization Name | -1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** -2. On the left navigation pane click link **Private Offers + Plans**. Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. You should see the following form: +### Azure AD Application +Azure Active Directory Application provides identity to EDB Cloud users that come from your organization and are members of your Azure Active Directory Application. -![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) +To create Azure Active Directory Application do the following: +1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. +2. Assign Contributor role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). +3. As an authentication option for the application, choose _application secret._ [Create a new application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) +4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). +## Procedure +1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** +2. On the left navigation pane click link **Private Offers + Plans**. +Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. +You should see the following form: -![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") +![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) +3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. + +![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") Enter or create a Resource** Group** for your subscription. Select SaaS subscription **Name.** Press the button at the bottom **Review+ subscribe** at the bottom of the form. @@ -61,14 +108,15 @@ This will complete your Azure SaaS subscription and lead you to the following fo ![*Subscription progress](images/subscription-process.png "image_tooltip") -4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure Service Principal and your Resource Group. -Before you click the **Configure account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. -5. After clicking the **Configure account now** button, you should see a form to enter prerequisite parameters. +4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure AD Application. +Before you click the **Configure account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. +5. After clicking the **Configure account now** button, you should see a form to enter prerequisite parameters. -![*EDB Cloud Account Form*](images/configure-edbcloud.png "image_tooltip") +![*EDB Cloud Account Form*](images/setup-edbcloud.png "image_tooltip") -Fill in the values of your parameters and press **Submit. **If you fill in your parameters correctly, this will lead you to EDB Cloud login form where you can login to your EDB Cloud account using your Azure AD identity. +Fill in the values of your parameters and press **Submit.** +If you fill in your parameters correctly, this will lead you to EDB Cloud login form where you can login to your EDB Cloud account using your Azure AD identity. diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png b/product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png deleted file mode 100644 index cf4114cbdec..00000000000 --- a/product_docs/docs/edbcloud/beta/getting_started/images/configure-edbcloud.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:78fa39f67b0797336f90e6c520ca3e1dd17cdeacb9dbf47400e3818a3a6cd2a7 -size 45993 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/setup-edbcloud.png b/product_docs/docs/edbcloud/beta/getting_started/images/setup-edbcloud.png new file mode 100644 index 00000000000..d5f3789ce5d --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/setup-edbcloud.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f6714986e1cfae9330ca6e9804b18b160390f6f14d17f876c0408141f7bb8e0 +size 76128 From 42c7f985846819dd28d72ae5ac7e75955e3e403b Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 2 Aug 2021 15:59:05 -0400 Subject: [PATCH 091/317] doc(UPM-921): Backup and Restore Former-commit-id: 55575544eeee87f6299462e01edf32b2e58a51c9 --- .../using_cluster/04_backup_and_restore.mdx | 21 ++++++++----------- 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx index 9c461ef4337..202b0ab7edc 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -2,27 +2,24 @@ title: "Backup and Restore" --- -PITR & Restore Points, Redundancy +### Backups -Backups: +- EDB automatically takes full backups for you, along with all changes that occur in the database after the full backup. -- EDB provides automatic backups. Backups are continuously (commit to time period?) taken on clusters. +- PostgreSQL base backups and WAL (Write-Ahead Log) files are stored in Azure blob Storage. -- Type of backups: WAL archiving? +- Customers are responsible for the charges associated with backup storage, please reference the Azure Blob Storage page for more information. -- Retention: Customers can specify the retention period for backups. Include timing of retention. +- Customers can specify a retention period for backups. -- Where are backups stored? Backups are stored in Azure Blob Storage (include which type). Customers are responsible for the charges associated with backup storage, please reference the Azure Blob Storage page for more information. +### Restore -Restore: +- In the event of an actual disaster, the PostgreSQL cluster will be restored to the latest point in time. +- Restore times are dependent on the amount of database changes since the last full backup was taken as the contents of the WAL must be replayed. -- Point in time recovery available. Customers can enter in a timestamp that they want to restore to. Include the increments of time and where a customer can initiate a restore. +- Point in time recovery is available, allowing customers to restore the cluster to any supplied timestamp after the oldest full backup. - Customers can restore backups into a new cluster in the same region or a new region. -- Include which fields are editable by the customers. - -- Archived clusters can be restored to the most recent point in time available. - From e6678212c463b3827b35eddf88f6ed518d14385f Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 2 Aug 2021 13:08:45 -0700 Subject: [PATCH 092/317] Update 04_responsibility_model.mdx Former-commit-id: 406f3b79aa8421fd0ba3b7c2ba73bdf683d813b9 --- .../edbcloud/beta/overview/04_responsibility_model.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index 308a22a9132..635d19b8a01 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -1,16 +1,16 @@ --- -title: "EDB Cloud Responsibility Model" +title: "Responsibility Model" --- Security and confidentiality is a shared responsibility between EDB and our customers. -The following EDB Cloud Responsibility Model describes the distribution of specific responsibilities between EDB Cloud and EDB Customers. +The following Responsibility Model describes the distribution of specific responsibilities between EDB and EDB Customers. ## Planning and Operations Management -| Task | EDB Cloud Responsibility | Customer Responsibility | +| Task | EDB Responsibility | Customer Responsibility | | ----- | ------------------------- | ------------------------ | | **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary | Yes | No | | **Database service availability:** customers can connect to a database cluster and read / write data | Yes | Yes | @@ -27,7 +27,7 @@ The following EDB Cloud Responsibility Model describes the distribution of speci -| Task | EDB Cloud Responsibility | Customer Responsibility | +| Task | EDB Responsibility | Customer Responsibility | | ----- | ------------------------- | ------------------------ | | **SOC2 Audit Compliance** | Yes | No | | **Database cluster credential management:** credentials for database clusters are kept secret and rotated as appropriate. | Yes | Yes | From 1415873aeb0944e818bc441af8f405a71e212e43 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Mon, 2 Aug 2021 16:13:56 -0400 Subject: [PATCH 093/317] Update 04_backup_and_restore.mdx Capitliaztion fix. Former-commit-id: ac1d8bfb4f1543d711debba31b88b0f79f264029 --- .../docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx index 202b0ab7edc..a0700e06951 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -6,7 +6,7 @@ title: "Backup and Restore" - EDB automatically takes full backups for you, along with all changes that occur in the database after the full backup. -- PostgreSQL base backups and WAL (Write-Ahead Log) files are stored in Azure blob Storage. +- PostgreSQL base backups and WAL (Write-Ahead Log) files are stored in Azure Blob Storage. - Customers are responsible for the charges associated with backup storage, please reference the Azure Blob Storage page for more information. From 028ec081d2aedf3c2820602fee860462baf1c7af Mon Sep 17 00:00:00 2001 From: Neel Patel Date: Tue, 3 Aug 2021 11:08:10 +0530 Subject: [PATCH 094/317] Update "create cluster" document - Updated create cluster document. Former-commit-id: 209bd2e06e314cc9e74456f85f5a90c1093b3eee --- .../edbcloud/beta/getting_started/03_create_cluster.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 3bf1022f0a1..a56fdce2f18 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -5,19 +5,21 @@ title: "Creating a Cluster"

First Steps

-1. Sign into the [EDB Cloud portal](https://portal.edbcloud.com). +1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). !!! Note You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner. 2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster. - + !!! Note + Here password for the cluster will be for the superuser 'edb_admin'. +

Configure Your Cluster

4. Under **Database Type**, select a type of database. - *PostgreSQL* is an open-source object-relational database management system. - *EnterpriseDB PostgreSQL Advanced Server (EPAS)* is EDB’s secure, Oracle-compatible PostgreSQL. -5. Select the version that you want to run your cluster on. Please refer to our versioning policy for more information. +5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure. From 0a363ba00b4732cb87dcd6ab3d956e3b6e89ab45 Mon Sep 17 00:00:00 2001 From: Neel Patel Date: Tue, 3 Aug 2021 12:15:28 +0530 Subject: [PATCH 095/317] Updated supported storage type Updated supported storage type Former-commit-id: 255f82e28720dbb4f6c384cc97e1d128aef4b778 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index a56fdce2f18..5e988d30a05 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -28,7 +28,9 @@ title: "Creating a Cluster" High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. - + !!! Note + For EDB Cloud Preview, the only storage we support is Azure premium storage. +

Advanced Configuration (Optional)

10. Click on **Advanced Customization** to open more options for your cluster. From 907edd00818c01d2974e9a4cb92a246ea7458cc9 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Tue, 3 Aug 2021 10:30:43 -0400 Subject: [PATCH 096/317] Update 02_high_availibility.mdx Changed instance terminology to cluster for consistency with CNP docs and secondary to replica for consistency. Minor addition to synchronous replica explanation by starting with a clear non-Postgres explanation Former-commit-id: 6e471c39272f9644da7fc0fe372b5af5bf1ce402 --- .../docs/edbcloud/beta/overview/02_high_availibility.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index 484813b02e0..b713bc4365b 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -2,7 +2,7 @@ title: "High Availability" --- -EDB provides optional high availability to minimize downtime in case of failures. High availability clusters are configured with three database instances - one _primary_ and two _replicas_ - with streaming replication from the primary to the replicas. In cloud regions with availability zones, instances are provisioned across multiple availability zones to provide fault tolerance in the face of datacenter failure. +EDB provides a high availability option to minimize downtime in case of failures. High Availability clusters are configured automatically with - one _primary_ and two _replicas_ - with replicas staying up-to-date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across multiple availability zones to provide fault tolerance in the face of a datacenter failure * Replicas are usually called _standby servers_ and can also be used for read-only workloads. @@ -10,8 +10,8 @@ EDB provides optional high availability to minimize downtime in case of failures ![*EDB Cloud Cluster4*](images/high-availibility.png ) -Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica will automatically be promoted to primary and new connections will be routed to the new primary. When the old primary recovers, it will re-join the cluster as a secondary. +Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica will automatically be promoted to primary and new connections will be routed to the new primary. When the old primary recovers, it will re-join the cluster as a replica. -By default, transactions must synchronously commit to one replica before acknowledgement - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. Customers can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. +By default, one replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. This behavior can be modified on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. From 57cf53a0847c4ad684c2e639f2cb2547791a56f7 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 3 Aug 2021 12:40:16 -0400 Subject: [PATCH 097/317] Guang's clarification on SPN Former-commit-id: f8ffa7822ad5452727d8d43177b460dbe5398f56 --- .../beta/getting_started/01_connect_cloud_account.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index da8ac3913f7..5c6e5404ab8 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -75,8 +75,11 @@ Azure Active Directory Application provides identity to EDB Cloud users that co To create Azure Active Directory Application do the following: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). +Note **Application (client) ID**, you will need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. +You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. -2. Assign Contributor role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). + +2. Assign Contributor role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. 3. As an authentication option for the application, choose _application secret._ [Create a new application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) From 427d11b5bc94fdc6e9ec9d014e66ccf1943c9e5e Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Tue, 3 Aug 2021 13:11:33 -0400 Subject: [PATCH 098/317] Update 03_modify_and_scale_cluster.mdx Add documentation for editing a cluster Former-commit-id: f7411a03f0835eda7a9a66f2ecb3e14a83f971be --- .../03_modify_and_scale_cluster.mdx | 23 +++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index daa5edd37f0..040cda095e9 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -1,5 +1,24 @@ --- -title: "Edit Cluster" +title: "Modifying and Scaling Clusters" --- -Document content +!!! Note: You must have Owner account privileges in order to edit a cluster. If you have Contributor or Reader account privileges and need edit permissions, contact the account owner. + +1. From the Clusters page, click on the name of the cluster you want to edit. +2. Click Edit Cluster from the top right corner of the Cluster Info panel. +3. Change the cluster’s configurations to the desired values. The following fields are available to edit: + +| Configuration | Notes | +| ------------- | ----- | +| Cluster name | The name for your cluster. | +| Cluster password | The password for your cluster. | +| High availability | High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. | +| Instance type* | Select the desired instance based on the number of vCPUs and amount of memory offered. | +| Volume properties* | Select volume properties based on the amount of storage and provisioned IOPS offered. !!! Note: Storage can only be scaled up; it cannot be reduced. | +| Number of connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | + +*Changing the instance type or volume properties could incur higher cloud infrastructure charges. + +5. Click Save to save your changes. +6. Click Confirm Changes. !!! Note: Saving changes may require a database restart. + From abfb06b890f0bbc09e3118f711fb8e9fc1b2e2b1 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 3 Aug 2021 13:29:17 -0400 Subject: [PATCH 099/317] Update 03_security_compliance.mdx Removed references to EDB Cloud and minor edits Former-commit-id: 6d5212324de67393469c99e5ec8c68d1389c7c63 --- .../beta/overview/03_security_compliance.mdx | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 863fe0b67ef..7146a33d74e 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -1,17 +1,16 @@ --- -title: "Security Features" +title: "Security" --- -### EDB Cloud Security Features -EDB Cloud is a Database as a Service (DBaaS) which runs in your own Cloud account, isolating your data from other users & giving you control over our access to it. The key security features of EDB Cloud are as follows: -- **Segregation of IT environments:** Customers database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. -- **Access Control:** EDB Cloud supports _Single Sign on_ and _Role Based Access Control_ policies. Customers may define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. - -- **Data Encryption:** EDB Cloud encrypts customer data in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. -- **Logging and Auditing:** EDB Cloud supports Logging and Auditing +### Overview +EDB's cloud offering runs in your own cloud account, isolating your data from other users and giving you control over our access to it. The key security features are: +- **Segregation of IT environments:** Customer's database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. +- **Access Control:** Customers may use _Single Sign On_ and define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. +- **Data Encryption:** Customer's data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. +- **Logging and Auditing:** Logging and auditing is supported. ### Shared Responsibility -Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of EDB Cloud clusters and data held within them. See our Responsibility Model for more information. +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of their clusters and data held within them. See our Responsibility Model for more information. From 12daeccc2b86e31b5b8627f5eaeae794921c2763 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Tue, 3 Aug 2021 10:53:10 -0700 Subject: [PATCH 100/317] Update index.mdx Minor edits Former-commit-id: 48b4d9291a38c44d80516b13e1cafc931e2f720f --- product_docs/docs/edbcloud/beta/overview/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index 69a97bd18ea..6c8b44281ff 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -4,11 +4,11 @@ description: "Learn about EDB Cloud " --- -- EDB is a fully managed database as a service offering both PostgreSQL and EDB Postgres Advanced with Oracle Compatibility. +- A fully managed database as a service offering for both PostgreSQL and EDB Postgres Advanced with Oracle Compatibility. -- This service runs in your cloud account, but is fully managed and operated by the EDB team. +- Runs in your cloud account, but is fully managed and operated by EDB. -- This service is available via the Microsoft Azure Marketplace. +- Available via the Microsoft Azure Marketplace. From a4bbaa18f36a2eca9c2ff5542441d306ffc63fbf Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 10:57:21 -0400 Subject: [PATCH 101/317] Delete product_docs/docs/edbcloud/beta/release_notes directory Deleting the release_notes directory because we are not planning on including release notes for the beta Former-commit-id: 5de364dc4278f04a43d67f34e73c2a98e60c358f --- .../docs/edbcloud/beta/release_notes/index.mdx | 11 ----------- .../edbcloud/beta/release_notes/prev_rel_notes.mdx | 13 ------------- 2 files changed, 24 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/release_notes/index.mdx delete mode 100644 product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx diff --git a/product_docs/docs/edbcloud/beta/release_notes/index.mdx b/product_docs/docs/edbcloud/beta/release_notes/index.mdx deleted file mode 100644 index 1ad37dcef56..00000000000 --- a/product_docs/docs/edbcloud/beta/release_notes/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Release Notes" ---- - -<<<<<<< Updated upstream -Document content test -======= -| Version | Release Date | -| ------- | ------------ | -| [Preview](prev_rel_notes) | Aug 2021 | | ->>>>>>> Stashed changes diff --git a/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx b/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx deleted file mode 100644 index e17aa22fe20..00000000000 --- a/product_docs/docs/edbcloud/beta/release_notes/prev_rel_notes.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Preview" ---- - -New features in the preview release include: - -| Description | Type | ID | -| ----------- | ---- | -- | -| Backup and Restore | New Feature | -| Backend logic for cluster creation and editing clusters | New Feature | -| Automated data plane provisioning | New Feature | - - From 25e1c092c6f26ab1ad6737ecca2aaad951f57603 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 09:21:27 -0700 Subject: [PATCH 102/317] Update 03_security_compliance.mdx Changed text to match you vs their and changed some feature titles Former-commit-id: 2653e9052acb90534b8b04f44b4fe339d11824de --- .../edbcloud/beta/overview/03_security_compliance.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 7146a33d74e..6732e99f93d 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -2,11 +2,10 @@ title: "Security" --- -### Overview -EDB's cloud offering runs in your own cloud account, isolating your data from other users and giving you control over our access to it. The key security features are: -- **Segregation of IT environments:** Customer's database clusters are installed and managed in their own cloud environment. Complete segregation of customer's data is ensured. -- **Access Control:** Customers may use _Single Sign On_ and define their own sets of _Roles_ and _Role Based Access Control_ policies to manage their individual cloud environments. -- **Data Encryption:** Customer's data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). Data stored in database clusters is encrypted appropriately. Users can bring their own encryption keys for an additional level of control. +EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: +- **Data Isolation:** Clusters are installed and managed in your own cloud environment. Complete segregation of your data is ensured. +- **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. +- **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. Bring your own encryption keys for an additional level of control. - **Logging and Auditing:** Logging and auditing is supported. ### Shared Responsibility From cb9039b6df38ce348a6f58fa8a85a79aaf22a0d8 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 11:44:41 -0700 Subject: [PATCH 103/317] Update index.mdx Minor edits Former-commit-id: d5c968ed5f828b800231f24bd75203b91d99956a --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 4625482c678..3fbbf4d1b7f 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -3,7 +3,7 @@ title: "Pricing and Billing " --- ## Pricing -A default EDB Cloud deployment is one PostgreSQL or EDB Postgres Advanced Server cluster, composed of one leader and two follower instances. Pricing is based on the database type and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. Since each cluster has three instances, the price per vCPU should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: +A default deployment is composed of one primary and two replica instances of either PostgreSQL or EDB Postgres Adanvced Server. Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. Since each cluster has three instances, the price per vCPU should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: | Database Type | Hourly Price | Monthly Price* | | --------------------- | -------------- | -------------- | @@ -16,4 +16,4 @@ A default EDB Cloud deployment is one PostgreSQL or EDB Postgres Advanced Server All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) ## Cloud Infrastructure Costs -EDB Cloud does not bill you for cloud infrastructure such as compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run out of your Microsoft Azure account, so Azure will handle billing for cloud infrastructure used. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) +EDB does not bill you for cloud infrastructure such as compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run out of your Microsoft Azure account, so Azure will handle billing for cloud infrastructure used. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) From d826ab3e00736dbd51bce1fb6958dd4643367a4c Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:31:03 -0400 Subject: [PATCH 104/317] Update 03_create_cluster.mdx Former-commit-id: 1c0e6b0166e5956d87a7cf396689494fa2cd6fa4 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 5e988d30a05..6150b111f8e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -6,9 +6,6 @@ title: "Creating a Cluster"

First Steps

1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). -!!! Note - You must have Owner account privileges in order to create your own cluster. If you have Contributor or Reader account privileges and need to create a cloud, contact the account owner. - 2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster. !!! Note From 771bd6d93d499afcd895189797493c057df88032 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:31:54 -0400 Subject: [PATCH 105/317] Update 04_responsibility_model.mdx Change as discussed with Kelly Former-commit-id: 4f6e3550e854eb16521116f1c96cba802f1de1bc --- .../docs/edbcloud/beta/overview/04_responsibility_model.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index 635d19b8a01..e152a408ca6 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -2,7 +2,9 @@ title: "Responsibility Model" --- -Security and confidentiality is a shared responsibility between EDB and our customers. +Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of their clusters and data held within them. See our Responsibility Model for more information. + +Reference and link out to Terms The following Responsibility Model describes the distribution of specific responsibilities between EDB and EDB Customers. From 5495cc86660b25dafdc7cc8c286d0eb01a022237 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:33:17 -0400 Subject: [PATCH 106/317] Update 03_modify_and_scale_cluster.mdx remove note on user privileges Former-commit-id: 9ee4390aa148608abf7986dd88a45e505984c3c0 --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 040cda095e9..fbcac5f65f8 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -2,8 +2,6 @@ title: "Modifying and Scaling Clusters" --- -!!! Note: You must have Owner account privileges in order to edit a cluster. If you have Contributor or Reader account privileges and need edit permissions, contact the account owner. - 1. From the Clusters page, click on the name of the cluster you want to edit. 2. Click Edit Cluster from the top right corner of the Cluster Info panel. 3. Change the cluster’s configurations to the desired values. The following fields are available to edit: From e9b4f8be847b1b6a3be1a7c07a5c78244d15c2c3 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:33:36 -0400 Subject: [PATCH 107/317] Update 03_security_compliance.mdx Former-commit-id: a936fbf31c5b6de9bb55b7332b8f5ccff0b27422 --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 5 ----- 1 file changed, 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 6732e99f93d..d51f27dbec1 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -8,9 +8,4 @@ EDB's cloud offering runs in your own cloud account, isolates your data from oth - **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. Bring your own encryption keys for an additional level of control. - **Logging and Auditing:** Logging and auditing is supported. -### Shared Responsibility -Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of their clusters and data held within them. See our Responsibility Model for more information. - - -Reference and link out to Terms From d7f8fae39bb4f86e05a2ea292b77a13c4b994658 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:39:32 -0400 Subject: [PATCH 108/317] Update product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx Former-commit-id: eec8b5bc3d0a38c97dc0381a4128bdee932b32f2 --- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index fbcac5f65f8..2010f15ce86 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -2,7 +2,7 @@ title: "Modifying and Scaling Clusters" --- -1. From the Clusters page, click on the name of the cluster you want to edit. +1. From the **Clusters** page, select the name of the cluster you want to edit. 2. Click Edit Cluster from the top right corner of the Cluster Info panel. 3. Change the cluster’s configurations to the desired values. The following fields are available to edit: @@ -19,4 +19,3 @@ title: "Modifying and Scaling Clusters" 5. Click Save to save your changes. 6. Click Confirm Changes. !!! Note: Saving changes may require a database restart. - From 9f00523b73371d0c7d19cc3f326bfd59ced1e2b0 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:40:33 -0400 Subject: [PATCH 109/317] Update product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx Former-commit-id: 45f277e162acb75eeee8dcb1f0529640c203c4b5 --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 2010f15ce86..80db736d358 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -3,7 +3,7 @@ title: "Modifying and Scaling Clusters" --- 1. From the **Clusters** page, select the name of the cluster you want to edit. -2. Click Edit Cluster from the top right corner of the Cluster Info panel. +2. Select **Edit Cluster** from the top right corner of the **Cluster Info** panel. 3. Change the cluster’s configurations to the desired values. The following fields are available to edit: | Configuration | Notes | From c40141594675facc11da40008f293face815c554 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:41:12 -0400 Subject: [PATCH 110/317] Update product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx Former-commit-id: 53a0daf3241330f4b0bb393e93e07e4ed2e7dcf5 --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 80db736d358..4a75a833536 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -17,5 +17,5 @@ title: "Modifying and Scaling Clusters" *Changing the instance type or volume properties could incur higher cloud infrastructure charges. -5. Click Save to save your changes. +5. Select **Save** to save your changes. 6. Click Confirm Changes. !!! Note: Saving changes may require a database restart. From 7a8f730ddc59610d9d86ef5619e8dc9c1edaafc3 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:41:55 -0400 Subject: [PATCH 111/317] Update product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx Former-commit-id: 05350c03d7c6b519a115f65ed7580b187430013b --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 4a75a833536..71b3d22030e 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -18,4 +18,4 @@ title: "Modifying and Scaling Clusters" *Changing the instance type or volume properties could incur higher cloud infrastructure charges. 5. Select **Save** to save your changes. -6. Click Confirm Changes. !!! Note: Saving changes may require a database restart. +6. Select **Confirm Changes**. !!! Note: Saving changes may require a database restart. From 03ecf213868eab7ed1123c15449c2ac6af033d55 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:44:53 -0400 Subject: [PATCH 112/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: e7eabdf88d73b10198869c7e9a111421a253de78 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 6150b111f8e..c2bf2fef91c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -6,7 +6,7 @@ title: "Creating a Cluster"

First Steps

1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). -2. Click the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. +2. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster. !!! Note Here password for the cluster will be for the superuser 'edb_admin'. @@ -50,4 +50,3 @@ Now that you’ve created your cluster, here are some additional resources for c * [Using your cluster]( ) * [Administering your cluster]( ) - From 648843818a51ed1c18651f91e96db8cace9b89e6 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:33:13 -0700 Subject: [PATCH 113/317] Update 05_database_version_policy.mdx Change versions to align with what's offered Former-commit-id: 687ab7bacc4e8cb626a61ba5b7e5c9aa0ee64ac7 --- .../edbcloud/beta/overview/05_database_version_policy.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx index ff256e4e291..5cba5eb965c 100644 --- a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -4,9 +4,9 @@ title: "Database Version Policy" Versions Supported: -- PostgreSQL versions supported: 10, 11, 12 +- PostgreSQL versions supported: 11, 12, 13 -- EDB Postgres Advanced versions supported: 10, 11, 12 +- EDB Postgres Advanced versions supported: 11, 12, 13 Maintenance and upgrades: From aa5ca98af3776d2b0b6324cba256f00165be6980 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 15:38:16 -0700 Subject: [PATCH 114/317] Update 04_responsibility_model.mdx Former-commit-id: 53b544980d081a5fb592df40287c75c0a26a5ba1 --- .../edbcloud/beta/overview/04_responsibility_model.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index e152a408ca6..2f881372f99 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -2,17 +2,17 @@ title: "Responsibility Model" --- -Security and confidentiality is a shared responsibility between EDB and our customers. EDB provides a secure platform that enables our customers to create and maintain secure database clusters deployed on EDB Cloud. Customers have numerous responsibilities around the security of their clusters and data held within them. See our Responsibility Model for more information. +Security and confidentiality is a shared responsibility between you and EDB. EDB provides a secure platform that enables you to create and maintain secure database clusters deployed on EDB Cloud. You have numerous responsibilities around the security of your clusters and data held within them. Reference and link out to Terms -The following Responsibility Model describes the distribution of specific responsibilities between EDB and EDB Customers. +The following Responsibility Model describes the distribution of specific responsibilities between you and EDB. ## Planning and Operations Management -| Task | EDB Responsibility | Customer Responsibility | +| Task | EDB Responsibility | Your Responsibility | | ----- | ------------------------- | ------------------------ | | **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary | Yes | No | | **Database service availability:** customers can connect to a database cluster and read / write data | Yes | Yes | @@ -29,7 +29,7 @@ The following Responsibility Model describes the distribution of specific respon -| Task | EDB Responsibility | Customer Responsibility | +| Task | EDB Responsibility | Your Responsibility | | ----- | ------------------------- | ------------------------ | | **SOC2 Audit Compliance** | Yes | No | | **Database cluster credential management:** credentials for database clusters are kept secret and rotated as appropriate. | Yes | Yes | @@ -37,7 +37,7 @@ The following Responsibility Model describes the distribution of specific respon | **Vulnerability management:** operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. | Yes | No | | **Vulnerability management:** database software is kept up-to-date in accordance with policy. | Yes | No | | **Network security:** firewalls are configured to appropriately restrict east / west network traffic. | Yes | No | -| **Network security:** firewalls are configured to appropriately restrict north / south network traffic. | Given a customer's network ingress configuration, EDB Cloud is responsible for implementing the correct set of firewall rules. | Customers must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. | +| **Network security:** firewalls are configured to appropriately restrict north / south network traffic. | Given a customer's network ingress configuration, EDB is responsible for implementing the correct set of firewall rules. | You must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. | From a7c70a960bac0c5bc341a79e8e7a65331356d32a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 19:28:32 -0400 Subject: [PATCH 115/317] Update 03_modify_and_scale_cluster.mdx changed leader to primary Former-commit-id: 068adf98f94d1cb20008fbb7e89833aff684fca5 --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 71b3d22030e..18f6ff267d8 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -10,7 +10,7 @@ title: "Modifying and Scaling Clusters" | ------------- | ----- | | Cluster name | The name for your cluster. | | Cluster password | The password for your cluster. | -| High availability | High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. | +| High Availability | High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. | | Instance type* | Select the desired instance based on the number of vCPUs and amount of memory offered. | | Volume properties* | Select volume properties based on the amount of storage and provisioned IOPS offered. !!! Note: Storage can only be scaled up; it cannot be reduced. | | Number of connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | From d148e496d3119bf0e15c156ff23c4e32fdc4bc57 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:11:43 -0400 Subject: [PATCH 116/317] Update 03_create_cluster.mdx Removed the first step and headings as I don't think they are needed. Other minor edits. Former-commit-id: 2e9e0154bb4e55e8bb32b8065c93d122e79cc163 --- .../getting_started/03_create_cluster.mdx | 39 ++++++------------- 1 file changed, 12 insertions(+), 27 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index c2bf2fef91c..f07b2d0eba0 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -1,47 +1,32 @@ --- title: "Creating a Cluster" --- - - -

First Steps

- -1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). -2. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. +To create a cluster: +1. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster. !!! Note - Here password for the cluster will be for the superuser 'edb_admin'. - -

Configure Your Cluster

- + This is the password for the superuser 'edb_admin'. 4. Under **Database Type**, select a type of database. - - *PostgreSQL* is an open-source object-relational database management system. - - *EnterpriseDB PostgreSQL Advanced Server (EPAS)* is EDB’s secure, Oracle-compatible PostgreSQL. + - *PostgreSQL* is an open-source object-relational database management system. + - *EnterpriseDB PostgreSQL Advanced Server (EPAS)* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note - For EDB Cloud Preview, the only cloud provider we support is Microsoft Azure. -7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, we typically recommend that this region should be the same as other resources you have that will communicate with your cluster. + Microsoft Azure is the only option for the preview. +7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. !!! Note - High Availability is optional. When high availability is enabled, clusters are configured with one leader and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. + High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one replica is provisioned. 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. !!! Note - For EDB Cloud Preview, the only storage we support is Azure premium storage. - -

Advanced Configuration (Optional)

- -10. Click on **Advanced Customization** to open more options for your cluster. + Azure premium storage is the only option for the preview. +10. (Steps 9-12 are optional) Select **Advanced Customization** to open more options for your cluster. 11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. 12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -13. Click the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. - -

Create Cluster

- - +13. Select the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. 14. Click **Create Cluster**. It might take a few minutes to deploy. -

What’s Next

- +## What’s Next Now that you’ve created your cluster, here are some additional resources for cluster use and management: From b92d83c3197fd9515970d13e34b827f5141c52a9 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:27:52 -0400 Subject: [PATCH 117/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: a0b2a01af26c01b853aebf13f9b54fb58d833730 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index f07b2d0eba0..5ba807d10fc 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -8,7 +8,7 @@ To create a cluster: This is the password for the superuser 'edb_admin'. 4. Under **Database Type**, select a type of database. - *PostgreSQL* is an open-source object-relational database management system. - - *EnterpriseDB PostgreSQL Advanced Server (EPAS)* is EDB’s secure, Oracle-compatible PostgreSQL. + - *EDB PostgreSQL Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note @@ -34,4 +34,3 @@ Now that you’ve created your cluster, here are some additional resources for c * [Using your cluster]( ) * [Administering your cluster]( ) - From c6472ceca25aa4a8da7ebb4935571c27a8a013ae Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:28:50 -0400 Subject: [PATCH 118/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: e86f1a6c9ad172122f7681628fe1337f5b01cc01 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 5ba807d10fc..5068c38b86c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,6 +2,7 @@ title: "Creating a Cluster" --- To create a cluster: +1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). 1. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. 3. Enter a name and password for your cluster. !!! Note From 0c4ec1ea542082103e6f5932dc90c782e08be47b Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:55:37 -0400 Subject: [PATCH 119/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 58e94f132ff8f472845c6cd4b7706e3630fd1ef1 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 5068c38b86c..5a2a7706ce6 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -7,7 +7,7 @@ To create a cluster: 3. Enter a name and password for your cluster. !!! Note This is the password for the superuser 'edb_admin'. -4. Under **Database Type**, select a type of database. +4. Select the **Database Type**. - *PostgreSQL* is an open-source object-relational database management system. - *EDB PostgreSQL Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. From 798f4986db9a0e8053cae2b4b870b210993e5c9b Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:56:46 -0400 Subject: [PATCH 120/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 3af21d7e77d0c7451de21b27f1203b2f40b6d4b9 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 5a2a7706ce6..b958b71d261 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -9,7 +9,7 @@ To create a cluster: This is the password for the superuser 'edb_admin'. 4. Select the **Database Type**. - *PostgreSQL* is an open-source object-relational database management system. - - *EDB PostgreSQL Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. + - *EDB Postgre Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. 6. Under **Provider**, select a cloud provider for your cluster. !!! Note From d30769eacfaae329bfa5771ebc6109445bfeeccd Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:57:52 -0400 Subject: [PATCH 121/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: b3f6874596d682e5873ef83c367662748655ff2b --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index b958b71d261..d98149c4485 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -11,7 +11,7 @@ To create a cluster: - *PostgreSQL* is an open-source object-relational database management system. - *EDB Postgre Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. 5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. -6. Under **Provider**, select a cloud provider for your cluster. +6. Select the cloud **Provider** for your cluster. !!! Note Microsoft Azure is the only option for the preview. 7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. From 9a23ff54a116a9cb57b6d99fde117ec9cdbfefdf Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 20:58:57 -0400 Subject: [PATCH 122/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 913af274be69a1738a86bfb28eae3b258ad09b85 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index d98149c4485..9497814d81b 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -14,7 +14,7 @@ To create a cluster: 6. Select the cloud **Provider** for your cluster. !!! Note Microsoft Azure is the only option for the preview. -7. Under **Region**, select the region in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. +7. Select the **Region** in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. !!! Note High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one replica is provisioned. 8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. From 734729d418e3b2f6fda60e2ed687fa44feaf4493 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 21:01:40 -0400 Subject: [PATCH 123/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 4a77454ba401f8c04f4dc2571ba440f8332b2b81 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 9497814d81b..bc32d14e65b 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -17,7 +17,7 @@ To create a cluster: 7. Select the **Region** in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. !!! Note High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one replica is provisioned. -8. Under **Instance Type**, select the desired instance based on the number of vCPUs and amount of memory offered. +8. Select the desired **Instance Type** based on the number of vCPUs and amount of memory offered. 9. Under **Storage**, select the type and amount of storage needed for your cluster. !!! Note Azure premium storage is the only option for the preview. From 998bbd46f40ac2b8e315b19cd0ed2dcdac4c39b2 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 21:05:40 -0400 Subject: [PATCH 124/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 6a802167dbe9df23d55d593199f19fc8de7fd1b8 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index bc32d14e65b..4ef0790a299 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -18,7 +18,7 @@ To create a cluster: !!! Note High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one replica is provisioned. 8. Select the desired **Instance Type** based on the number of vCPUs and amount of memory offered. -9. Under **Storage**, select the type and amount of storage needed for your cluster. +9. Select the **Storage** type and amount of storage needed for your cluster. !!! Note Azure premium storage is the only option for the preview. 10. (Steps 9-12 are optional) Select **Advanced Customization** to open more options for your cluster. From bc7fb79c09ee919e9e9436f1fd31270cbd6c43af Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 21:06:29 -0400 Subject: [PATCH 125/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 7535b2c6284bb7f0b8d23bbf0c9b85a95e4e50ae --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 4ef0790a299..fa143688673 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -21,7 +21,7 @@ To create a cluster: 9. Select the **Storage** type and amount of storage needed for your cluster. !!! Note Azure premium storage is the only option for the preview. -10. (Steps 9-12 are optional) Select **Advanced Customization** to open more options for your cluster. +10. (Steps 10-13 are optional) Select **Advanced Customization** to open more options for your cluster. 11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. 12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. 13. Select the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. From 99ddedf3dd9d9dd131be4e8b14a98ca3cdaf8eb8 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 21:07:24 -0400 Subject: [PATCH 126/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: 0f8ec230fa4b49e390c39f4378d2bba823b1e35e --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index fa143688673..79446597c54 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -24,7 +24,7 @@ To create a cluster: 10. (Steps 10-13 are optional) Select **Advanced Customization** to open more options for your cluster. 11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. 12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -13. Select the toggle under **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +13. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. 14. Click **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 5c2eaa3ef936ea1416609cc75a7f59ac14e5150a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 4 Aug 2021 21:08:12 -0400 Subject: [PATCH 127/317] Update product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx Former-commit-id: a234f69822a884d43b76b8c47adc9fd27fc9cc30 --- .../docs/edbcloud/beta/getting_started/03_create_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 79446597c54..68474275ec7 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -25,7 +25,7 @@ To create a cluster: 11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. 12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. 13. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. -14. Click **Create Cluster**. It might take a few minutes to deploy. +14. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 76272a189384f160070a5c64ae3fefa0ec9b9dfb Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 19:00:19 -0700 Subject: [PATCH 128/317] Update 03_create_cluster.mdx Former-commit-id: c121922182cad1c31fe465b7f5931ecb533256e2 --- .../getting_started/03_create_cluster.mdx | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 68474275ec7..ea58aa6bc21 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,30 +2,32 @@ title: "Creating a Cluster" --- To create a cluster: -1. Sign in into the [EDB Cloud portal](https://portal.edbcloud.com). -1. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. -3. Enter a name and password for your cluster. +1. Sign in to the [EDB Cloud portal](https://portal.edbcloud.com). +2. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. +3. Enter a **Cluster Name** for your cluster. +4. Enter a **Password** for your cluster. !!! Note This is the password for the superuser 'edb_admin'. -4. Select the **Database Type**. +5. Select the **Postgres Type**. - *PostgreSQL* is an open-source object-relational database management system. - - *EDB Postgre Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. -5. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. -6. Select the cloud **Provider** for your cluster. + - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. +6. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. +7. Select the **Provider** for your cluster. !!! Note Microsoft Azure is the only option for the preview. -7. Select the **Region** in which you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. +8. Select the **Region** where you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. +9. Deselect **High Availability** if not desired. !!! Note - High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one replica is provisioned. -8. Select the desired **Instance Type** based on the number of vCPUs and amount of memory offered. -9. Select the **Storage** type and amount of storage needed for your cluster. + When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one instance is provisioned. +10. Select the **Instance Type** based on the number of vCPUs and amount of memory desired. +11. Select the **Storage** type and amount of storage needed for your cluster. !!! Note - Azure premium storage is the only option for the preview. -10. (Steps 10-13 are optional) Select **Advanced Customization** to open more options for your cluster. -11. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -12. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -13. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. -14. Select **Create Cluster**. It might take a few minutes to deploy. + Azure premium storage is the only option for the Preview. +12. (Steps 12-15 are optional) Select **Advanced Customization** to open more options for your cluster. +13. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. +14. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. +15. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +16. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From a28f5874451990566dab3f34efd32d90e21bac31 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 19:16:55 -0700 Subject: [PATCH 129/317] Update 03_modify_and_scale_cluster.mdx Former-commit-id: 000f282c2614c05907a8143ebdeef0c7c5a88c9e --- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 18f6ff267d8..edf8904c3d3 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -10,9 +10,9 @@ title: "Modifying and Scaling Clusters" | ------------- | ----- | | Cluster name | The name for your cluster. | | Cluster password | The password for your cluster. | -| High Availability | High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 replica is provisioned. | -| Instance type* | Select the desired instance based on the number of vCPUs and amount of memory offered. | -| Volume properties* | Select volume properties based on the amount of storage and provisioned IOPS offered. !!! Note: Storage can only be scaled up; it cannot be reduced. | +| High Availability | High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 instance is provisioned. | +| Instance type* | Select the instance based on the number of vCPUs and amount of memory desired. | +| Volume properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. !!! Note: Storage can only be scaled up; it cannot be reduced. | | Number of connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | *Changing the instance type or volume properties could incur higher cloud infrastructure charges. From 9aad015e8a993f3ea89f4e9a4c6db85684a92cbd Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 4 Aug 2021 19:18:18 -0700 Subject: [PATCH 130/317] Update 03_modify_and_scale_cluster.mdx Former-commit-id: aa533229617fd5daf58506499cf302612724ec2e --- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index edf8904c3d3..66abfcae286 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -8,12 +8,12 @@ title: "Modifying and Scaling Clusters" | Configuration | Notes | | ------------- | ----- | -| Cluster name | The name for your cluster. | -| Cluster password | The password for your cluster. | +| Cluster Name | The name for your cluster. | +| Cluster Password | The password for your cluster. | | High Availability | High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 instance is provisioned. | -| Instance type* | Select the instance based on the number of vCPUs and amount of memory desired. | -| Volume properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. !!! Note: Storage can only be scaled up; it cannot be reduced. | -| Number of connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | +| Instance Type* | Select the instance based on the number of vCPUs and amount of memory desired. | +| Volume Properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. !!! Note: Storage can only be scaled up; it cannot be reduced. | +| Number of Connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | *Changing the instance type or volume properties could incur higher cloud infrastructure charges. From 16f1041f84a86b022e92190dda5f4101f3673c01 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Thu, 5 Aug 2021 09:00:16 -0400 Subject: [PATCH 131/317] Update 03_modify_and_scale_cluster.mdx Add networking to editable configurations; change default networking to private Former-commit-id: 0056cefa9177dd791630151992432d4012ec9d03 --- .../edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 66abfcae286..35223a69d89 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -14,6 +14,7 @@ title: "Modifying and Scaling Clusters" | Instance Type* | Select the instance based on the number of vCPUs and amount of memory desired. | | Volume Properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. !!! Note: Storage can only be scaled up; it cannot be reduced. | | Number of Connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | +| Networking | Click the toggle under Networking to enable public networking, which means that any client can connect to your cluster’s public IP address over the internet. By default, your networking is set to private, which allows only IP addresses within your private network to connect to your cluster. | *Changing the instance type or volume properties could incur higher cloud infrastructure charges. From a7a466618914fcc8fed02ebaaabd186b9985f8f5 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 09:45:41 -0400 Subject: [PATCH 132/317] Update 03_create_cluster.mdx more tidying and added a link the versioning topic. I'll need to check that link in the next deployment. Former-commit-id: 75f88c86190698f15d430a6bb1feaa5d31b3b349 --- .../getting_started/03_create_cluster.mdx | 35 ++++++++++--------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index ea58aa6bc21..003f7145890 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -3,31 +3,32 @@ title: "Creating a Cluster" --- To create a cluster: 1. Sign in to the [EDB Cloud portal](https://portal.edbcloud.com). -2. Select the **Create New Cluster** button in the top right of the **Overview** page or **Clusters** page. -3. Enter a **Cluster Name** for your cluster. -4. Enter a **Password** for your cluster. +2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. +3. Enter the name for your cluster in the **Cluster Name** field. +4. Enter a password for your cluster in the **Password** field. !!! Note This is the password for the superuser 'edb_admin'. -5. Select the **Postgres Type**. - - *PostgreSQL* is an open-source object-relational database management system. - - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. -6. Select the **Version** that you want to run your cluster on. Please refer to our versioning policy for more information. -7. Select the **Provider** for your cluster. +5. In the **Database Type** section, + 1. Select the type of Postgres you want to use: + - *PostgreSQL* is an open-source object-relational database management system. + - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. + 6. Select the version that you want to run your cluster on. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. +7. Select the cloud provider for your cluster in the **Provider** field. !!! Note Microsoft Azure is the only option for the preview. -8. Select the **Region** where you want your cluster to be deployed. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. -9. Deselect **High Availability** if not desired. +8. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. +9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. !!! Note When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one instance is provisioned. -10. Select the **Instance Type** based on the number of vCPUs and amount of memory desired. -11. Select the **Storage** type and amount of storage needed for your cluster. +10. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire. +11. Select the type and amount of storage needed for your cluster in the **Storage** field. !!! Note Azure premium storage is the only option for the Preview. -12. (Steps 12-15 are optional) Select **Advanced Customization** to open more options for your cluster. -13. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -14. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -15. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. -16. Select **Create Cluster**. It might take a few minutes to deploy. +12. (Optional) Expand the **Advanced Customization** section, to specify: + 1. The desired amount of connections between your cluster and other applications. You can either enter the amount or use the arrows. The default is 100. + 2. The desired number of days you want your data to be retained for backups. You can either enter the amount or use the arrows. The default is 100. + 3. Whether to use private or public networing. Private networking allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. +17. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 0b5b6801c0f350ccf99ef80d2edcc4d2f8457cde Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 10:20:08 -0400 Subject: [PATCH 133/317] Update 03_create_cluster.mdx first pass at incorporating Kelly's comments Former-commit-id: ab3879cad77c60a581733e57c041f948f0fb5bf3 --- .../beta/getting_started/03_create_cluster.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 003f7145890..580f9e73210 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -5,14 +5,12 @@ To create a cluster: 1. Sign in to the [EDB Cloud portal](https://portal.edbcloud.com). 2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. 3. Enter the name for your cluster in the **Cluster Name** field. -4. Enter a password for your cluster in the **Password** field. - !!! Note - This is the password for the superuser 'edb_admin'. +4. Enter a password for your cluster in the **Password** field. This is the password for the superuser 'edb_admin'. 5. In the **Database Type** section, - 1. Select the type of Postgres you want to use: + 1. Select the type of Postgres you want to use in the **Postgres Type** field: - *PostgreSQL* is an open-source object-relational database management system. - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. - 6. Select the version that you want to run your cluster on. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. + 6. Select the version that you want to run your cluster on in the **Version** field. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. 7. Select the cloud provider for your cluster in the **Provider** field. !!! Note Microsoft Azure is the only option for the preview. @@ -27,7 +25,7 @@ To create a cluster: 12. (Optional) Expand the **Advanced Customization** section, to specify: 1. The desired amount of connections between your cluster and other applications. You can either enter the amount or use the arrows. The default is 100. 2. The desired number of days you want your data to be retained for backups. You can either enter the amount or use the arrows. The default is 100. - 3. Whether to use private or public networing. Private networking allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. + 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Public by default. Public means that any client can connect to your cluster’s public IP address over the internet. Private networking allows only IP addresses within your private network to connect to your cluster. 17. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From bb114ee6dea15beb574a4de8ca244f5243ee3cf8 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Thu, 5 Aug 2021 11:15:37 -0400 Subject: [PATCH 134/317] Update 03_create_cluster.mdx Edit content for networking Former-commit-id: 12b3bfb1dadc473f0009dcf31c24222759fd5d75 --- .../edbcloud/beta/getting_started/03_create_cluster.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index ea58aa6bc21..1b4005a9871 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -22,12 +22,11 @@ To create a cluster: 10. Select the **Instance Type** based on the number of vCPUs and amount of memory desired. 11. Select the **Storage** type and amount of storage needed for your cluster. !!! Note - Azure premium storage is the only option for the Preview. + Azure premium storage is the only option. 12. (Steps 12-15 are optional) Select **Advanced Customization** to open more options for your cluster. 13. Under **Number of Connections**, type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. -14. Under **Backups**, type or use the arrows to enter the desired number of days you want your data to be retained for backups. -15. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Public, which means that any client can connect to your cluster’s public IP address over the internet. -16. Select **Create Cluster**. It might take a few minutes to deploy. +14. Select **Networking** to enable private networking, which allows only IP addresses within your private network to connect to your cluster. By default, your networking is set to Private, which allows only IP addresses within your private network to connect to your cluster. +15. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From c0c987a8708aa46d44e454485ebd85a3140ea9ec Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 11:28:05 -0400 Subject: [PATCH 135/317] Guang's update and removed cloud providers Former-commit-id: 01073056e1852c74da30839a54f73e9f6b63c0ad --- .../docs/edbcloud/beta/cloud_providers/index.mdx | 5 ----- .../beta/cloud_providers/microsoft_azure/index.mdx | 5 ----- .../getting_started/01_connect_cloud_account.mdx | 14 +++++++------- .../beta/getting_started/images/edbcloud.png | 3 +++ product_docs/docs/edbcloud/beta/index.mdx | 1 - 5 files changed, 10 insertions(+), 18 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/index.mdx delete mode 100644 product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/edbcloud.png diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/index.mdx deleted file mode 100644 index eb1c3efe317..00000000000 --- a/product_docs/docs/edbcloud/beta/cloud_providers/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Cloud Providers" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx b/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx deleted file mode 100644 index 5ba833cb26b..00000000000 --- a/product_docs/docs/edbcloud/beta/cloud_providers/microsoft_azure/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Microsoft Azure" ---- - -Document content diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 5c6e5404ab8..4f5642d612b 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -2,20 +2,20 @@ title: "Connect Cloud Account" --- -This topic shows you how to set up UPM Cloud subscription on Azure Marketplace. +This topic shows you how to set up EDB Cloud subscription on Azure Marketplace. ## Prerequisites -1. You should have an Azure subscription to be able to subscribe to EDB Cloud. +1. You should have an Azure subscription where EDB Cloud will create and manage PostgreSQL clusters. 2. You should ensure that your Azure subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses as described below. -3. You should create Azure Active Directory Application (client) to manage the identity of your users within EDB Cloud. +3. You should create Azure Active Directory Application (client) to delegate Identity and Access Management functions to Azure AD. ### Azure Limits on Resources -By default, Azure sets a very low limit on the number of virtual machines and on the number of public Public IP Addresses that are available in a given subscription. Being in a role Owner, Contributor or[ Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) account you could send requests to increase those limits. Please ensure that the _Default subscription filter_ is updated for expected _subscription id_. +By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. Being in a role Owner, Contributor or[ Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) account you could send requests to increase those limits. Please ensure that the _Default subscription filter_ is updated for expected _subscription id_. You can check the current Azure limits for Virtual Machines and Public IP Addresses using the following steps. @@ -46,7 +46,7 @@ Resource Manager, UKSOUTH, ESv4 Series / 50 -### Increasing Private Network Limits +### Increasing Network Limits The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). @@ -79,7 +79,7 @@ Note **Application (client) ID**, you will need it at the final step. Copy **Dis You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. -2. Assign Contributor role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. +2. Assign Owner role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. 3. As an authentication option for the application, choose _application secret._ [Create a new application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) @@ -118,7 +118,7 @@ Before you click the **Configure account now** button, ensure that you have acce -![*EDB Cloud Account Form*](images/setup-edbcloud.png "image_tooltip") +![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") Fill in the values of your parameters and press **Submit.** diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/edbcloud.png b/product_docs/docs/edbcloud/beta/getting_started/images/edbcloud.png new file mode 100644 index 00000000000..feaa2e0f6af --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/edbcloud.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad606ecae8f612ecefb25faa69778752822abd217aef4783290d3f7036b3697e +size 33814 diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index e17d8227975..7393ac64d35 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -8,7 +8,6 @@ navigation: - getting_started - using_cluster - administering_cluster - - cloud_providers - pricing_and_billing - reference - release_notes From ce86f8ce9c7323f0d4ce0dc28def01619b0a23e3 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Thu, 5 Aug 2021 11:32:08 -0400 Subject: [PATCH 136/317] Update index.mdx edit pricing content Former-commit-id: ffa9da752fee5eea280272433a1dec8e441bff65 --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 3fbbf4d1b7f..6518de5baa0 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -3,12 +3,12 @@ title: "Pricing and Billing " --- ## Pricing -A default deployment is composed of one primary and two replica instances of either PostgreSQL or EDB Postgres Adanvced Server. Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. Since each cluster has three instances, the price per vCPU should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: +Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: | Database Type | Hourly Price | Monthly Price* | | --------------------- | -------------- | -------------- | | PostgreSQL | $0.1655 / vCPU | $120.82 / vCPU | -| EDB Postgres Advanced | $0.2397 / vCPU | $174.98 / vCPU | +| EDB Postgres Advanced Server | $0.2397 / vCPU | $174.98 / vCPU | *The monthly cost is approximate and assumes 730 hours in a month. From 3eb9c78d3fa57285b6e0956f0b301d840146102f Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 12:26:07 -0400 Subject: [PATCH 137/317] doc(UPM-914): implemented Guang's recomendations Former-commit-id: 555b10daac9868e18ddab6b89ab8ff050d2323bd --- .../01_connect_cloud_account.mdx | 27 +++++++++---------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 4f5642d612b..263baed0fc5 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -29,24 +29,21 @@ You can check the current Azure limits for Virtual Machines and Public IP Addres ### Increasing Virtual Machines Limits -Default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. This limit has to be increased to at least 50 virtual machines per region. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your Virtual Machines Limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. +Default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. This limit has to be increased to at least 50 virtual machines per region. EDB Cloud uses Virtual Machines of ESv3 Series. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series Virtual Machines Limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. Below is an example of request to increase Virtual Machines Limits: ``` Request Summary / New Limit: -Resource Manager, EASTUS, DSv2 Series / 50 Resource Manager, EASTUS, ESv3 Series / 50 -Resource Manager, EASTUS, ESv4 Series / 50 -Resource Manager, UKSOUTH, DSv2 Series / 50 Resource Manager, UKSOUTH, ESv3 Series / 50 -Resource Manager, UKSOUTH, ESv4 Series / 50 + ``` -### Increasing Network Limits +### Increasing Network Limits The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). @@ -66,12 +63,13 @@ Ensure that you know where to find the values of the parameters listed in the ta | **Azure Subscription ID** | You can get Azure subscription ID from the overview page of a subscription. | | **Your EDB Cloud Organization Name** | Name you assign to your EDB Cloud Organization Name | - +!!! Note + You have to ensure the Azure client application ID and Azure subscription ID are all in the same Azure AD tenant. ### Azure AD Application -Azure Active Directory Application provides identity to EDB Cloud users that come from your organization and are members of your Azure Active Directory Application. + To create Azure Active Directory Application do the following: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). @@ -79,23 +77,22 @@ Note **Application (client) ID**, you will need it at the final step. Copy **Dis You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. -2. Assign Owner role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. +2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. -3. As an authentication option for the application, choose _application secret._ [Create a new application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) +3. As an authentication option for the application, choose _application secret._ [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it at the final step. 4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). ## Procedure -1. Sign in to Azure portal portal.azure.com and go to Azure **Marketplace** -2. On the left navigation pane click link **Private Offers + Plans**. -Find an offer for **EDB PostgresQL-as-service (preview)** from **EnterpriseDB Corporation** and click on it. +1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace** +2. Find an offer for **EDB PostgresQL-as-service** from **EnterpriseDB Corporation** and click on it. You should see the following form: ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) -3. In **Select Plan** input, select **Trial** option. Click on **Set up +subscribe** button. That should lead to the form. +3. In **Select Plan** input, select an available plan. Click on **Set up +subscribe** button. That should lead to the form. ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") @@ -122,4 +119,4 @@ Before you click the **Configure account now** button, ensure that you have acce Fill in the values of your parameters and press **Submit.** -If you fill in your parameters correctly, this will lead you to EDB Cloud login form where you can login to your EDB Cloud account using your Azure AD identity. +If you fill in your parameters correctly, this will lead you to EDB Cloud login screen where you can login to your EDB Cloud account using your Azure AD identity. From a2378026db5320fc3483bcad164f60c5c8d9bf9f Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 13:03:12 -0400 Subject: [PATCH 138/317] Update product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx Former-commit-id: 3dbce27bcb45a1276e9a93184d63656ecf4535ee --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 6518de5baa0..068ca29101b 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -3,7 +3,7 @@ title: "Pricing and Billing " --- ## Pricing -Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by 3 to calculate the full price for all resources used. See the full cost breakdown below: +Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by three to calculate the full price for all resources used. See the full cost breakdown below: | Database Type | Hourly Price | Monthly Price* | | --------------------- | -------------- | -------------- | From bbbbd15eadabf36193a21b372972393131c03d94 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 13:36:57 -0400 Subject: [PATCH 139/317] Update 03_create_cluster.mdx Former-commit-id: 882adf7e06d0b3ac55e63f020df607159398893e --- .../edbcloud/beta/getting_started/03_create_cluster.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 580f9e73210..0db0af7547d 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -15,9 +15,7 @@ To create a cluster: !!! Note Microsoft Azure is the only option for the preview. 8. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. -9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. - !!! Note - When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one instance is provisioned. +9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one instance is provisioned. 10. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire. 11. Select the type and amount of storage needed for your cluster in the **Storage** field. !!! Note @@ -25,8 +23,8 @@ To create a cluster: 12. (Optional) Expand the **Advanced Customization** section, to specify: 1. The desired amount of connections between your cluster and other applications. You can either enter the amount or use the arrows. The default is 100. 2. The desired number of days you want your data to be retained for backups. You can either enter the amount or use the arrows. The default is 100. - 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Public by default. Public means that any client can connect to your cluster’s public IP address over the internet. Private networking allows only IP addresses within your private network to connect to your cluster. -17. Select **Create Cluster**. It might take a few minutes to deploy. + 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. +17. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 17ffe15a3d538d47dae682d7418e226ae4e3d234 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 14:57:24 -0400 Subject: [PATCH 140/317] doc(UPM-915): implemented Guang's recomendations Former-commit-id: 49a1e8867fc4dd46b1a7f2337a0dbd46253b84a8 --- .../beta/getting_started/02_configure_acess.mdx | 14 +++++++++++--- .../beta/getting_started/images/assign-roles.png | 3 +++ .../getting_started/images/edit-user-roles.png | 3 --- 3 files changed, 14 insertions(+), 6 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/assign-roles.png delete mode 100644 product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx index 0dd84ef60e8..1336450cd45 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx @@ -17,6 +17,9 @@ After you created your Azure subscription and logged in into EDB Cloud for the f ### Configure Roles +!!! Note + This feature may not be available in the preview release. The preview release may have only one predefined role _Owner_. + Organization wide roles are configured in the following screen: ![Roles](images/roles.png "organization roles") @@ -27,7 +30,11 @@ Use the **Edit** button with a pen icon to edit permissions for a specific role. ### Invite Users -When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using their organization emails. New users signed in to EDB Cloud have a minimum set of permissions. +When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using special emails designated by your organization to sign in using Azure AD. +!!! Note + Azure AD email domain will likely be different from the domain regurly used by your organization. +New users signed in to EDB Cloud have a minimum set of permissions. + ### Assign Roles to Users @@ -39,8 +46,9 @@ All users logged in to EDB Cloud will be listed in the following screen, sorted To assign appropriate roles to users, first find the right user and click **Edit** button with the pen icon. In the user screen, use the button **Assign Roles** to edit user roles. +![Assign Roles to Users](images/assign-roles.png "list users") - - +!!! Note + For a user's role assignment to take effect, the user should sign out from EDB Cloud and sign in again. diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/assign-roles.png b/product_docs/docs/edbcloud/beta/getting_started/images/assign-roles.png new file mode 100644 index 00000000000..8d04df0cb41 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/images/assign-roles.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2c1b79bb06257df4ddb28e9b93316fabc5240727b34d884e1816ec4734ee64c +size 49339 diff --git a/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png b/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png deleted file mode 100644 index 7c539a61b26..00000000000 --- a/product_docs/docs/edbcloud/beta/getting_started/images/edit-user-roles.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a376c8ea80ff5f35dbc160c8d254526d15906af1292d114b951ee9d49fd13176 -size 57634 From a6822e1b618fc47e896e9df15383521cbe096bea Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 15:56:54 -0400 Subject: [PATCH 141/317] Update 01_connect_cloud_account.mdx Former-commit-id: 9ba1552d9c02d56373e24babe69dacf5ee8a1302 --- .../01_connect_cloud_account.mdx | 92 +++++++------------ 1 file changed, 35 insertions(+), 57 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 263baed0fc5..ad821693a3d 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -1,38 +1,35 @@ --- -title: "Connect Cloud Account" +title: "Connecting Your Cloud Account" --- -This topic shows you how to set up EDB Cloud subscription on Azure Marketplace. +This topic describes how to set up your EDB Cloud subscription on Azure Marketplace. Your Azure subscription is where EDB Cloud can create and manage PostgreSQL clusters. -## Prerequisites +## Before You Begin +You need to check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See Azure Limits. +You need to create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See -1. You should have an Azure subscription where EDB Cloud will create and manage PostgreSQL clusters. -2. You should ensure that your Azure subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses as described below. -3. You should create Azure Active Directory Application (client) to delegate Identity and Access Management functions to Azure AD. +You need to gather information needed for the subscription form. See +### Azure Resource Limits -### Azure Limits on Resources +By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. -By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. Being in a role Owner, Contributor or[ Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) account you could send requests to increase those limits. Please ensure that the _Default subscription filter_ is updated for expected _subscription id_. +The default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. You need to increase this limit to at least 50 virtual machines per region. EDB Cloud uses ESv3 Series virtual machines. -You can check the current Azure limits for Virtual Machines and Public IP Addresses using the following steps. +The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. +To check the current Azure limits for virtual machines and public IP addresses: +1. In the Azure Portal, select **Subscription**. +2. Select **Settings** > **Usage + quotas**. +1. Search for vCPU to view virtual machines limits. +1. Search for Public IP to view networks limits. -1. In Azure Portal, select _Subscription_. -2. Under **Settings**, select _Usage + quotas_ -3. To view Virtual Machines Limits enter the search term _vCPU_ in the **Search** box**.** -4. To view Networks Limits enter the search term _Public IP_ in the **Search** box**.** - - -### Increasing Virtual Machines Limits - -Default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. This limit has to be increased to at least 50 virtual machines per region. EDB Cloud uses Virtual Machines of ESv3 Series. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series Virtual Machines Limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. - -Below is an example of request to increase Virtual Machines Limits: +If your role is Owner, Contributor or Support Request Contributor account you can send requests to increase those limits. Please ensure that the Default subscription filter is updated for the expected subscription id. +Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. This is an example of a request to increase virtual machines limits: ``` Request Summary / New Limit: @@ -40,19 +37,12 @@ Resource Manager, EASTUS, ESv3 Series / 50 Resource Manager, UKSOUTH, ESv3 Series / 50 ``` - - - -### Increasing Network Limits - -The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). +To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). ### Required Parameters - - -The following table describes the parameters that need to be entered in the EDB Cloud subscription form. +The following table describes the parameters that need to be entered in the EDB Cloud subscription form. Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. @@ -67,56 +57,44 @@ Ensure that you know where to find the values of the parameters listed in the ta You have to ensure the Azure client application ID and Azure subscription ID are all in the same Azure AD tenant. -### Azure AD Application - +### Azure AD Application - -To create Azure Active Directory Application do the following: +To create an Azure Active Directory Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). Note **Application (client) ID**, you will need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. - 2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. 3. As an authentication option for the application, choose _application secret._ [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it at the final step. 4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). -## Procedure +## Creating Your Subscription 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace** -2. Find an offer for **EDB PostgresQL-as-service** from **EnterpriseDB Corporation** and click on it. -You should see the following form: - +2. Find an offer for **EDB PostgresQL-as-service** from **EnterpriseDB Corporation** and select it. ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) -3. In **Select Plan** input, select an available plan. Click on **Set up +subscribe** button. That should lead to the form. +3. select an available plan from the **Select Plan** drop-down list. +4. Select **Set up +subscribe**. ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") -Enter or create a Resource** Group** for your subscription. Select SaaS subscription **Name.** -Press the button at the bottom **Review+ subscribe** at the bottom of the form. -This will lead to the confirmation form that describes **Terms of use. -**Review the terms of use and press the **Subscribe** button at the bottom. -This will complete your Azure SaaS subscription and lead you to the following form. - - - +1. In the **Project details** section, + 1. Enter or create a **Resource Group** for your subscription. + 3. Select the SaaS subscription name. +1. Select **Review+ subscribe**. +1. Review the terms of use and select **Subscribe**. ![*Subscription progress](images/subscription-process.png "image_tooltip") - - -4. Finally, you must configure EDB Cloud to use your Azure subscription, your Azure AD Application. -Before you click the **Configure account now** button, ensure that you have access to the values of parameters described in the prerequisite section above. -5. After clicking the **Configure account now** button, you should see a form to enter prerequisite parameters. - - +4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription, and your Azure AD Application. +You need accessmto the values of parameters described [Required Parameters](#Required Parameters) to fill out the form. ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") - -Fill in the values of your parameters and press **Submit.** -If you fill in your parameters correctly, this will lead you to EDB Cloud login screen where you can login to your EDB Cloud account using your Azure AD identity. +1. After filling in the form, select **Submit.** + +If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. From ea49e2c3fe875c837ef78b90e51e3b0c6906b85d Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 13:17:21 -0700 Subject: [PATCH 142/317] Update 01_connect_cloud_account.mdx Former-commit-id: 637a4ca0ab7e8a3d6cde01f727be6c8aa18ab76a --- .../beta/getting_started/01_connect_cloud_account.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index ad821693a3d..7e57c1a4cf5 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -18,7 +18,7 @@ By default, Azure sets a very low limit on the number of virtual machines per re The default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. You need to increase this limit to at least 50 virtual machines per region. EDB Cloud uses ESv3 Series virtual machines. -The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` set to 10. Raise the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud PostgreSQL clusters. +The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` is set to 10. You need to increase the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud Postgres clusters. To check the current Azure limits for virtual machines and public IP addresses: @@ -27,9 +27,9 @@ To check the current Azure limits for virtual machines and public IP addresses: 1. Search for vCPU to view virtual machines limits. 1. Search for Public IP to view networks limits. -If your role is Owner, Contributor or Support Request Contributor account you can send requests to increase those limits. Please ensure that the Default subscription filter is updated for the expected subscription id. +If your role is Owner, Contributor or Support Request Contributor for your Azure account, you can send requests to increase those limits. Please ensure that the Default subscription filter is updated for the expected subscription id. -Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud PostgreSQL clusters. This is an example of a request to increase virtual machines limits: +Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: ``` Request Summary / New Limit: @@ -51,10 +51,10 @@ Ensure that you know where to find the values of the parameters listed in the ta | **Azure AD App ID** | Application (client) ID | | **Azure AD App Secret** | Value of application (client) secret | | **Azure Subscription ID** | You can get Azure subscription ID from the overview page of a subscription. | -| **Your EDB Cloud Organization Name** | Name you assign to your EDB Cloud Organization Name | +| **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization Name | !!! Note - You have to ensure the Azure client application ID and Azure subscription ID are all in the same Azure AD tenant. + You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. ### Azure AD Application From 5624a90aa0ba4e685eb826ff95fd94f9c7c36922 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 13:22:17 -0700 Subject: [PATCH 143/317] Update 01_connect_cloud_account.mdx Former-commit-id: 42c358b7493c4d3a662f6a1f09fbeaf55eb6feea --- .../beta/getting_started/01_connect_cloud_account.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 7e57c1a4cf5..b58dd292cef 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -72,8 +72,8 @@ You will need to enter **Display name** _as is_ in the **Select** field, at the ## Creating Your Subscription -1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace** -2. Find an offer for **EDB PostgresQL-as-service** from **EnterpriseDB Corporation** and select it. +1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace** +2. Find an offer from **EnterpriseDB Corporation** and select it. ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) From 82f842148ff24f102d845b8a9ef39dcc8ef2a2ee Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Thu, 5 Aug 2021 16:42:11 -0400 Subject: [PATCH 144/317] Update index.mdx I re-worked the overview description from the raw notes I had previously. Amrita shared a number of examples of other overview pages and the content is very concise and to the point, I aimed to draft this in the same way. Former-commit-id: 3a2773af86b64b908ac4b19d18d17efc941fd2f8 --- product_docs/docs/edbcloud/beta/overview/index.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index 6c8b44281ff..ca2b0b8b710 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -4,11 +4,7 @@ description: "Learn about EDB Cloud " --- -- A fully managed database as a service offering for both PostgreSQL and EDB Postgres Advanced with Oracle Compatibility. - -- Runs in your cloud account, but is fully managed and operated by EDB. - -- Available via the Microsoft Azure Marketplace. +EDB Cloud is a fully managed database as a service with built-in Oracle compatibility, running in your cloud account, and operated by the Postgres experts. EDB Cloud 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 with Oracle compatibility](https://www.enterprisedb.com/docs/epas/latest/). From 6d374ea77b3704e25fedeb084fad4fbe7b8a983e Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 17:19:05 -0400 Subject: [PATCH 145/317] doc(UPM-926): implemented Guang's recomendations Former-commit-id: 4177cceed163dd30e6b2b8cc4eeda95e89416604 --- .../organization_and_access/01_organizations.mdx | 11 +++++++---- .../organization_and_access/images/map1.puml | 7 ++++--- .../organization_and_access/images/org-map.png | 3 +++ 3 files changed, 14 insertions(+), 7 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx index 64aebc73fcd..24deddcc721 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx @@ -5,18 +5,21 @@ title: "Organizations" Each subscribed customer has a unique *organization* object in the cloud. An organization is synonymous with a customer. Organizations are completely isolated from each other. Each organization’s database clusters are installed and managed in their own cloud environment ensuring complete segregation of customer data. -Azure Active Directory (AD) establishes the identity of an organization. During subscription, you link your Azure AD and users that belong to that AD can login with minimum access privileges. +EDB Cloud Organization belongs to Azure AD tenant. Azure Active Directory (AD) establishes the identity of users that belong to an organization. During subscription, you link your Azure AD and users that belong to that AD can login with minimum access privileges. -EDB Cloud supports role based access control policies. A user with the **owner** role may define their own sets of roles which can be applied across the organization. A user with the **owner** role may assign roles to other users in the same organization. +EDB Cloud supports role based access control policies. A user with the **owner** role may define their own sets of roles which can be applied across the organization. +!!! Note + This feature may not be available in the preview release. +A user with the **owner** role may assign roles to other users in the same organization. Example scenario: 1. AcmeBank owns a subcription to Azure and the acmebank.com Azure AD. 1. AcmeBank purchases a subscription to the EDB cloud and assigns the name acmebank-com for their organization. 1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. 1. Users Tom and Jerry have different roles with different priviledges. -1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced (EPAS) clusters. +1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced (EPAS) clusters. 2. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. The following diagram illustrates a mapping between objects that exist within the EDB cloud and Azure cloud for AcmeBank example scenario. -![*EDB Cloud and Azure*](images/orgmap.png ) +![*EDB Cloud and Azure*](images/org-map.png ) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml index a65df61cb2f..99e881cf29c 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml @@ -8,11 +8,12 @@ !define AzurePuml https://raw.githubusercontent.com/plantuml-stdlib/Azure-PlantUML/master/dist !includeurl AzurePuml/AzureCommon.puml +!includeurl AzurePuml/AzureSimplified.puml !includeurl AzurePuml/Databases/AzureDatabaseForPostgreSQL.puml !includeurl AzurePuml/Identity/AzureActiveDirectoryB2C.puml !includeurl AzurePuml/Identity/AzureActiveDirectoryDomainServices.puml left to right direction -LAYOUT_WITH_LEGEND() + rectangle "EDB Cloud" as src { rectangle "EDB Cloud Clusters" as edbclusters { @@ -51,9 +52,9 @@ rectangle Azure as tgt { } AzureActiveDirectoryDomainServices(AD, "Azure AD Tenant", "tenant acmebank.com") - jerry -> regions: owns -} +} +jerry -> regions: owns src -[hidden]d-> tgt regions -[hidden]u-> edbclusters org <-> AD: "1:1" diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png new file mode 100644 index 00000000000..f9e4c329dc9 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f0e8b1b8494d55b4d7f9d51a3880f364312b86906f051ec9d7b2d763f7970f3 +size 43087 From 979639b39c66460d0f3a30fe713953d05ef6eb7d Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 17:43:07 -0400 Subject: [PATCH 146/317] doc(UPM-927): implemented Guang's recomendations Former-commit-id: 9a24bba63c3ebf46c32ac2a04ce3c97f4672ea38 --- .../organization_and_access/02_users.mdx | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 6ea6a375ed0..a5bbdc7517c 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,7 +1,14 @@ --- title: "Users" --- -You can view all users that are logged in, sorted by the time of the latest login, on the Admin screen. + +## Viewing Users +If you have a role that grants you access to Admin screen, you can view all users from your organization that has been logged in at least once. + +To view users: +- Navigate to Admin->Users. + +The list of users is sorted by the time of the latest login. !!! Note The preview release contains only the minimum viable functionality for managing users and role based access control. @@ -11,9 +18,10 @@ EDB will add search functionality as well as many other features for managing us ![Users](images/users.png "Users") +## Assigning Roles to Users To assign appropriate roles to users: -1. Navigate to Admin > Users. -2. Select the edit icon for the user. +1. Navigate to Admin > Users. +2. Select the edit icon for the user. 3. Select **Assign Roles**. 4. Select or deselect roles for the user. 5. Select **Submit**. From e69c20064178677a09884f3804de383f7a4a6e7c Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 18:03:57 -0400 Subject: [PATCH 147/317] doc(UPM-928): implemented Guang's recomendations Former-commit-id: 991872b5850e7637c4530df11734a4c3a75a49db --- .../organization_and_access/02_users.mdx | 2 +- .../organization_and_access/03_roles.mdx | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index a5bbdc7517c..ae26bc757e9 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -6,7 +6,7 @@ title: "Users" If you have a role that grants you access to Admin screen, you can view all users from your organization that has been logged in at least once. To view users: -- Navigate to Admin->Users. +- Navigate to Admin > Users. The list of users is sorted by the time of the latest login. diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx index 82ba86c75b0..53e94e204d5 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx @@ -4,16 +4,17 @@ title: "Roles" Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Role is a convenient abstraction to manage permissions assigned to users. +* The predefined _owner_ role created during marketplace sign up has all permissions. * EDB Cloud preview uses 3 template roles _reader_, _contributor_ and _owner_ * These roles can be edited, including changing their name and changing set of associated permissions !!! Note - The release version of EDB Cloud will allow adding new Roles and Delete new Roles. + The general release version of EDB Cloud will allow adding new roles and deleting roles. ## Structure of Permissions -In general a permission is a string made of prefix and suffix separated by column. +In general a permission is a string made of prefix and suffix separated by colon. Most permissions have format _action:object_. The available _actions_ are: @@ -32,7 +33,6 @@ The prefix _object_ defines a part of EDB Cloud functionality. The available _ * _permissions_ * _roles_ * _users_ -* _tickets_ * _billing_ * _versions_ @@ -41,6 +41,9 @@ There are two special permissions for superset, where suffix defines superset ro * _superset:alpha_ * _superset:admin_ +!!! Note + Superset and Superset related permissions may not be available in the preview release. + ## Roles Edit Screen To edit roles: 1. Navigate to Admin > Roles. From ddc3fb5efd9a0592c9aaeb9a97a4d677c9c114dc Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 15:46:02 -0700 Subject: [PATCH 148/317] Update 03_create_cluster.mdx Former-commit-id: 501d8cfec53652fdfde656a04e01627b5ec970d0 --- .../beta/getting_started/03_create_cluster.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 30fb8557a0e..7a9f7c06728 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,26 +2,26 @@ title: "Creating a Cluster" --- To create a cluster: -1. Sign in to the [EDB Cloud portal](https://portal.edbcloud.com). +1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal. 2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. 3. Enter the name for your cluster in the **Cluster Name** field. -4. Enter a password for your cluster in the **Password** field. This is the password for the superuser 'edb_admin'. +4. Enter a password for your cluster in the **Password** field. This will be the password for the superuser 'edb_admin'. 5. In the **Database Type** section, 1. Select the type of Postgres you want to use in the **Postgres Type** field: - *PostgreSQL* is an open-source object-relational database management system. - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. - 6. Select the version that you want to run your cluster on in the **Version** field. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. + 6. Select the version of Postgres that you want to use in the **Version** field. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. 7. Select the cloud provider for your cluster in the **Provider** field. !!! Note - Microsoft Azure is the only option for the preview. + Microsoft Azure is the only option for the Preview. 8. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster. -9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, one instance is provisioned. +9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, only one instance is provisioned. 10. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire. 11. Select the type and amount of storage needed for your cluster in the **Storage** field. !!! Note Azure premium storage is the only option for the Preview. 12. (Optional) Expand the **Advanced Customization** section, to specify: - 1. The desired amount of connections between your cluster and other applications. You can either enter the amount or use the arrows. The default is 100. + 1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100. 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. 17. Select **Create Cluster**. It might take a few minutes to deploy. From 3a26a7ea4563170afd5806666c49f66398b47a17 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 16:20:34 -0700 Subject: [PATCH 149/317] Update 02_users.mdx Former-commit-id: d64a2537d00b40081710393e6ef6c8407972a68f --- .../organization_and_access/02_users.mdx | 29 ++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index ae26bc757e9..5df52c1977e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,23 +1,32 @@ --- -title: "Users" +title: "Managing Users and Access" --- -## Viewing Users -If you have a role that grants you access to Admin screen, you can view all users from your organization that has been logged in at least once. +!!! +Access to the Admin screen is required for these actions + +The Preview contains minimum functionality for managing users and role based access control. EDB will add search functionality as well as many other features for managing users in subsequent releases. +!!! -To view users: -- Navigate to Admin > Users. +## Adding Users + -The list of users is sorted by the time of the latest login. +## Removing Users +This functionality will be added in the future + +## Viewing Users -!!! Note -The preview release contains only the minimum viable functionality for managing users and role based access control. +To view all users from your organization that have logged in at least once: -EDB will add search functionality as well as many other features for managing users in subsequent releases. -!!! +1. Navigate to Admin > Users. + +2. View the list of users sorted by most recent log in. ![Users](images/users.png "Users") +## Understanding Roles + + ## Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. From 7017bb8bdcbde88a7ba5b55557e1bc0ddb5533d0 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:09:24 -0700 Subject: [PATCH 150/317] Update 02_users.mdx Former-commit-id: fd9e78bc5462db8974445cd49b4f60e2e726fa0b --- .../organization_and_access/02_users.mdx | 82 ++++++++++++++++--- 1 file changed, 70 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 5df52c1977e..faac9399530 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -8,26 +8,85 @@ Access to the Admin screen is required for these actions The Preview contains minimum functionality for managing users and role based access control. EDB will add search functionality as well as many other features for managing users in subsequent releases. !!! -## Adding Users - +## Roles + +### Type of Roles +Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Roles are a convenient abstraction to manage permissions assigned to users. + +* The predefined _owner_ role created during marketplace sign up has all permissions. +* Each organization will have two additional default roles of _reader_ and _contributor available during Preview. +* These roles can be edited by changing their name, description, or permissions + +### Structure of Permissions + +Permissions are generally represented in the format _action:object_. where _action_ represents an operation that can be performed and _object_ represents a categoroy oof EDB Cloud functionality. + +The available _actions_ are: +* _create _ +* _read _ +* _update _ +* _delete_ + +The available _objects_ are: +* _databases_ +* _backups_ +* _events_ +* _permissions_ +* _roles_ +* _users_ +* _billing_ +* _versions_ + +There are two special permissions for superset, where suffix defines superset role: + +* _superset:alpha_ +* _superset:admin_ + +!!! Note + Superset and Superset related permissions may not be available in the preview release. + +### Editing Roles +To edit roles: +1. Navigate to Admin > Roles. +2. Select the edit icon for the role in the list. -## Removing Users -This functionality will be added in the future +#### Changing Role Name +To change **Name** or **Description** of the role: +1. Select **Settings** tab. +2. Edit **Name** or **Description** +3. Press **Save**. + +#### Changing Role Permissions + +To change permissions associated with the role: +1. Select **Permissions** tab. +2. Press **Change Permissions** button in the top right. +3. Select the list of permissions you want to be associated with the role. +4. Press **Submit** + +## Finding Users in the Role + +* To find users associated with the role, select **Users** tab. + +## Users -## Viewing Users +### Adding Users + +This functionality will be available beginning with the GA release. + +### Removing Users +This functionality will be available beginning with the GA release. + +### Viewing Users To view all users from your organization that have logged in at least once: 1. Navigate to Admin > Users. - 2. View the list of users sorted by most recent log in. -![Users](images/users.png "Users") - -## Understanding Roles - +![Users](images/users.png "Users") -## Assigning Roles to Users +### Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. 2. Select the edit icon for the user. @@ -38,5 +97,4 @@ To assign appropriate roles to users: ![Edit User Roles](images/edit-user.png "Edit User Roles") -To learn about roles and how roles define user permissions to various functionalities [click here](https://docs.google.com/document/d/13GyHBRYt8fpNINQU6JcqEnuJI7fv33tJzIaPF4_Pcp4/edit#) From 88be6bbd1c76f6e78bc0e5308ece78b51bfb6d02 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:16:27 -0700 Subject: [PATCH 151/317] Update 02_users.mdx Former-commit-id: b3e1dc2cd3b01b30557f9639ae3bc9cd48e1d4c9 --- .../organization_and_access/02_users.mdx | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index faac9399530..6d402312e19 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -5,16 +5,14 @@ title: "Managing Users and Access" !!! Access to the Admin screen is required for these actions -The Preview contains minimum functionality for managing users and role based access control. EDB will add search functionality as well as many other features for managing users in subsequent releases. -!!! -## Roles +# Roles -### Type of Roles +## Type of Roles Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Roles are a convenient abstraction to manage permissions assigned to users. * The predefined _owner_ role created during marketplace sign up has all permissions. -* Each organization will have two additional default roles of _reader_ and _contributor available during Preview. +* Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions ### Structure of Permissions @@ -45,18 +43,24 @@ There are two special permissions for superset, where suffix defines superset ro !!! Note Superset and Superset related permissions may not be available in the preview release. -### Editing Roles +## Adding Roles +This functionality will be available beginning with the GA release. + +## Removing Roles +This functionality will be available beginning with the GA release. + +## Editing Roles To edit roles: 1. Navigate to Admin > Roles. 2. Select the edit icon for the role in the list. -#### Changing Role Name +### Changing Role Name To change **Name** or **Description** of the role: 1. Select **Settings** tab. 2. Edit **Name** or **Description** 3. Press **Save**. -#### Changing Role Permissions +### Changing Role Permissions To change permissions associated with the role: 1. Select **Permissions** tab. @@ -64,20 +68,22 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** + ## Finding Users in the Role * To find users associated with the role, select **Users** tab. +* ?? -## Users +# Users -### Adding Users +## Adding Users This functionality will be available beginning with the GA release. -### Removing Users +## Removing Users This functionality will be available beginning with the GA release. -### Viewing Users +## Viewing Users To view all users from your organization that have logged in at least once: @@ -86,6 +92,8 @@ To view all users from your organization that have logged in at least once: ![Users](images/users.png "Users") +## Modifying Users + ### Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. From abdb7795efd04629ccd9c0be25acd8f79347ef52 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 5 Aug 2021 20:30:37 -0400 Subject: [PATCH 152/317] Update 01_connect_cloud_account.mdx More edits Former-commit-id: 569709feb125aa9448dbdc16b03942a82baa58b2 --- .../01_connect_cloud_account.mdx | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index b58dd292cef..d2c92f7cedd 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -6,11 +6,11 @@ This topic describes how to set up your EDB Cloud subscription on Azure Marketpl ## Before You Begin -You need to check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See Azure Limits. +Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Azure-Resource-Limits). -You need to create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See +Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#Azure-AD=Application). -You need to gather information needed for the subscription form. See +Gather information needed for the subscription form. See [Required Parameters](#Required-Parameters). ### Azure Resource Limits @@ -27,7 +27,7 @@ To check the current Azure limits for virtual machines and public IP addresses: 1. Search for vCPU to view virtual machines limits. 1. Search for Public IP to view networks limits. -If your role is Owner, Contributor or Support Request Contributor for your Azure account, you can send requests to increase those limits. Please ensure that the Default subscription filter is updated for the expected subscription id. +If your role is Owner, Contributor, or [Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) for your Azure account, you can send requests to increase those limits. Please ensure that the *Default subscription filter* is updated for the expected *subscription id*. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: @@ -50,8 +50,8 @@ Ensure that you know where to find the values of the parameters listed in the ta | ------------------------------------- | ---------------------------------------------------------------------------- | | **Azure AD App ID** | Application (client) ID | | **Azure AD App Secret** | Value of application (client) secret | -| **Azure Subscription ID** | You can get Azure subscription ID from the overview page of a subscription. | -| **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization Name | +| **Azure Subscription ID** | Azure subscription ID from the overview page of a subscription. | +| **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization | !!! Note You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. @@ -61,18 +61,18 @@ Ensure that you know where to find the values of the parameters listed in the ta To create an Azure Active Directory Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -Note **Application (client) ID**, you will need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. +Take note of the **Application (client) ID**, you need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. -2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Assign the value of **Display name** of Azure AD application in **Select** box of **Add role assignment** panel. +2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. -3. As an authentication option for the application, choose _application secret._ [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it at the final step. +3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it for the final step. 4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). ## Creating Your Subscription -1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace** +1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. 2. Find an offer from **EnterpriseDB Corporation** and select it. ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) @@ -90,11 +90,11 @@ You will need to enter **Display name** _as is_ in the **Select** field, at the ![*Subscription progress](images/subscription-process.png "image_tooltip") -4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription, and your Azure AD Application. -You need accessmto the values of parameters described [Required Parameters](#Required Parameters) to fill out the form. +4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. +You need access to the values of parameters described in [Required Parameters](#Required-Parameters) to fill out the form. ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") -1. After filling in the form, select **Submit.** +5. After filling in the form, select **Submit.** If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. From 05fe6e38c13cd54cc0752bd25a0943be1f93bc77 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:36:24 -0700 Subject: [PATCH 153/317] Update 02_users.mdx Former-commit-id: 2342eeb5199bf60680ab3c44cf8b475f6702ecae --- .../organization_and_access/02_users.mdx | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 6d402312e19..8673c84497f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -35,14 +35,6 @@ The available _objects_ are: * _billing_ * _versions_ -There are two special permissions for superset, where suffix defines superset role: - -* _superset:alpha_ -* _superset:admin_ - -!!! Note - Superset and Superset related permissions may not be available in the preview release. - ## Adding Roles This functionality will be available beginning with the GA release. @@ -77,8 +69,7 @@ To change permissions associated with the role: # Users ## Adding Users - -This functionality will be available beginning with the GA release. +New users can be added by an invite email from an _owner_. See . New users will not be assigned a roles by default. After they log in the fist time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. ## Removing Users This functionality will be available beginning with the GA release. From d819bb9988db2b837870aafaae74dbd4da9313e6 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:39:20 -0700 Subject: [PATCH 154/317] Update 02_users.mdx Former-commit-id: 9dfce0f5bae1eb87c92167e6b915456304a9b634 --- .../organization_and_access/02_users.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 8673c84497f..4b3d85bf8c6 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -8,14 +8,14 @@ Access to the Admin screen is required for these actions # Roles -## Type of Roles +## Default Roles Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Roles are a convenient abstraction to manage permissions assigned to users. * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions -### Structure of Permissions +### Role Permissions Permissions are generally represented in the format _action:object_. where _action_ represents an operation that can be performed and _object_ represents a categoroy oof EDB Cloud functionality. From 9ab37acc242f2e4de31dd7fe65d21f01b77d26bf Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:44:06 -0700 Subject: [PATCH 155/317] Update 02_users.mdx Former-commit-id: 7d2277dbc1a8a15c91e0f7678c9cc93591eb915b --- .../organization_and_access/02_users.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 4b3d85bf8c6..289cd203163 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -15,7 +15,7 @@ Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. R * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions -### Role Permissions +## Role Permissions Permissions are generally represented in the format _action:object_. where _action_ represents an operation that can be performed and _object_ represents a categoroy oof EDB Cloud functionality. @@ -69,7 +69,7 @@ To change permissions associated with the role: # Users ## Adding Users -New users can be added by an invite email from an _owner_. See . New users will not be assigned a roles by default. After they log in the fist time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. +New users can be added by an invite email from an _owner_. See **add link to Invite Users section in Getting Started**. New users will not be assigned a roles by default. After they log in the first time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. ## Removing Users This functionality will be available beginning with the GA release. From 436b4eaa2e219fe4f1c3c9eaa411eb32fa722518 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 17:50:14 -0700 Subject: [PATCH 156/317] Update 02_users.mdx Former-commit-id: 818754c4771784cb10ab398966aaed00e020a228 --- .../administering_cluster/organization_and_access/02_users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 289cd203163..3d09829f5d0 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -17,7 +17,7 @@ Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. R ## Role Permissions -Permissions are generally represented in the format _action:object_. where _action_ represents an operation that can be performed and _object_ represents a categoroy oof EDB Cloud functionality. +Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a categoroy of EDB Cloud functionality. The available _actions_ are: * _create _ From 2fa137863c23756a96a505ded8dd95d1a50cd5a2 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 18:14:57 -0700 Subject: [PATCH 157/317] Create 01_connect_cloud_account.mdx Former-commit-id: 9505b52c29eabbdc9aa1bbcf00481aa0351d2f82 --- .../01_connect_cloud_account.mdx | 55 ++++++++++--------- 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index d2c92f7cedd..db078221c42 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -6,13 +6,13 @@ This topic describes how to set up your EDB Cloud subscription on Azure Marketpl ## Before You Begin -Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Azure-Resource-Limits). +Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Increase-Azure-Resource-Limits). -Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#Azure-AD=Application). +Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#Create-Azure-AD-Application). -Gather information needed for the subscription form. See [Required Parameters](#Required-Parameters). +Gather information needed for the subscription form. See [Required Parameters](#Gather-Required-Parameters). -### Azure Resource Limits +### Increase Azure Resource Limits By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. @@ -39,11 +39,22 @@ Resource Manager, UKSOUTH, ESv3 Series / 50 ``` To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). +### Create Azure AD Application -### Required Parameters +To create an Azure Active Directory Application: +1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). +Take note of the **Application (client) ID**, you need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. +You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. + +2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. + +3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it for the final step. + +4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). + +### Gather Required Parameters -The following table describes the parameters that need to be entered in the EDB Cloud subscription form. -Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. +The following table describes the parameters that need to be entered in the EDB Cloud subscription form. Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. | Parameter | Description | @@ -57,44 +68,36 @@ Ensure that you know where to find the values of the parameters listed in the ta You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. -### Azure AD Application - -To create an Azure Active Directory Application: -1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -Take note of the **Application (client) ID**, you need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. -You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. - -2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. - -3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it for the final step. - -4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). -## Creating Your Subscription +## Create Your Subscription 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. 2. Find an offer from **EnterpriseDB Corporation** and select it. ![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) -3. select an available plan from the **Select Plan** drop-down list. -4. Select **Set up +subscribe**. +3. Select an available plan from the **Select Plan** drop-down list. +4. Select **Set up + subscribe**. ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") 1. In the **Project details** section, 1. Enter or create a **Resource Group** for your subscription. - 3. Select the SaaS subscription name. -1. Select **Review+ subscribe**. + 3. Enter the SaaS subscription name. +1. Select **Review + subscribe**. 1. Review the terms of use and select **Subscribe**. ![*Subscription progress](images/subscription-process.png "image_tooltip") 4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -You need access to the values of parameters described in [Required Parameters](#Required-Parameters) to fill out the form. +5. Fill in the form using the values of parameters described in [Required Parameters](#Required-Parameters). + 1. Azure AD App ID + 2. Azure AD App Secret + 3. Azure Subscription ID + 4. Your EDB Cloud Organization Name ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") -5. After filling in the form, select **Submit.** +5. Select **Submit.** If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. From 042dccc851a27354b3ee92a4179ae65703eb6eb1 Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Thu, 5 Aug 2021 21:16:25 -0400 Subject: [PATCH 158/317] Update 05_database_version_policy.mdx Added in the updated database version policy. Former-commit-id: b702cc2d7eaddcfdf08b6c76aaf8b281dd508870 --- .../overview/05_database_version_policy.mdx | 28 ++++++++++++++----- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx index 5cba5eb965c..6916d8e61c8 100644 --- a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -2,16 +2,30 @@ title: "Database Version Policy" --- -Versions Supported: +## Supported Postgres Types and Versions -- PostgreSQL versions supported: 11, 12, 13 -- EDB Postgres Advanced versions supported: 11, 12, 13 +| **Postgres Type** | **Major Version** | +| ----- | ------------------------- | +| PostgreSQL | 13 | +| PostgreSQL | 12 | +| PostgreSQL | 11 | +| EDB Postgres Advanced Server | 13 | +| EDB Postgres Advanced Server | 12 | +| EDB Postgres Advanced Server | 11 | -Maintenance and upgrades: -- EDB is committed to providing stable, up-to-date versions. We test, evaluate, and release new versions to clusters. +## Major Version Support -- Major Version Upgrades: Major versions are supported from the date they are made available until the version is retired from the PostgreSQL community (for PostgreSQL) or until EDB retires a major version of EDB Postgres Advanced Server. +PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. Please reference the [PostgreSQL versioning policy](https://www.postgresql.org/support/versioning/) for more details. + +EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB. Please reference the [EDB Product Compatibility page](https://www.enterprisedb.com/product-compatibility#epas) for more details. + + + +## Minor Version Support + +EDB performs periodic maintenance to ensure stability and security. EDB automatically performs minor version upgrades and patch updates as part of periodic maintenance. Customers are notified within the EDB Cloud console prior to maintenance occurring. Minor versions are not user configurable. + +EDB Cloud reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. -- Minor Version Upgrades & Maintenance: Minor version and patch updates are handled automatically and are not user configurable. From 5e9a398a9e9ec9c1a96dbb61c10342aede24e330 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 18:44:30 -0700 Subject: [PATCH 159/317] Update 02_users.mdx Former-commit-id: 1f48736300cb98ed21c1555545902d0c5581f7a6 --- .../organization_and_access/02_users.mdx | 20 +++---------------- 1 file changed, 3 insertions(+), 17 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 3d09829f5d0..9279f30ae4a 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -2,8 +2,7 @@ title: "Managing Users and Access" --- -!!! -Access to the Admin screen is required for these actions +!!! Access to the Admin screen is required for these actions # Roles @@ -60,16 +59,10 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** - -## Finding Users in the Role - -* To find users associated with the role, select **Users** tab. -* ?? - # Users ## Adding Users -New users can be added by an invite email from an _owner_. See **add link to Invite Users section in Getting Started**. New users will not be assigned a roles by default. After they log in the first time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. +New users can be added by an invite email from an _owner_. See **add link to Invite Users section in Getting Started**. New users will not be assigned a role by default. After they log in the first time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. ## Removing Users This functionality will be available beginning with the GA release. @@ -80,9 +73,7 @@ To view all users from your organization that have logged in at least once: 1. Navigate to Admin > Users. 2. View the list of users sorted by most recent log in. - -![Users](images/users.png "Users") - + ## Modifying Users ### Assigning Roles to Users @@ -92,8 +83,3 @@ To assign appropriate roles to users: 3. Select **Assign Roles**. 4. Select or deselect roles for the user. 5. Select **Submit**. - - -![Edit User Roles](images/edit-user.png "Edit User Roles") - - From f2c2f5b24bf8064fc50d7983f4320b5b5647eff2 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 18:58:12 -0700 Subject: [PATCH 160/317] Update 02_users.mdx Former-commit-id: d8fb313d6547e192a2a4dc4560588f4eb818b46b --- .../organization_and_access/02_users.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 9279f30ae4a..c4161874b7c 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -8,7 +8,7 @@ title: "Managing Users and Access" # Roles ## Default Roles -Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Roles are a convenient abstraction to manage permissions assigned to users. +Access to EDB Cloud is based on permissions. Roles are sets of permissions. Roles are used to manage permissions assigned to users. * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. @@ -16,7 +16,7 @@ Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. R ## Role Permissions -Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a categoroy of EDB Cloud functionality. +Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. The available _actions_ are: * _create _ @@ -35,10 +35,10 @@ The available _objects_ are: * _versions_ ## Adding Roles -This functionality will be available beginning with the GA release. +This functionality will be available in the future. ## Removing Roles -This functionality will be available beginning with the GA release. +This functionality will be available in the future. ## Editing Roles To edit roles: @@ -65,7 +65,7 @@ To change permissions associated with the role: New users can be added by an invite email from an _owner_. See **add link to Invite Users section in Getting Started**. New users will not be assigned a role by default. After they log in the first time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. ## Removing Users -This functionality will be available beginning with the GA release. +This functionality will be available beginning in the future. ## Viewing Users From 337cddd54e5804df8b20d95d28610bdd96c476ac Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 19:01:36 -0700 Subject: [PATCH 161/317] Update 02_users.mdx Former-commit-id: b11e650e2ba8ec09174dd8281d2c9ae2be7ae75c --- .../administering_cluster/organization_and_access/02_users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index c4161874b7c..2be76b65524 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -62,7 +62,7 @@ To change permissions associated with the role: # Users ## Adding Users -New users can be added by an invite email from an _owner_. See **add link to Invite Users section in Getting Started**. New users will not be assigned a role by default. After they log in the first time, an _owner_ will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. +An owner can invite new users by sharing the link to the EDB Cloud Portal and having users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. ## Removing Users This functionality will be available beginning in the future. From 1e252814da4ee76c106790ff83598d784556798b Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 19:04:58 -0700 Subject: [PATCH 162/317] Update 02_users.mdx Former-commit-id: e3ef02cc69ce5d0221075ff17baea530a5596e15 --- .../organization_and_access/02_users.mdx | 27 ++++++------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 2be76b65524..46f58b61ac9 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -4,7 +4,6 @@ title: "Managing Users and Access" !!! Access to the Admin screen is required for these actions - # Roles ## Default Roles @@ -34,11 +33,6 @@ The available _objects_ are: * _billing_ * _versions_ -## Adding Roles -This functionality will be available in the future. - -## Removing Roles -This functionality will be available in the future. ## Editing Roles To edit roles: @@ -64,22 +58,17 @@ To change permissions associated with the role: ## Adding Users An owner can invite new users by sharing the link to the EDB Cloud Portal and having users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. -## Removing Users -This functionality will be available beginning in the future. - -## Viewing Users - -To view all users from your organization that have logged in at least once: - -1. Navigate to Admin > Users. -2. View the list of users sorted by most recent log in. - -## Modifying Users - -### Assigning Roles to Users +## Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. 2. Select the edit icon for the user. 3. Select **Assign Roles**. 4. Select or deselect roles for the user. 5. Select **Submit**. + +## Viewing Users + +To view all users from your organization that have logged in at least once: + +1. Navigate to Admin > Users. +2. View the list of users sorted by most recent log in. From 2e95d1e6ecd9822b0c71b900ec1c9bad3ab8a524 Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Thu, 5 Aug 2021 22:24:10 -0400 Subject: [PATCH 163/317] Update 05_database_version_policy.mdx Former-commit-id: 9e4935c76aa3cf6089aaf54374a386e8fff9fccb --- .../edbcloud/beta/overview/05_database_version_policy.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx index 6916d8e61c8..96abcd1439f 100644 --- a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -17,7 +17,7 @@ title: "Database Version Policy" ## Major Version Support -PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. Please reference the [PostgreSQL versioning policy](https://www.postgresql.org/support/versioning/) for more details. +PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. Please reference the [EDB Product Compatibility page](https://www.enterprisedb.com/product-compatibility#pg) for more details. EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB. Please reference the [EDB Product Compatibility page](https://www.enterprisedb.com/product-compatibility#epas) for more details. @@ -27,5 +27,5 @@ EDB Postgres Advanced Server major versions are supported from the date they are EDB performs periodic maintenance to ensure stability and security. EDB automatically performs minor version upgrades and patch updates as part of periodic maintenance. Customers are notified within the EDB Cloud console prior to maintenance occurring. Minor versions are not user configurable. -EDB Cloud reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. +EDB reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. From 6c70f9a3719df7e3b4cda1e079f04e0719ed80a7 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Thu, 5 Aug 2021 22:26:59 -0400 Subject: [PATCH 164/317] doc(UPM-928): deleted roles Former-commit-id: fb396a8c39a567a0a0ff03511bd9d90d6e30daaf --- .../organization_and_access/02_users.mdx | 9 +-- .../organization_and_access/03_roles.mdx | 69 ------------------- 2 files changed, 5 insertions(+), 73 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 46f58b61ac9..a0d3f359bb8 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -2,10 +2,11 @@ title: "Managing Users and Access" --- -!!! Access to the Admin screen is required for these actions +!!! Note + Access to the Admin screen is required for these actions # Roles - + ## Default Roles Access to EDB Cloud is based on permissions. Roles are sets of permissions. Roles are used to manage permissions assigned to users. @@ -15,7 +16,7 @@ Access to EDB Cloud is based on permissions. Roles are sets of permissions. Role ## Role Permissions -Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. +Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. The available _actions_ are: * _create _ @@ -54,7 +55,7 @@ To change permissions associated with the role: 4. Press **Submit** # Users - + ## Adding Users An owner can invite new users by sharing the link to the EDB Cloud Portal and having users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx deleted file mode 100644 index 53e94e204d5..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/03_roles.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "Roles" ---- - -Access to EDB Cloud UI is based on permissions. Roles are sets of permissions. Role is a convenient abstraction to manage permissions assigned to users. - -* The predefined _owner_ role created during marketplace sign up has all permissions. -* EDB Cloud preview uses 3 template roles _reader_, _contributor_ and _owner_ -* These roles can be edited, including changing their name and changing set of associated permissions - -!!! Note - The general release version of EDB Cloud will allow adding new roles and deleting roles. - - -## Structure of Permissions - -In general a permission is a string made of prefix and suffix separated by colon. -Most permissions have format _action:object_. The available _actions_ are: - - -* _create _ -* _read _ -* _update _ -* _delete_ - -The prefix _object_ defines a part of EDB Cloud functionality. The available _objects_ are as follows: - - - -* _databases_ -* _backups_ -* _events_ -* _permissions_ -* _roles_ -* _users_ -* _billing_ -* _versions_ - -There are two special permissions for superset, where suffix defines superset role: - -* _superset:alpha_ -* _superset:admin_ - -!!! Note - Superset and Superset related permissions may not be available in the preview release. - -## Roles Edit Screen -To edit roles: -1. Navigate to Admin > Roles. -2. Select the edit icon for the role in the list. - -### Changing Role Name -To change **Name** and **Description** of the role: -1. Select **Settings** tab. -2. Edit **Name** and **Description** -3. Press **Save**. - -### Changing Permissions - -To change permissions associated with the role: -1. Select **Permissions** tab. -2. Press **Change Permissions** button in the top right. -3. Select the list of permissions you want to be associated with the role. -4. Press **Submit** - -### Finding Users in the Role - -* To find users associated with the role, select **Users** tab. -* To assign appropriate roles to a user, select the edit icon for the user. From b3d2c1832a95802d4ec1963eefc92fc30c218446 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Thu, 5 Aug 2021 19:55:03 -0700 Subject: [PATCH 165/317] Update 02_users.mdx Added #'s to reduce heading sizes to align with oher pages Former-commit-id: 0e4479bd5222cd6c02b50f9181b3c8c7755ae55c --- .../organization_and_access/02_users.mdx | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index a0d3f359bb8..bc74df4f7fc 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -5,16 +5,16 @@ title: "Managing Users and Access" !!! Note Access to the Admin screen is required for these actions -# Roles +### Roles -## Default Roles +#### Default Roles Access to EDB Cloud is based on permissions. Roles are sets of permissions. Roles are used to manage permissions assigned to users. * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions -## Role Permissions +#### Role Permissions Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. @@ -35,18 +35,18 @@ The available _objects_ are: * _versions_ -## Editing Roles +#### Editing Roles To edit roles: 1. Navigate to Admin > Roles. 2. Select the edit icon for the role in the list. -### Changing Role Name +##### Changing Role Name To change **Name** or **Description** of the role: 1. Select **Settings** tab. 2. Edit **Name** or **Description** 3. Press **Save**. -### Changing Role Permissions +##### Changing Role Permissions To change permissions associated with the role: 1. Select **Permissions** tab. @@ -54,12 +54,12 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** -# Users +### Users -## Adding Users +#### Adding Users An owner can invite new users by sharing the link to the EDB Cloud Portal and having users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. -## Assigning Roles to Users +#### Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. 2. Select the edit icon for the user. @@ -67,7 +67,7 @@ To assign appropriate roles to users: 4. Select or deselect roles for the user. 5. Select **Submit**. -## Viewing Users +#### Viewing Users To view all users from your organization that have logged in at least once: From 6b7a9de09f460c66332f8e381425c1bd195dc136 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 07:29:30 -0400 Subject: [PATCH 166/317] Update 02_connect_to_cluster.mdx Former-commit-id: 7fdd45052eb85d6c81604d6de839ffe90a1349ff --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 4cc7bc25134..8c8c741c8a1 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,5 +1,5 @@ --- -title: "Connect to Cluster" +title: "Connecting to Your Cluster" --- Explain where a customer can access connection details and connect to their cluster. From 516805a0e7626362f06f8c7e6a0451d4ae685020 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 07:32:44 -0400 Subject: [PATCH 167/317] Update 04_backup_and_restore.mdx Former-commit-id: 9d79d7ea7aebacea2710910f8d850d163ece20d6 --- .../docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx index a0700e06951..9945c510a95 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -1,5 +1,5 @@ --- -title: "Backup and Restore" +title: "Backuping Up and Restoring" --- ### Backups From 911b9b959920b4b05928b37164b009c6a56a36cc Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 08:57:56 -0400 Subject: [PATCH 168/317] Update 01_connect_cloud_account.mdx Former-commit-id: 45f2178c98bdc4489e8029ece76ca8c64e7ac678 --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index db078221c42..b5a4b8a40d7 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -4,7 +4,7 @@ title: "Connecting Your Cloud Account" This topic describes how to set up your EDB Cloud subscription on Azure Marketplace. Your Azure subscription is where EDB Cloud can create and manage PostgreSQL clusters. -## Before You Begin +## Before You Vreate Your Subscription Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Increase-Azure-Resource-Limits). From 95707e8757e6d72879c74ee4dcf89db413de3d8a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 09:10:06 -0400 Subject: [PATCH 169/317] fixed typo Former-commit-id: 5c0c889fb6d985f1d3fe50f0333d8de58fb145ed --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index b5a4b8a40d7..d5c416c350c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -4,7 +4,7 @@ title: "Connecting Your Cloud Account" This topic describes how to set up your EDB Cloud subscription on Azure Marketplace. Your Azure subscription is where EDB Cloud can create and manage PostgreSQL clusters. -## Before You Vreate Your Subscription +## Before You Create Your Subscription Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Increase-Azure-Resource-Limits). From 787fe466ae5d9630f71e388aaf20a70256359d0e Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 11:21:34 -0400 Subject: [PATCH 170/317] Update 01_connect_cloud_account.mdx Incorporated edits Kelly and I discussed Former-commit-id: e3ad582c75cc58054a0be08f91dac8c0ee20e1b3 --- .../01_connect_cloud_account.mdx | 40 +++++++------------ 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index d5c416c350c..7df31f3b66a 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -6,11 +6,9 @@ This topic describes how to set up your EDB Cloud subscription on Azure Marketpl ## Before You Create Your Subscription -Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#Increase-Azure-Resource-Limits). +Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#increase-azure-resource-limits). -Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#Create-Azure-AD-Application). - -Gather information needed for the subscription form. See [Required Parameters](#Gather-Required-Parameters). +Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#create-azure-ad-application). ### Increase Azure Resource Limits @@ -43,27 +41,15 @@ To make requests to increase Azure Networking Limits follow [these instructions] To create an Azure Active Directory Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -Take note of the **Application (client) ID**, you need it at the final step. Copy **Display name** of Azure AD application for the use in the next step. -You will need to enter **Display name** _as is_ in the **Select** field, at the bottom of [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) the panel. +Take note of the **Application (client) ID**, you need it to configure your cloud account. Also take note of the **Display name** of the Azure AD application. +You need to enter the **Display name** _as is_ in the next step of this procedure. -2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. +2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. -3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret). After you created the secret, copy the value of Azure AD App Secret, you will need it for the final step. +3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) Take note of the Azure AD App Secret, you need it to configure your cloud account. 4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). -### Gather Required Parameters - -The following table describes the parameters that need to be entered in the EDB Cloud subscription form. Ensure that you know where to find the values of the parameters listed in the table before following the subscription procedure. - - -| Parameter | Description | -| ------------------------------------- | ---------------------------------------------------------------------------- | -| **Azure AD App ID** | Application (client) ID | -| **Azure AD App Secret** | Value of application (client) secret | -| **Azure Subscription ID** | Azure subscription ID from the overview page of a subscription. | -| **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization | - !!! Note You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. @@ -90,11 +76,15 @@ The following table describes the parameters that need to be entered in the EDB ![*Subscription progress](images/subscription-process.png "image_tooltip") 4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -5. Fill in the form using the values of parameters described in [Required Parameters](#Required-Parameters). - 1. Azure AD App ID - 2. Azure AD App Secret - 3. Azure Subscription ID - 4. Your EDB Cloud Organization Name +5. Fill in the following parameters in the form: form using the values of parameters you noted when [creating your Azure AD Application](#create-azure-ad-application) and your EDB Cloud Origanization Name found on the overview page of a subscription. + + + | Parameter | Description | + | ------------------------------------- | ---------------------------------------------------------------------------- | + | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure Subscription ID** | Azure subscription ID available from the Subscriptions page of your Azure account. | + | **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization. | ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") From 2a70ec0f64bd2e442a4c7296c6478c433d81354d Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 08:31:42 -0700 Subject: [PATCH 171/317] Update 01_connect_cloud_account.mdx Former-commit-id: 90a5a7a6dfb522aeb98319137a87c1f1b7a58123 --- .../beta/getting_started/01_connect_cloud_account.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 7df31f3b66a..08321cf678c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -10,7 +10,7 @@ Check that your subscription allows for a sufficient number of vCPU cores and a Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#create-azure-ad-application). -### Increase Azure Resource Limits +### Check Azure Resource Limits By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. @@ -41,8 +41,7 @@ To make requests to increase Azure Networking Limits follow [these instructions] To create an Azure Active Directory Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -Take note of the **Application (client) ID**, you need it to configure your cloud account. Also take note of the **Display name** of the Azure AD application. -You need to enter the **Display name** _as is_ in the next step of this procedure. +Take note of the **Application (client) ID**, you need it to configure your cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. 2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. From 0afb6cadf249811e465b97a60c1b5d87fc38cd93 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 11:43:49 -0400 Subject: [PATCH 172/317] Update 01_connect_cloud_account.mdx Former-commit-id: 7967fc9216f12eef0888b793391c87dab5d22abf --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 08321cf678c..1f9325b7924 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -75,7 +75,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou ![*Subscription progress](images/subscription-process.png "image_tooltip") 4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -5. Fill in the following parameters in the form: form using the values of parameters you noted when [creating your Azure AD Application](#create-azure-ad-application) and your EDB Cloud Origanization Name found on the overview page of a subscription. +5. Fill in the following parameters in the form: | Parameter | Description | From 723bbe37d2e165633a8566ae3ec3e335ab4d6e6f Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 11:48:38 -0400 Subject: [PATCH 173/317] Update 01_connect_cloud_account.mdx Addressed Kelly's comments Former-commit-id: 9c1344b82e36e0719470de50e586c3d0ea569d0b --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 1f9325b7924..4a50c3f5aa5 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -82,7 +82,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou | ------------------------------------- | ---------------------------------------------------------------------------- | | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure Subscription ID** | Azure subscription ID available from the Subscriptions page of your Azure account. | + | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | | **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization. | ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") From 5f3f817e88bf4c79f9e889a6ee3c1a54d21e4f34 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 12:23:02 -0400 Subject: [PATCH 174/317] Update 01_connect_cloud_account.mdx Added resource group link Former-commit-id: c0603766c62fd0621d1498873f81540f9fe5af33 --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 4a50c3f5aa5..17bea10587c 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -66,8 +66,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") -1. In the **Project details** section, - 1. Enter or create a **Resource Group** for your subscription. +1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. 3. Enter the SaaS subscription name. 1. Select **Review + subscribe**. 1. Review the terms of use and select **Subscribe**. From 3f266b9aa23e5677df66d5640811ab89c0c40c5f Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 09:29:46 -0700 Subject: [PATCH 175/317] Update 04_backup_and_restore.mdx Former-commit-id: e3cb8e2a56d77f6b5dc8cb348b50604ba3718007 --- .../docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx index 9945c510a95..ed28d1ba6e1 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/04_backup_and_restore.mdx @@ -1,5 +1,5 @@ --- -title: "Backuping Up and Restoring" +title: "Backing Up and Restoring" --- ### Backups From 3fb557f1f946fdab3dc6bee7535df2ec11460723 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 12:30:37 -0400 Subject: [PATCH 176/317] Update 02_users.mdx Former-commit-id: a98893427e00b64a29bd5c140aed55bd0cc47d17 --- .../organization_and_access/02_users.mdx | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index bc74df4f7fc..839ac64c722 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -3,16 +3,14 @@ title: "Managing Users and Access" --- !!! Note - Access to the Admin screen is required for these actions + Access to the Admin screen is required to manage users and access. ### Roles - +Access to EDB Cloud is controlled by permissions. Roles are sets of permissions. You use roles to manage permissions assigned to users. #### Default Roles -Access to EDB Cloud is based on permissions. Roles are sets of permissions. Roles are used to manage permissions assigned to users. - * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. -* These roles can be edited by changing their name, description, or permissions +* These roles can be edited by changing their name, description, or permissions. #### Role Permissions @@ -41,23 +39,25 @@ To edit roles: 2. Select the edit icon for the role in the list. ##### Changing Role Name -To change **Name** or **Description** of the role: -1. Select **Settings** tab. -2. Edit **Name** or **Description** +To change the name or dscription of the role: +1. Select the **Settings** tab. +2. Edit **Name** or **Description**. 3. Press **Save**. ##### Changing Role Permissions To change permissions associated with the role: 1. Select **Permissions** tab. -2. Press **Change Permissions** button in the top right. +2. Select the **Change Permissions** button on the top right. 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** ### Users -#### Adding Users -An owner can invite new users by sharing the link to the EDB Cloud Portal and having users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to EDB Cloud. +New users gain access to the EDB CLoud through an invitation from an owner. The owner shares the link to the EDB Cloud Portal and users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to access the EDB Cloud. + +On the Users page you can view users and assign roles to users. + #### Assigning Roles to Users To assign appropriate roles to users: From 2829eded8ea062be642c3a5a1ae9ddf724125c57 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 12:40:06 -0400 Subject: [PATCH 177/317] Fixed SaaS subscription name step Former-commit-id: 1658e919f39c0e23e11019e179fea00218de1489 --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 17bea10587c..dddbf316f84 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -67,7 +67,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") 1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. - 3. Enter the SaaS subscription name. +3. In the **SaaS details** section, enter the SaaS subscription name. 1. Select **Review + subscribe**. 1. Review the terms of use and select **Subscribe**. From 5f57eed5ffcd13e602f7425cfe85160e7d70a24a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 12:50:03 -0400 Subject: [PATCH 178/317] Incorporating comments from Kelly Former-commit-id: be9e1c7c3d193f7fef14429ec9701ad9933ed0f7 --- .../organization_and_access/02_users.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 839ac64c722..a3d768cc43e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -3,7 +3,7 @@ title: "Managing Users and Access" --- !!! Note - Access to the Admin screen is required to manage users and access. + Access to the Admin screen is required to manage users and permissions. ### Roles Access to EDB Cloud is controlled by permissions. Roles are sets of permissions. You use roles to manage permissions assigned to users. @@ -54,7 +54,7 @@ To change permissions associated with the role: ### Users -New users gain access to the EDB CLoud through an invitation from an owner. The owner shares the link to the EDB Cloud Portal and users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to access the EDB Cloud. +New users gain access to the EDB Cloud through an invitation from an owner. The owner shares a link to the EDB Cloud Portal and users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to access the EDB Cloud. On the Users page you can view users and assign roles to users. From 59cf27a0d969322682cd5aa43af9687813e62d06 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 12:52:57 -0400 Subject: [PATCH 179/317] fixed list formatting fixed list formatting in connect cloud topic Former-commit-id: 49ae3c21c637afe407fa9de5bc60c033bf581939 --- .../getting_started/01_connect_cloud_account.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index dddbf316f84..18bfa6457aa 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -66,15 +66,15 @@ Take note of the **Application (client) ID**, you need it to configure your clou ![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") -1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. -3. In the **SaaS details** section, enter the SaaS subscription name. -1. Select **Review + subscribe**. -1. Review the terms of use and select **Subscribe**. +5. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. +6. In the **SaaS details** section, enter the SaaS subscription name. +7. Select **Review + subscribe**. +8. Review the terms of use and select **Subscribe**. ![*Subscription progress](images/subscription-process.png "image_tooltip") -4. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -5. Fill in the following parameters in the form: +9. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. +10. Fill in the following parameters in the form: | Parameter | Description | @@ -86,6 +86,6 @@ Take note of the **Application (client) ID**, you need it to configure your clou ![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") -5. Select **Submit.** +11. Select **Submit.** If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. From 2061c33404aba802ff65422e270785bf5073bc0f Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 13:09:45 -0400 Subject: [PATCH 180/317] Changed title Changed title on original users topic Former-commit-id: a02573d4f9a8ddb468668f41de164e5395829075 --- .../administering_cluster/organization_and_access/02_users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index a3d768cc43e..0db6a0f94d3 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -1,5 +1,5 @@ --- -title: "Managing Users and Access" +title: "Managing User Access" --- !!! Note From 7e56ca7c83b69f8806f41b97938cfe7d5a8cf613 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 13:47:39 -0400 Subject: [PATCH 181/317] incorporated Aislinn's comment Former-commit-id: 607963fa1d61c5a94f171c45ad0ee8128da923e7 --- .../01_connect_cloud_account.mdx | 30 +++++++------------ 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 18bfa6457aa..8b5c9c8d8ce 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -4,7 +4,9 @@ title: "Connecting Your Cloud Account" This topic describes how to set up your EDB Cloud subscription on Azure Marketplace. Your Azure subscription is where EDB Cloud can create and manage PostgreSQL clusters. -## Before You Create Your Subscription +## Before You Create Your EDB Cloud Subscription + +Ensure you have an active Microsoft Azure subscription. Refer to these [instructions](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription) if you need to create a Azure subscription. Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#increase-azure-resource-limits). @@ -47,44 +49,32 @@ Take note of the **Application (client) ID**, you need it to configure your clou 3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) Take note of the Azure AD App Secret, you need it to configure your cloud account. -4. If you can’t give away your existing Azure subscription, [create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). !!! Note You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. -## Create Your Subscription +## Create Your EDB Cloud Subscription 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. 2. Find an offer from **EnterpriseDB Corporation** and select it. - -![*EDB PostgresQL-as-service (preview)*](images/marketplace-preview.png) - 3. Select an available plan from the **Select Plan** drop-down list. 4. Select **Set up + subscribe**. - -![*Subscribe to EDB PostgresQL-as-service*](images/subscribe-to-dbaas.png "image_tooltip") - 5. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. 6. In the **SaaS details** section, enter the SaaS subscription name. 7. Select **Review + subscribe**. 8. Review the terms of use and select **Subscribe**. - -![*Subscription progress](images/subscription-process.png "image_tooltip") - 9. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. 10. Fill in the following parameters in the form: - | Parameter | Description | - | ------------------------------------- | ---------------------------------------------------------------------------- | - | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | - | **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization. | - -![*EDB Cloud Account Form*](images/edbcloud.png "image_tooltip") + | Parameter | Description | + | ------------------------------------- | ---------------------------------------------------------------------------- | + | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | + | **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization. | 11. Select **Submit.** From 70c246c279c0d0352324af5ac26fc42ade8a3a50 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 13:56:44 -0400 Subject: [PATCH 182/317] more edits Former-commit-id: 63a745121bcd4743306849f065c407bba68ce94c --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 8b5c9c8d8ce..880cbf3c4b1 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -74,7 +74,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | - | **Your EDB Cloud Organization Name** | Name you assigned to your EDB Cloud Organization. | + | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see step 6). | 11. Select **Submit.** From fbf6c5537886f2be4411b44dc47ed435bfa6aa62 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:32:08 -0400 Subject: [PATCH 183/317] Update 02_users.mdx Added orgs to Managing User Access Former-commit-id: 271722ab7ff3d1cf1408beb9b71b26001abaf984 --- .../organization_and_access/02_users.mdx | 46 ++++++++++++++----- 1 file changed, 34 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx index 0db6a0f94d3..823e921b750 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx @@ -2,17 +2,26 @@ title: "Managing User Access" --- -!!! Note - Access to the Admin screen is required to manage users and permissions. +Role based access controls are achieved through a combination of organizations, roles, and users. -### Roles -Access to EDB Cloud is controlled by permissions. Roles are sets of permissions. You use roles to manage permissions assigned to users. -#### Default Roles +## Organizations + +Each subscribed customer has a unique *organization*. Each organization’s database clusters are installed and managed in their own cloud account ensuring complete segregation of customer data. + +Each EDB Cloud organization belongs to an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After you link your Azure AD during subscription, users that belong to that AD can login with minimum access privileges. + +EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. A user with the **owner** role may also define their own sets of roles which can be applied across the organization. + + +## Roles +Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. + +### Default Roles * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions. -#### Role Permissions +### Role Permissions Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. @@ -33,18 +42,18 @@ The available _objects_ are: * _versions_ -#### Editing Roles +### Editing Roles To edit roles: 1. Navigate to Admin > Roles. 2. Select the edit icon for the role in the list. -##### Changing Role Name +#### Changing Role Name To change the name or dscription of the role: 1. Select the **Settings** tab. 2. Edit **Name** or **Description**. 3. Press **Save**. -##### Changing Role Permissions +#### Changing Role Permissions To change permissions associated with the role: 1. Select **Permissions** tab. @@ -52,14 +61,14 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** -### Users +## Users New users gain access to the EDB Cloud through an invitation from an owner. The owner shares a link to the EDB Cloud Portal and users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to access the EDB Cloud. On the Users page you can view users and assign roles to users. -#### Assigning Roles to Users +### Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. 2. Select the edit icon for the user. @@ -67,9 +76,22 @@ To assign appropriate roles to users: 4. Select or deselect roles for the user. 5. Select **Submit**. -#### Viewing Users +### Viewing Users To view all users from your organization that have logged in at least once: 1. Navigate to Admin > Users. 2. View the list of users sorted by most recent log in. + +## Example Scenario +1. AcmeBank owns a subcription to Azure and the acmebank.com Azure AD. +1. AcmeBank purchases a subscription to the EDB Cloud and assigns the name acmebank-com for their organization. +1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. +1. Users Tom and Jerry have different roles with different permissions. +1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced Server clusters. +2. Tom, a user with the **reader** role, can read data from PostgreSQL and EDB Postgres Advanced Server databases. +3. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. + +The following diagram illustrates a mapping between objects that exist within the EDB Cloud and Azure cloud for AcmeBank example scenario. + +![*EDB Cloud and Azure*](images/org-map.png ) From 88ac145d449a1c80dcaddf3f7c685cf06af3306e Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:55:33 -0400 Subject: [PATCH 184/317] fix spacing Former-commit-id: 0949854dbf74d39676bc431e6f5f8331eb6289d7 --- .../beta/getting_started/03_create_cluster.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx index 7a9f7c06728..6eb8fffb215 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx @@ -2,11 +2,13 @@ title: "Creating a Cluster" --- To create a cluster: + 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal. -2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. -3. Enter the name for your cluster in the **Cluster Name** field. -4. Enter a password for your cluster in the **Password** field. This will be the password for the superuser 'edb_admin'. -5. In the **Database Type** section, + +3. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. +4. Enter the name for your cluster in the **Cluster Name** field. +5. Enter a password for your cluster in the **Password** field. This will be the password for the superuser 'edb_admin'. +6. In the **Database Type** section, 1. Select the type of Postgres you want to use in the **Postgres Type** field: - *PostgreSQL* is an open-source object-relational database management system. - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. From 1292e849bd1854419befe99a273722cae1175bdf Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 6 Aug 2021 15:19:14 -0400 Subject: [PATCH 185/317] doc(UPM-926): as Kelly moved organization to users, we move users one level up and delete organization file Former-commit-id: 9d39365add333bac272d6cb8ef2d7b654ab9b441 --- .../02_users.mdx => 01_user_access.mdx} | 0 .../images/map1.puml | 0 .../images/org-map.png | 0 .../beta/administering_cluster/index.mdx | 2 +- .../01_organizations.mdx | 25 ------------------- .../images/edit-user.png | 3 --- .../organization_and_access/images/orgmap.png | 3 --- .../organization_and_access/images/users.png | 3 --- .../organization_and_access/index.mdx | 5 ---- 9 files changed, 1 insertion(+), 40 deletions(-) rename product_docs/docs/edbcloud/beta/administering_cluster/{organization_and_access/02_users.mdx => 01_user_access.mdx} (100%) rename product_docs/docs/edbcloud/beta/administering_cluster/{organization_and_access => }/images/map1.puml (100%) rename product_docs/docs/edbcloud/beta/administering_cluster/{organization_and_access => }/images/org-map.png (100%) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/02_users.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml b/product_docs/docs/edbcloud/beta/administering_cluster/images/map1.puml similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/map1.puml rename to product_docs/docs/edbcloud/beta/administering_cluster/images/map1.puml diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png b/product_docs/docs/edbcloud/beta/administering_cluster/images/org-map.png similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/org-map.png rename to product_docs/docs/edbcloud/beta/administering_cluster/images/org-map.png diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx index be0fc262c78..6c600aef674 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx @@ -2,4 +2,4 @@ title: "Administering your cluster" --- -Document content + diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx deleted file mode 100644 index 24deddcc721..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/01_organizations.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Organizations" ---- - - -Each subscribed customer has a unique *organization* object in the cloud. An organization is synonymous with a customer. Organizations are completely isolated from each other. Each organization’s database clusters are installed and managed in their own cloud environment ensuring complete segregation of customer data. - -EDB Cloud Organization belongs to Azure AD tenant. Azure Active Directory (AD) establishes the identity of users that belong to an organization. During subscription, you link your Azure AD and users that belong to that AD can login with minimum access privileges. - -EDB Cloud supports role based access control policies. A user with the **owner** role may define their own sets of roles which can be applied across the organization. -!!! Note - This feature may not be available in the preview release. -A user with the **owner** role may assign roles to other users in the same organization. - -Example scenario: -1. AcmeBank owns a subcription to Azure and the acmebank.com Azure AD. -1. AcmeBank purchases a subscription to the EDB cloud and assigns the name acmebank-com for their organization. -1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. -1. Users Tom and Jerry have different roles with different priviledges. -1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced (EPAS) clusters. -2. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. - -The following diagram illustrates a mapping between objects that exist within the EDB cloud and Azure cloud for AcmeBank example scenario. - -![*EDB Cloud and Azure*](images/org-map.png ) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png deleted file mode 100644 index 0158b184e12..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/edit-user.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:549cd6499692f3f80b26ed52ffed6f9007d499bd3441f7f4ed9f02d565cfa1d5 -size 70814 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png deleted file mode 100644 index bab6d813386..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/orgmap.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:389ca801162844471e3f50c4720c7984e550fb22b952d51cf0c305f90a0458b1 -size 47838 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png deleted file mode 100644 index fff36422bcf..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/images/users.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:f7bf715c2f35f52511dac5b1736d7850fb83763a08d2989f9efd19e78075db08 -size 55153 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx deleted file mode 100644 index b67ff359ce9..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/organization_and_access/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Organization and Access" ---- - -Document content UPM-924 From 530e8dcd1689961e7e6b2382a8ddcf74626c7917 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 6 Aug 2021 15:46:19 -0400 Subject: [PATCH 186/317] deleted refernce folder as we decided postpone release of swagger docs Former-commit-id: 13cde04fede3e596670c76ac8056d08b689a9298 --- product_docs/docs/edbcloud/beta/index.mdx | 1 - product_docs/docs/edbcloud/beta/reference/index.mdx | 5 ----- 2 files changed, 6 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/reference/index.mdx diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index 7393ac64d35..d3584748c26 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -9,6 +9,5 @@ navigation: - using_cluster - administering_cluster - pricing_and_billing - - reference - release_notes --- diff --git a/product_docs/docs/edbcloud/beta/reference/index.mdx b/product_docs/docs/edbcloud/beta/reference/index.mdx deleted file mode 100644 index d20236bea27..00000000000 --- a/product_docs/docs/edbcloud/beta/reference/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Reference" ---- - -Document content From b92f3eb1c4426351f607a4051534ead4fbd45757 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 6 Aug 2021 15:48:42 -0400 Subject: [PATCH 187/317] cleanup Former-commit-id: 0e3a9e67df686b96332eda662db6f2e24b3427e6 --- product_docs/docs/edbcloud/beta/using_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx index 3a287220539..dd6729da927 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx @@ -2,4 +2,4 @@ title: "Using your cluster" --- -Document content + From 3a0206128b41979ed7937753d000e06c83783dad Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 6 Aug 2021 16:06:54 -0400 Subject: [PATCH 188/317] docs(UPM-922): first draft monitoring and logging Former-commit-id: f95abccd741c6824b9669fe16b3204a45ded9980 --- .../05_monitoring_and_logging.mdx | 33 +++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index fef028cd55b..11c589ee234 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -2,6 +2,35 @@ title: "Monitoring and Logging" --- -All metrics and logs are sent to Azure Monitor. Explain where a customer can navigate to view metrics and logs. -- Explain what metrics and logs are sent +- Azure dashboards??? +- link to the Azure docs for the logging service + +## Accessing Logs and Metrics + +When EDB Cloud deploys workloads on Azure, the workloads applications logs are forwarded to Azure Log Workspace resource. + +## Query Log Workspace Tables + +To query log workspace content, go to the Logs menu then you will see 3 tables Groups + + - **ContainerInsights :** Azure native collected Kubernetes logs and metrics, (contains duplicates of some Kube state metrics in Kube* tables) + +- **LogManagement :** Azure native collected logs and metrics around azure resources + +- **Custom Logs :** Tables created by the fluentbit containing : + + - our components forwarded logs + + - others specifics Azure resources forwarded logs + +### EDB Container logs +To query the EDB components logs just write this kind of KQL Query from the desired table. + +For example, we obtain here the K8S namespace upm-api-provisioning container logs from table MicroservicesLogs_CL. + +### Prometheus metrics + +To query the Prometheus collected metrics (from omsagent) just write this kind of KQL Query from the InsightsMetrics table in the Namespace field called prometheus. + + From 0a478a5de2f3d4cac91c8d392a7a1984acb0c7f4 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 16:17:05 -0400 Subject: [PATCH 189/317] Formatting fix Former-commit-id: ced71e03d558c3662c65572cb2fc3dddce8bf493 --- .../beta/getting_started/01_connect_cloud_account.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 880cbf3c4b1..12bb1bdb950 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -31,12 +31,12 @@ If your role is Owner, Contributor, or [Support Request Contributor](https://doc Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: -``` +~~~ Request Summary / New Limit: Resource Manager, EASTUS, ESv3 Series / 50 Resource Manager, UKSOUTH, ESv3 Series / 50 -``` +~~~ To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). ### Create Azure AD Application From 55f3773345df108c82d35a5ddaa5f76f18906649 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:01:21 -0700 Subject: [PATCH 190/317] Update index.mdx Former-commit-id: aa6ca9465c2cdddcbb50ebf716565b9ba3a815e1 --- product_docs/docs/edbcloud/beta/administering_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx index 6c600aef674..bbeb3dfdc5f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx @@ -1,5 +1,5 @@ --- -title: "Administering your cluster" +title: "Administering Your Account" --- From 4f4e3c61ee76c064887ffd60d5275ffbde3de59b Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:02:47 -0700 Subject: [PATCH 191/317] Update index.mdx Former-commit-id: 94c859f77fd7c30ce1cb4cf0a34938f8cc71dd20 --- product_docs/docs/edbcloud/beta/using_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx index dd6729da927..bd2adda4a72 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx @@ -1,5 +1,5 @@ --- -title: "Using your cluster" +title: "Using Your Cluster" --- From 68da58ab1ae4b68fc275d54fd052728a41201dc2 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:08:16 -0700 Subject: [PATCH 192/317] Update 01_user_access.mdx Add note about needing to log out and back in to see role changes Former-commit-id: 8476c66243c679c0f5d8508fbfdaa476cbd57e11 --- .../edbcloud/beta/administering_cluster/01_user_access.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 823e921b750..d2e1e1ba1d3 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -17,6 +17,7 @@ EDB Cloud supports role based access control policies. A user with the **owner** Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. ### Default Roles + * The predefined _owner_ role created during marketplace sign up has all permissions. * Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. * These roles can be edited by changing their name, description, or permissions. @@ -43,11 +44,13 @@ The available _objects_ are: ### Editing Roles + To edit roles: 1. Navigate to Admin > Roles. 2. Select the edit icon for the role in the list. #### Changing Role Name + To change the name or dscription of the role: 1. Select the **Settings** tab. 2. Edit **Name** or **Description**. @@ -76,6 +79,9 @@ To assign appropriate roles to users: 4. Select or deselect roles for the user. 5. Select **Submit**. +!!! Note + For a user's role assignment to take effect, the user should sign out from EDB Cloud and sign in again. + ### Viewing Users To view all users from your organization that have logged in at least once: From e58aa14bc9a68a93a8a0824787e44a15ea639e31 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 14:16:53 -0700 Subject: [PATCH 193/317] Update 01_user_access.mdx Former-commit-id: 197958624522c42572a6528f513939f7a634a130 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index d2e1e1ba1d3..c5d7b1ffe01 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -2,7 +2,7 @@ title: "Managing User Access" --- -Role based access controls are achieved through a combination of organizations, roles, and users. +EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud Role Based Access Control to grant users access to different parts of the application. ## Organizations From 5895a63582d42940af46bd2d918453d34c15600e Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 17:27:32 -0400 Subject: [PATCH 194/317] Added headers to last procedure Former-commit-id: 974501f168e41d8154f6b0d9f167fd47caab15a4 --- .../01_connect_cloud_account.mdx | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 880cbf3c4b1..868008e3b1b 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -57,16 +57,24 @@ Take note of the **Application (client) ID**, you need it to configure your clou ## Create Your EDB Cloud Subscription +To create your subscription: + +### 1. Select the EDB Cloud offer in the Azure portal. + 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. 2. Find an offer from **EnterpriseDB Corporation** and select it. 3. Select an available plan from the **Select Plan** drop-down list. 4. Select **Set up + subscribe**. -5. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. -6. In the **SaaS details** section, enter the SaaS subscription name. -7. Select **Review + subscribe**. -8. Review the terms of use and select **Subscribe**. -9. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -10. Fill in the following parameters in the form: + +### 2. Fill out the details for your plan. +1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. +7. In the **SaaS details** section, enter the SaaS subscription name. +8. Select **Review + subscribe**. +9. Review the terms of use and select **Subscribe**. + +### 3. Configure your account. +1. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. +12. Fill in the following parameters in the form: | Parameter | Description | @@ -74,7 +82,7 @@ Take note of the **Application (client) ID**, you need it to configure your clou | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | - | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see step 6). | + | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [step 2. Fill out the details for your plan.](2-fill-out-the-details-for-your-plan) | 11. Select **Submit.** From 03b0b062673e0e1c07d1454602daf79b8665d62a Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 15:03:48 -0700 Subject: [PATCH 195/317] Update 01_connect_cloud_account.mdx Former-commit-id: 89352b8b3c0d5d3946cd2e7a8e879b165b1e9845 --- .../01_connect_cloud_account.mdx | 42 +++++++++++-------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 868008e3b1b..e9f9af05816 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -2,15 +2,15 @@ title: "Connecting Your Cloud Account" --- -This topic describes how to set up your EDB Cloud subscription on Azure Marketplace. Your Azure subscription is where EDB Cloud can create and manage PostgreSQL clusters. +This topic describes how to set up your EDB Cloud account on Azure Marketplace. Your Azure subscription for EDB Cloud is where you can create and manage Postgres clusters. -## Before You Create Your EDB Cloud Subscription +## Before You Connect Your Cloud Account Ensure you have an active Microsoft Azure subscription. Refer to these [instructions](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription) if you need to create a Azure subscription. Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#increase-azure-resource-limits). -Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure AD. See [Azure AD Application](#create-azure-ad-application). +Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure Active Directory (AD). See [Azure AD Application](#create-azure-ad-application). ### Check Azure Resource Limits @@ -39,11 +39,12 @@ Resource Manager, UKSOUTH, ESv3 Series / 50 ``` To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). -### Create Azure AD Application +### Create Azure Active Directory Application + +To create an Azure Active Directory (AD) Application: -To create an Azure Active Directory Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). -Take note of the **Application (client) ID**, you need it to configure your cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. +Take note of the **Application (client) ID**, you need it to configure your EDB cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. 2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. @@ -51,39 +52,44 @@ Take note of the **Application (client) ID**, you need it to configure your clou !!! Note - You have to ensure the Azure AD App ID and Azure subscription ID are all in the same Azure AD tenant. + You have to ensure the Azure AD App ID and Azure Subscription ID are for the same Azure AD tenant. -## Create Your EDB Cloud Subscription +## Connect Your Cloud Account -To create your subscription: +To connect your cloud account with your Azure subscription: -### 1. Select the EDB Cloud offer in the Azure portal. +#### 1. Select the EDB offer in the Azure portal. 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. 2. Find an offer from **EnterpriseDB Corporation** and select it. 3. Select an available plan from the **Select Plan** drop-down list. 4. Select **Set up + subscribe**. -### 2. Fill out the details for your plan. +#### 2. Fill out the details for your plan. 1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. -7. In the **SaaS details** section, enter the SaaS subscription name. -8. Select **Review + subscribe**. -9. Review the terms of use and select **Subscribe**. +2. In the **SaaS details** section, enter the SaaS subscription name. +3. Select **Review + subscribe**. + +#### 3. Accept term of use. +1. Review the terms of use provided by EDB. +2. Select **Subscribe**. -### 3. Configure your account. +#### 4. Configure your account. 1. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. -12. Fill in the following parameters in the form: +2. Fill in the following parameters in the form: | Parameter | Description | | ------------------------------------- | ---------------------------------------------------------------------------- | | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure AD App Secret** | Value of application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure AD App Secret** | Application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | - | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [step 2. Fill out the details for your plan.](2-fill-out-the-details-for-your-plan) | + | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [step 2. Fill out the details for your plan.](2-fill-out-the-details-for-your-plan)) | 11. Select **Submit.** + +## What's Next If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. From 7c27b188a317b1e05fed43fe587b02af6358546b Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 15:46:48 -0700 Subject: [PATCH 196/317] Update 01_connect_cloud_account.mdx Former-commit-id: 47d06965eb3065ffb156ba34b1bac9245937679d --- .../beta/getting_started/01_connect_cloud_account.mdx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 83e732e5013..ed44668a5cd 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -92,4 +92,13 @@ To connect your cloud account with your Azure subscription: ## What's Next -If you filled in your parameters correctly, you can login to your EDB Cloud account using your Azure AD identity. +### Login + +You can now login to your EDB Cloud account using your Azure AD identity if you filled in your parameters correctly. + +### Invite Users + +You can invite new users by sharing the link to the EDB Cloud Portal and having them login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, you will see them in the User list and be able to [assign them a role](Managing_User_Access#Assinging_Roles_to_Users) with permissions to EDB Cloud. + +!!! Note + Azure AD email domain will likely be different than the email domain regularly used by your organization. From 5623685f75d67ab22a830a513c3cd8663011af28 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 15:54:24 -0700 Subject: [PATCH 197/317] Update 01_user_access.mdx Former-commit-id: bf705f7e689d83358f508fc01b1d4d06dd3afd32 --- .../edbcloud/beta/administering_cluster/01_user_access.mdx | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 823e921b750..e640daa0d59 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -63,10 +63,7 @@ To change permissions associated with the role: ## Users -New users gain access to the EDB Cloud through an invitation from an owner. The owner shares a link to the EDB Cloud Portal and users login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, an owner will see them in the User list and they will be able to assign them a role with permission to access the EDB Cloud. - -On the Users page you can view users and assign roles to users. - +When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory (AD). Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using special emails designated by your organization to sign in using Azure AD. New users signed in to EDB Cloud have a minimum set of permissions until you assign them a role. ### Assigning Roles to Users To assign appropriate roles to users: From 71a371099588f883f16348d45bd00b27f35b26a9 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 18:56:39 -0400 Subject: [PATCH 198/317] Update product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx Former-commit-id: 7ef2ecead3295caa3f36ff70ffe06fc7fce34c6a --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index ed44668a5cd..19993ca200f 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -94,7 +94,7 @@ To connect your cloud account with your Azure subscription: ### Login -You can now login to your EDB Cloud account using your Azure AD identity if you filled in your parameters correctly. +You can now log in to your EDB Cloud account using your Azure AD identity if you filled in your parameters correctly. ### Invite Users From 08b9c5bc2efd690809979497cfe68bad3e14f5a7 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 18:59:09 -0400 Subject: [PATCH 199/317] few minor edits Former-commit-id: 0cae372e499840d6760e668a60deafbca77ae4bb --- .../edbcloud/beta/getting_started/01_connect_cloud_account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 19993ca200f..8deb3d43bee 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -98,7 +98,7 @@ You can now log in to your EDB Cloud account using your Azure AD identity if you ### Invite Users -You can invite new users by sharing the link to the EDB Cloud Portal and having them login with their Microsoft Azure Active Directory account. New users will not be assigned any roles by default. After they log in the first time, you will see them in the User list and be able to [assign them a role](Managing_User_Access#Assinging_Roles_to_Users) with permissions to EDB Cloud. +You can invite new users by sharing the link to the EDB Cloud Portal and having them log in with their Microsoft Azure Active Directory account. New users are not assigned any roles by default. After they log in the first time, you see them in the User list and are able to [assign them a role](Managing_User_Access#Assinging_Roles_to_Users) with permissions to EDB Cloud. !!! Note Azure AD email domain will likely be different than the email domain regularly used by your organization. From f2e82ab9b88d208eb26dc455e988af23d7a59f88 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Fri, 6 Aug 2021 15:59:13 -0700 Subject: [PATCH 200/317] Update 01_user_access.mdx Former-commit-id: 29517fa5842a76bf07eceff0158d2839f818f38b --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index e640daa0d59..21809d8e256 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -2,7 +2,7 @@ title: "Managing User Access" --- -Role based access controls are achieved through a combination of organizations, roles, and users. +EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud Role Based Access Control to grant users access to different parts of the application. ## Organizations From 1a8536a9c1c4eb76971d57f8d798241cde42616c Mon Sep 17 00:00:00 2001 From: theadamwright Date: Fri, 6 Aug 2021 18:00:09 -0500 Subject: [PATCH 201/317] Update 02_connect_to_cluster.mdx Expanded placeholder for 'Connecting to Your Cluster'. Former-commit-id: 419999a6fa9ce97e21a73409689dfcdde67e4703 --- .../edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 8c8c741c8a1..c0b1f860193 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -2,4 +2,9 @@ title: "Connecting to Your Cluster" --- -Explain where a customer can access connection details and connect to their cluster. +To access connection details for your cluster, click on the name of your cluster on the Clusters page. From there, you will find Quick Connect information for connecting to your cluster using psql, the terminal-based client for Postgres. + +If using a client other than psql, click on the Connect tab next to Overview on the Clusters page. From there, you will find all the relevant information needed to +connect your client to the database cluster except for the user password: Database Name, Host, Port, Username, and Service URI. + +Please consult the application driver documentation for the connection string format the driver uses. From 14847d6af835576a311b6347c3e5cf2b73715d5d Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 6 Aug 2021 20:38:47 -0400 Subject: [PATCH 202/317] cleanup administring your cluster Former-commit-id: 5ea16233fd1287c95c200a108286fc3f061a4495 --- ...3_activity_log.mdx => 02_activity_log.mdx} | 2 +- .../security_and_networking/index.mdx | 2 +- .../getting_started/02_configure_acess.mdx | 54 ------------------- ...eate_cluster.mdx => 02_create_cluster.mdx} | 0 4 files changed, 2 insertions(+), 56 deletions(-) rename product_docs/docs/edbcloud/beta/administering_cluster/{security_and_networking/03_activity_log.mdx => 02_activity_log.mdx} (84%) delete mode 100644 product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx rename product_docs/docs/edbcloud/beta/getting_started/{03_create_cluster.mdx => 02_create_cluster.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx similarity index 84% rename from product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx index 3076170e7fb..90454ebd1e7 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/03_activity_log.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx @@ -1,5 +1,5 @@ --- -title: "Activity Log" +title: "Using Activity Logs" --- Also pgaudit / edb audit implications and what we allow customers to configure diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx index 80f85bdddc6..999616862f7 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx @@ -2,4 +2,4 @@ title: "Security and Networking" --- -Document content UPM-925 + diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx deleted file mode 100644 index 1336450cd45..00000000000 --- a/product_docs/docs/edbcloud/beta/getting_started/02_configure_acess.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Configure Access" ---- - - - -EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud Role Based Access Control to grant users access to different parts of the application. - -### Procedure - -After you created your Azure subscription and logged in into EDB Cloud for the first time you should do the following: - -1. Configure organization-wide **Roles**. -2. Invite users from your organization to sign in to EDB Cloud. -3. Assign roles to users using the **Users** screen. - - -### Configure Roles - -!!! Note - This feature may not be available in the preview release. The preview release may have only one predefined role _Owner_. - -Organization wide roles are configured in the following screen: - -![Roles](images/roles.png "organization roles") - - -Use the **Edit** button with a pen icon to edit permissions for a specific role. - - -### Invite Users - -When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory. Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using special emails designated by your organization to sign in using Azure AD. -!!! Note - Azure AD email domain will likely be different from the domain regurly used by your organization. -New users signed in to EDB Cloud have a minimum set of permissions. - - - -### Assign Roles to Users - -All users logged in to EDB Cloud will be listed in the following screen, sorted by the time of the latest login. - -![Users](images/users.png "list users") - -To assign appropriate roles to users, first find the right user and click **Edit** button with the pen icon. In the user screen, use the button **Assign Roles** to edit user roles. - - -![Assign Roles to Users](images/assign-roles.png "list users") - -!!! Note - For a user's role assignment to take effect, the user should sign out from EDB Cloud and sign in again. - - diff --git a/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx rename to product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx From 547bc8ee28c9a744ead0c12cb404f1675aa022fd Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Sat, 7 Aug 2021 05:58:24 -0400 Subject: [PATCH 203/317] Update product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx Former-commit-id: 7029dfaee1f04436440a2b72a0887826565ea84e --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index c5d7b1ffe01..50453bd19cf 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -80,7 +80,7 @@ To assign appropriate roles to users: 5. Select **Submit**. !!! Note - For a user's role assignment to take effect, the user should sign out from EDB Cloud and sign in again. + For a user's role assignment to take effect, the user needs to log out from EDB Cloud and log in again. ### Viewing Users From 77d55a39566dc4d186d76fd95c640d92af8ed94f Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Sat, 7 Aug 2021 06:48:36 -0400 Subject: [PATCH 204/317] Update 01_connect_cloud_account.mdx fixing code and table display issues (hopefully) Former-commit-id: 3edc13e66898948fdec3749993ee305286fdfa32 --- .../01_connect_cloud_account.mdx | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 8deb3d43bee..627a6010b70 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -31,12 +31,12 @@ If your role is Owner, Contributor, or [Support Request Contributor](https://doc Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: -~~~ +```sh Request Summary / New Limit: Resource Manager, EASTUS, ESv3 Series / 50 Resource Manager, UKSOUTH, ESv3 Series / 50 +``` -~~~ To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). ### Create Azure Active Directory Application @@ -80,13 +80,12 @@ To connect your cloud account with your Azure subscription: 1. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. 2. Fill in the following parameters in the form: - - | Parameter | Description | - | ------------------------------------- | ---------------------------------------------------------------------------- | - | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure AD App Secret** | Application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| - | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | - | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [step 2. Fill out the details for your plan.](2-fill-out-the-details-for-your-plan)) | + | Parameter | Description | + | ------------------------------------- | ---------------------------------------------------------------------------- | + | **Azure AD App ID** | Application (client) ID you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure AD App Secret** | Application (client) secret you noted when [creating your Azure AD Application](#create-azure-ad-application).| + | **Azure Subscription ID** | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account. | + | **Your EDB Cloud Organization Name** | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [step 2. Fill out the details for your plan.](2-fill-out-the-details-for-your-plan)) | 11. Select **Submit.** From 32fd8d7e0549a93b039606de81d70669c698d9f8 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 08:17:19 -0400 Subject: [PATCH 205/317] preliminary style edit pass I have an outstanding terminology question: should we refer to psql and similar tools as clients, applications, tools, maybe something else? Former-commit-id: c05a62d319fa54fafc3e3e37e3fdd1a30359c2fe --- .../beta/using_cluster/02_connect_to_cluster.mdx | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index c0b1f860193..2d73b3e55ef 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,10 +1,15 @@ --- title: "Connecting to Your Cluster" --- +You can connect to your cluster using `psql`, the terminal-based application for Postgres, or another application. -To access connection details for your cluster, click on the name of your cluster on the Clusters page. From there, you will find Quick Connect information for connecting to your cluster using psql, the terminal-based client for Postgres. +To connect to your cluster using `psql`: +1. Go to the **Clusters** page. +2. Select the name of your cluster. +3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql`. +4. Paste the command in your `psql` terminal. -If using a client other than psql, click on the Connect tab next to Overview on the Clusters page. From there, you will find all the relevant information needed to -connect your client to the database cluster except for the user password: Database Name, Host, Port, Username, and Service URI. - -Please consult the application driver documentation for the connection string format the driver uses. +To connect to your cluster using a client other than `psql`: +1. Go to the **Clusters** page. +2. Select the name of your cluster. +3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the user password. Please consult the client driver documentation for the connection string format the driver uses. From f4a0db459edfa33f2fdb3d47208a44c19d3b4f8d Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 08:36:21 -0400 Subject: [PATCH 206/317] added link to psql doc Former-commit-id: 302fb436446948cc8a8f019718944d0184917985 --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 2d73b3e55ef..9d1db65a28b 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,7 +1,7 @@ --- title: "Connecting to Your Cluster" --- -You can connect to your cluster using `psql`, the terminal-based application for Postgres, or another application. +You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based application for Postgres, or another application. To connect to your cluster using `psql`: 1. Go to the **Clusters** page. From 890a654807d9ddeb626b50dbe3a6d0c4886d2c79 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 08:40:19 -0400 Subject: [PATCH 207/317] terminology edits cleaned up inconsistencies so that we are using client throughout Former-commit-id: 984bac69e24a4c7eb0bae7942bec4dc2f21d63ce --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 9d1db65a28b..f59632b0121 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,7 +1,7 @@ --- title: "Connecting to Your Cluster" --- -You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based application for Postgres, or another application. +You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based client for Postgres, or another client. To connect to your cluster using `psql`: 1. Go to the **Clusters** page. From d179ccf46eb678fe09b8fea78303733e84c4ea57 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 08:45:40 -0400 Subject: [PATCH 208/317] updated link label moved "with Oracle compatibility" to normal text outside of the link label Former-commit-id: 327424a26c7d98e77521963ade4bf8acc69feccf --- product_docs/docs/edbcloud/beta/overview/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index ca2b0b8b710..b5c8b7f6199 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -4,7 +4,7 @@ description: "Learn about EDB Cloud " --- -EDB Cloud is a fully managed database as a service with built-in Oracle compatibility, running in your cloud account, and operated by the Postgres experts. EDB Cloud 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 with Oracle compatibility](https://www.enterprisedb.com/docs/epas/latest/). +EDB Cloud is a fully managed database as a service with built-in Oracle compatibility, running in your cloud account, and operated by the Postgres experts. EDB Cloud 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. From 7e3474ea349696edc54d3ef3c0c883e1f134abd2 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 08:49:45 -0400 Subject: [PATCH 209/317] Update 05_database_version_policy.mdx Former-commit-id: 73798e81765f6f9797314e0308c4879fabe998a8 --- .../edbcloud/beta/overview/05_database_version_policy.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx index 96abcd1439f..8eb7e26b179 100644 --- a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -17,9 +17,9 @@ title: "Database Version Policy" ## Major Version Support -PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. Please reference the [EDB Product Compatibility page](https://www.enterprisedb.com/product-compatibility#pg) for more details. +PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. See [Platform Compatibility](https://www.enterprisedb.com/product-compatibility#pg) for more details. -EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB. Please reference the [EDB Product Compatibility page](https://www.enterprisedb.com/product-compatibility#epas) for more details. +EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB. See [Platform Compatibility ](https://www.enterprisedb.com/product-compatibility#epas) for more details. From 3b60d72a00f44cf6ed3a917c3936626bd5115e03 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 06:12:19 -0700 Subject: [PATCH 210/317] Update 01_user_access.mdx Former-commit-id: 4e0c946ed4a64f62408ec85cfa3c3ba1e895d6e5 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index fbfb762e6a9..f8d086fab84 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -92,7 +92,7 @@ To view all users from your organization that have logged in at least once: 1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. 1. Users Tom and Jerry have different roles with different permissions. 1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced Server clusters. -2. Tom, a user with the **reader** role, can read data from PostgreSQL and EDB Postgres Advanced Server databases. +2. Tom, a user with the **reader** role, can read the list of PostgreSQL and EDB Postgres Advanced Servers clusters availabe in the account. 3. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. The following diagram illustrates a mapping between objects that exist within the EDB Cloud and Azure cloud for AcmeBank example scenario. From b697b6177ebc32d33627b51048f4ded37c2b7756 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 06:12:47 -0700 Subject: [PATCH 211/317] Update 01_user_access.mdx Former-commit-id: 81b4304d626c323e2b8ad66a6b26a46033c6d384 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index f8d086fab84..d0b223a003e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -92,7 +92,7 @@ To view all users from your organization that have logged in at least once: 1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. 1. Users Tom and Jerry have different roles with different permissions. 1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced Server clusters. -2. Tom, a user with the **reader** role, can read the list of PostgreSQL and EDB Postgres Advanced Servers clusters availabe in the account. +2. Tom, a user with the **reader** role, can read the list of PostgreSQL and EDB Postgres Advanced Server clusters availabe in the account. 3. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. The following diagram illustrates a mapping between objects that exist within the EDB Cloud and Azure cloud for AcmeBank example scenario. From fb5d24e87999203acd17e4c5c9204f82b7d645dd Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Mon, 9 Aug 2021 09:23:19 -0400 Subject: [PATCH 212/317] Update 03_modify_and_scale_cluster.mdx changed note formatting Former-commit-id: ab1dd6d851becdb92efb5336d2061642f1e9c546 --- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 35223a69d89..7aa8cd508cb 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -12,11 +12,13 @@ title: "Modifying and Scaling Clusters" | Cluster Password | The password for your cluster. | | High Availability | High Availability is optional. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, 1 instance is provisioned. | | Instance Type* | Select the instance based on the number of vCPUs and amount of memory desired. | -| Volume Properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. !!! Note: Storage can only be scaled up; it cannot be reduced. | +| Volume Properties* | Select volume properties based on the amount of storage and provisioned IOPS desired. Storage can only be scaled up; it cannot be reduced. | | Number of Connections | Type or use the arrows to enter the desired amount of connections between your cluster and other applications. The default number of connections is 100. | | Networking | Click the toggle under Networking to enable public networking, which means that any client can connect to your cluster’s public IP address over the internet. By default, your networking is set to private, which allows only IP addresses within your private network to connect to your cluster. | *Changing the instance type or volume properties could incur higher cloud infrastructure charges. 5. Select **Save** to save your changes. -6. Select **Confirm Changes**. !!! Note: Saving changes may require a database restart. +6. Select **Confirm Changes**. + !!! + Note: Saving changes may require a database restart. From c5a9b819de7ed2538f107e34be32f74769aff7c2 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Fri, 6 Aug 2021 18:22:06 -0400 Subject: [PATCH 213/317] Update 03_create_cluster.mdx Fixed list spacing and added links Former-commit-id: 99833736e6b951c829ef15e07e5b0028e45bac5b --- .../edbcloud/beta/getting_started/02_create_cluster.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx index 6eb8fffb215..a6a3bc3b638 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx @@ -10,8 +10,8 @@ To create a cluster: 5. Enter a password for your cluster in the **Password** field. This will be the password for the superuser 'edb_admin'. 6. In the **Database Type** section, 1. Select the type of Postgres you want to use in the **Postgres Type** field: - - *PostgreSQL* is an open-source object-relational database management system. - - *EDB Postgres Advanced Server* is EDB’s secure, Oracle-compatible PostgreSQL. + - [*PostgreSQL*](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) is an open-source object-relational database management system. + - [*EDB Postgres Advanced Server*](https://www.enterprisedb.com/docs/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. 6. Select the version of Postgres that you want to use in the **Version** field. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. 7. Select the cloud provider for your cluster in the **Provider** field. !!! Note @@ -23,8 +23,8 @@ To create a cluster: !!! Note Azure premium storage is the only option for the Preview. 12. (Optional) Expand the **Advanced Customization** section, to specify: - 1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100. - 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. + 1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100. + 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. 17. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 45911f13658b036667640941dd291300ff6dd4aa Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Sun, 8 Aug 2021 13:13:23 -0400 Subject: [PATCH 214/317] Made link URLs relative Former-commit-id: 05fa78067f492485db840b797f2f5a095676019b --- .../edbcloud/beta/getting_started/02_create_cluster.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx index a6a3bc3b638..8ce821ed211 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx @@ -10,8 +10,8 @@ To create a cluster: 5. Enter a password for your cluster in the **Password** field. This will be the password for the superuser 'edb_admin'. 6. In the **Database Type** section, 1. Select the type of Postgres you want to use in the **Postgres Type** field: - - [*PostgreSQL*](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) is an open-source object-relational database management system. - - [*EDB Postgres Advanced Server*](https://www.enterprisedb.com/docs/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. + - [*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. 6. Select the version of Postgres that you want to use in the **Version** field. Refer to our [versioning policy](../overview/05_database_version_policy) for more information. 7. Select the cloud provider for your cluster in the **Provider** field. !!! Note @@ -23,8 +23,8 @@ To create a cluster: !!! Note Azure premium storage is the only option for the Preview. 12. (Optional) Expand the **Advanced Customization** section, to specify: - 1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100. - 3. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. + 1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100. + 1. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet. 17. Select **Create Cluster**. It might take a few minutes to deploy. ## What’s Next From 0bab1d9d4490c7197a7f8192fbfeb4328d67762a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:50:37 -0400 Subject: [PATCH 215/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Added link to clusters page in the UI Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: e4e826b1fea318c15305afb7c5fa8bd5706f6f56 --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index f59632b0121..60733d571b4 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -4,7 +4,7 @@ title: "Connecting to Your Cluster" You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based client for Postgres, or another client. To connect to your cluster using `psql`: -1. Go to the **Clusters** page. +1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. 2. Select the name of your cluster. 3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql`. 4. Paste the command in your `psql` terminal. From 9829a89d8229bc8e2e7bf08bb5fda61559342413 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:57:02 -0400 Subject: [PATCH 216/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: aabc5cf7fc0d2b0aad6bae8f1c8f3a08a9b3c864 --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 60733d571b4..969c9d0f400 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -6,7 +6,7 @@ You can connect to your cluster using [`psql`](http://postgresguide.com/utilitie To connect to your cluster using `psql`: 1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. 2. Select the name of your cluster. -3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql`. +3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` will prompt for the `edb_admin` user password you selected at cluster creation time. 4. Paste the command in your `psql` terminal. To connect to your cluster using a client other than `psql`: From 77cd3ab323f66649637459678f14cd16be4971cb Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:57:32 -0400 Subject: [PATCH 217/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 3415b6d66c142468a21b652eb8c8c426cc7cf80e --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 969c9d0f400..013b7c107e1 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -12,4 +12,4 @@ To connect to your cluster using `psql`: To connect to your cluster using a client other than `psql`: 1. Go to the **Clusters** page. 2. Select the name of your cluster. -3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the user password. Please consult the client driver documentation for the connection string format the driver uses. +3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the `edb_admin` user password. Please consult the client driver documentation for the connection string format the driver uses. From 2655b47bec0fb286a18decef92e02b62447a4f42 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Mon, 9 Aug 2021 14:33:59 -0400 Subject: [PATCH 218/317] Update 03_security_compliance.mdx Draft #2. I continued fattening up the Security page. Former-commit-id: f71c05fd6a98d6a67a4d556622f0aad4b81a2d54 --- .../edbcloud/beta/overview/03_security_compliance.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index d51f27dbec1..27af777473d 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -3,9 +3,11 @@ title: "Security" --- EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: -- **Data Isolation:** Clusters are installed and managed in your own cloud environment. Complete segregation of your data is ensured. +- **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data is never stored in a shared space, and compromise of another EDB customer's system does not put your system at risk. - **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. -- **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. Bring your own encryption keys for an additional level of control. -- **Logging and Auditing:** Logging and auditing is supported. +- **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. +- **Control Plane Logging:** Activities in the control plan related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. +- **Database Logging and Auditing:** Creation and deletion of clusters are tracked automatically in the Activity Log and PostgreSQL logging, and auditing is supported. Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. +- **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. From 9a51432559a85ff3dde2cda90e2f443783476a96 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 9 Aug 2021 15:01:14 -0400 Subject: [PATCH 219/317] docs(UPM-931): activity Log Former-commit-id: f1c9200b8eb771434019bf7acdabaabcef9ae346 --- .../administering_cluster/02_activity_log.mdx | 38 ++++++++++++++++--- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx index 90454ebd1e7..4bb0180ab43 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx @@ -1,11 +1,39 @@ --- -title: "Using Activity Logs" +title: "Using Activity Log" --- +Activity Log collects **EDB Cloud events**. It can be used to audit activities performed by users from your organizations. + +**EDB Cloud Events** describe actions performed by EDB Cloud Users over EDB Cloud Resources. The available actions are: +* _Create _ +* _Read _ +* _Update _ +* _Delete_ + +EDB Cloud collects events related to the following Resource Types: +* _Database_ +* _User_ +* _User Roles_ +* _Role Permissions_ +* _Organization_ + +To view the Activity Log table, navigate to Activity Log. + +!!! Note + To view Activity Log, you need to have the role _owner_ or have the _read:event_ permission. + + The Activity Log table has the following fields: + +| Field | Description | +| ---------------------| ---------------------------------------------------------------------------- | +| **Activity Name** | Name of an event in the format _Action Resource-Type, Resource-name_ | +| **User** | User responsible for the event | +| **Date** | Date when the action was performed | +| **Resource** | Resource Type of the resource | + + + +To search the Activity Log table, use the filters at the top of the page. -Also pgaudit / edb audit implications and what we allow customers to configure -- What events are tracked in Activity Log -- Define events -UPM-931 From cb7dc2b5fa68d933d1c31a1bad998c09d04e495b Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 12:52:33 -0700 Subject: [PATCH 220/317] Update product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 495671896ab9d9e98b9b4ceb8c00c595528c310b --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 27af777473d..323750a56a8 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -3,11 +3,10 @@ title: "Security" --- EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: -- **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data is never stored in a shared space, and compromise of another EDB customer's system does not put your system at risk. +- **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another EDB Cloud customer's systems does not put your data at risk. - **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. - **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. - **Control Plane Logging:** Activities in the control plan related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. - **Database Logging and Auditing:** Creation and deletion of clusters are tracked automatically in the Activity Log and PostgreSQL logging, and auditing is supported. Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. - **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. - From 4034def90961d577d33bf60df15bf5392fb1ae5e Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 12:53:35 -0700 Subject: [PATCH 221/317] Update product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: a4fa1b6b66a153f0d39b8379f4bdf30fa919bede --- .../docs/edbcloud/beta/overview/03_security_compliance.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx index 323750a56a8..8c704bb0acb 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx @@ -5,8 +5,7 @@ title: "Security" EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: - **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another EDB Cloud customer's systems does not put your data at risk. - **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. -- **Data Encryption:** Data is encrypted in motion and at rest. All network traffic is encrypted using Transport Layer Security (TLS). All data is encrypted when stored in database clusters. +- **Data Encryption:** All data in EDB Cloud is encrypted in motion and at rest. Network traffic is encrypted using Transport Layer Security (TLS) v1.2 or greater, where applicable, and EDB Cloud Postgres instances do not accept insecure connections. Data at rest is encrypted using AES with 256 bit keys. Data encryption keys are envelope encrypted and the wrapped data encryption keys are securely stored in an Azure Key Vault instance in your account. Encryption keys never leave your environment. - **Control Plane Logging:** Activities in the control plan related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. - **Database Logging and Auditing:** Creation and deletion of clusters are tracked automatically in the Activity Log and PostgreSQL logging, and auditing is supported. Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. - **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. - From bbb8a91714b002e84de2e3e146aa0ddc4500b26c Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:01:54 -0700 Subject: [PATCH 222/317] Update product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 137eb25e1f0740b4fb82e8998c78c670851931dc --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index d0b223a003e..36a1ce7d172 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -8,7 +8,7 @@ EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud R Each subscribed customer has a unique *organization*. Each organization’s database clusters are installed and managed in their own cloud account ensuring complete segregation of customer data. -Each EDB Cloud organization belongs to an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After you link your Azure AD during subscription, users that belong to that AD can login with minimum access privileges. +Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After you link your Azure AD during subscription, users that belong to that AD can login with minimum access privileges. EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. A user with the **owner** role may also define their own sets of roles which can be applied across the organization. From 3099293a1acfda79bdc35852a4624a40a445f234 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:21:25 -0700 Subject: [PATCH 223/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: f39fbafef2459d6fff6cc9c3ba444d4edb3fabd9 --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 013b7c107e1..c0f2fa2313a 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -7,7 +7,7 @@ To connect to your cluster using `psql`: 1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. 2. Select the name of your cluster. 3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` will prompt for the `edb_admin` user password you selected at cluster creation time. -4. Paste the command in your `psql` terminal. +4. Paste the command in your terminal. To connect to your cluster using a client other than `psql`: 1. Go to the **Clusters** page. From 2ce89b3b37723f90a79e0c4ef6e00644b44f8bef Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:22:17 -0700 Subject: [PATCH 224/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 7b8ce277431e18265fb451353ecdfc6900561c4c --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index c0f2fa2313a..0fe7bbaafee 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -10,6 +10,6 @@ To connect to your cluster using `psql`: 4. Paste the command in your terminal. To connect to your cluster using a client other than `psql`: -1. Go to the **Clusters** page. +1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. 2. Select the name of your cluster. 3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the `edb_admin` user password. Please consult the client driver documentation for the connection string format the driver uses. From 1e81f644e091c207710359713372aa973ada47f4 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Mon, 9 Aug 2021 16:34:36 -0400 Subject: [PATCH 225/317] renamed security_compliance to security Former-commit-id: e474e0b10576050e48c84b0f7c296a8e6e341c1c --- .../beta/overview/{03_security_compliance.mdx => 03_security.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename product_docs/docs/edbcloud/beta/overview/{03_security_compliance.mdx => 03_security.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx b/product_docs/docs/edbcloud/beta/overview/03_security.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/overview/03_security_compliance.mdx rename to product_docs/docs/edbcloud/beta/overview/03_security.mdx From d048756ca3d186b2a29ab3716068161a44c1122b Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 13:46:11 -0700 Subject: [PATCH 226/317] Update product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 93e92d337069af012db5745a99c86de426397a68 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 36a1ce7d172..abcb597120e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -6,7 +6,7 @@ EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud R ## Organizations -Each subscribed customer has a unique *organization*. Each organization’s database clusters are installed and managed in their own cloud account ensuring complete segregation of customer data. +Each subscribed customer has a unique *organization*. Each organization’s database clusters are deployed and managed in the customer's cloud account. This ensures complete segregation of customer data between organizations. Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After you link your Azure AD during subscription, users that belong to that AD can login with minimum access privileges. From 7153845a6d5c9d17e139de9e1eab8b063f6e0850 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:06:43 -0700 Subject: [PATCH 227/317] Update 01_user_access.mdx Former-commit-id: 40fb46e191e47b4bdba0cceb2d1082ba87330fe7 --- .../administering_cluster/01_user_access.mdx | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index abcb597120e..fc44ea47503 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -8,31 +8,33 @@ EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud R Each subscribed customer has a unique *organization*. Each organization’s database clusters are deployed and managed in the customer's cloud account. This ensures complete segregation of customer data between organizations. -Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After you link your Azure AD during subscription, users that belong to that AD can login with minimum access privileges. - -EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. A user with the **owner** role may also define their own sets of roles which can be applied across the organization. +Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges. +EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. ## Roles Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. ### Default Roles -* The predefined _owner_ role created during marketplace sign up has all permissions. -* Each organization will have two additional default roles of _reader_ and _contributor_ available during Preview. +* Each organization will have three default 'roles' available: + * _owner_ + * _reader_ + * _contributor_ + * These roles can be edited by changing their name, description, or permissions. ### Role Permissions -Permissions are generally represented in the format _action:object_ where _action_ represents an operation that can be performed and _object_ represents a category of EDB Cloud functionality. +Permissions are generally represented in the format 'action:object' where 'action' represents an operation that can be performed and 'object' represents a category of portal functionality. -The available _actions_ are: -* _create _ -* _read _ -* _update _ +The available 'actions' are: +* _create_ +* _read_ +* _update_ * _delete_ -The available _objects_ are: +The available 'objects' are: * _databases_ * _backups_ * _events_ @@ -66,7 +68,7 @@ To change permissions associated with the role: ## Users -When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory (AD). Before users become visible in the EDB Cloud **Users** screen they need to sign in to EDB Cloud using special emails designated by your organization to sign in using Azure AD. New users signed in to EDB Cloud have a minimum set of permissions until you assign them a role. +When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory (AD). Before users become visible in the EDB Cloud **Users** screen they need to sign in using Azure AD after receiving special emails sent by your organization. New users signed in to EDB Cloud have a minimum set of permissions until you assign them a role. ### Assigning Roles to Users To assign appropriate roles to users: From d5ff7e76162fe020909de56072637e562de164c4 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:08:48 -0700 Subject: [PATCH 228/317] Update 01_user_access.mdx Former-commit-id: 33f7c35da709dac43f3cb5f2b8796ffa8f1e31cb --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index fc44ea47503..566d830bd40 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -2,7 +2,7 @@ title: "Managing User Access" --- -EDB Cloud uses Azure Active Directory to authenticate users and uses EDB Cloud Role Based Access Control to grant users access to different parts of the application. +EDB Cloud uses Azure Active Directory to authenticate users and role based access controls to grant users access to different parts of the application. ## Organizations From 1bbc59d0bf7640c1f0dc87d42a1d5f8839446275 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:11:07 -0700 Subject: [PATCH 229/317] Update product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 70a30fe8475b829d38fced9d02fc5528f6d71a9e --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 566d830bd40..959a48b7d6e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -53,7 +53,7 @@ To edit roles: #### Changing Role Name -To change the name or dscription of the role: +To change the name or description of the role: 1. Select the **Settings** tab. 2. Edit **Name** or **Description**. 3. Press **Save**. From a27c8a12be696089ae07248fb4d6043ce9e889a5 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:13:28 -0700 Subject: [PATCH 230/317] Update 01_user_access.mdx Former-commit-id: b282ffd48c1fcfdf3febc166114461b9b0802a8e --- .../beta/administering_cluster/01_user_access.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 959a48b7d6e..302bcec4dea 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -17,7 +17,7 @@ Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You u ### Default Roles -* Each organization will have three default 'roles' available: +* Each organization will have three default `roles` available: * _owner_ * _reader_ * _contributor_ @@ -26,15 +26,15 @@ Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You u ### Role Permissions -Permissions are generally represented in the format 'action:object' where 'action' represents an operation that can be performed and 'object' represents a category of portal functionality. +Permissions are generally represented in the format `action:object` where `action` represents an operation that can be performed and `object` represents a category of portal functionality. -The available 'actions' are: +The available `actions` are: * _create_ * _read_ * _update_ * _delete_ -The available 'objects' are: +The available `objects` are: * _databases_ * _backups_ * _events_ From e833be87b35498893a5967165aa5a8292bc9fe54 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:15:52 -0700 Subject: [PATCH 231/317] Update 01_user_access.mdx Former-commit-id: fdd2ed5061d245c499fc0c225e146f541deb8953 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 302bcec4dea..80c1e7c3ead 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -66,6 +66,8 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** +!!!Note: Changing role permissions will affect every user who is assigned the same role. + ## Users When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure Active Directory (AD). Before users become visible in the EDB Cloud **Users** screen they need to sign in using Azure AD after receiving special emails sent by your organization. New users signed in to EDB Cloud have a minimum set of permissions until you assign them a role. From 1c2a888173cdc003ccf474d49f459f28b050dd62 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:35:07 -0700 Subject: [PATCH 232/317] Update 01_user_access.mdx Former-commit-id: f72288ee049f171fc8d06e6f98e224f79445dac0 --- .../beta/administering_cluster/01_user_access.mdx | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 80c1e7c3ead..fb8f11857cc 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -91,14 +91,10 @@ To view all users from your organization that have logged in at least once: 2. View the list of users sorted by most recent log in. ## Example Scenario -1. AcmeBank owns a subcription to Azure and the acmebank.com Azure AD. -1. AcmeBank purchases a subscription to the EDB Cloud and assigns the name acmebank-com for their organization. -1. Tom and Jerry, who are members of acmebank.com Azure AD, can sign in. -1. Users Tom and Jerry have different roles with different permissions. -1. Jerry, a user with the **owner** role, can create and own PostgreSQL and EDB Postgres Advanced Server clusters. -2. Tom, a user with the **reader** role, can read the list of PostgreSQL and EDB Postgres Advanced Server clusters availabe in the account. -3. The clusters are deployed in the Azure cloud environment owned by AcmeBank, but managed by EDB. -The following diagram illustrates a mapping between objects that exist within the EDB Cloud and Azure cloud for AcmeBank example scenario. +1. The EDB Cloud organization is created, and Tom logs in and is granted the **owner** role. +1. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created. +1. Tom grants Sally the **contributor** role. Sally logs out and back in, and she can now create EDB Cloud clusters. +1. Sally asks Jerry to log in, and grants him the **reader** role. +1. Jerry logs out and back in, and he can now see the clusters that Sally has created. -![*EDB Cloud and Azure*](images/org-map.png ) From 006be99215699b3446588b9e8ec4e5cb9b8900ee Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 14:40:16 -0700 Subject: [PATCH 233/317] Update 01_user_access.mdx Former-commit-id: c4c0f65dbff2a2a06a014f4d6190912b2cdab769 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index fb8f11857cc..1ec1778ba2f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -24,7 +24,7 @@ Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You u * These roles can be edited by changing their name, description, or permissions. -### Role Permissions +### Permissions Permissions are generally represented in the format `action:object` where `action` represents an operation that can be performed and `object` represents a category of portal functionality. From 0e5727e64479223687786a5cfee807f2ce9bf91f Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 15:21:52 -0700 Subject: [PATCH 234/317] Update 01_user_access.mdx Former-commit-id: ba08558be8efb948052bb4355b11177749e8d043 --- .../administering_cluster/01_user_access.mdx | 43 +++++++++++-------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 1ec1778ba2f..382e153672d 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -15,34 +15,39 @@ EDB Cloud supports role based access control policies. A user with the **owner** ## Roles Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. -### Default Roles - * Each organization will have three default `roles` available: * _owner_ * _reader_ * _contributor_ -* These roles can be edited by changing their name, description, or permissions. +* These roles can be edited by changing their name or description. -### Permissions +### Permissions Permissions are generally represented in the format `action:object` where `action` represents an operation that can be performed and `object` represents a category of portal functionality. -The available `actions` are: -* _create_ -* _read_ -* _update_ -* _delete_ - -The available `objects` are: -* _databases_ -* _backups_ -* _events_ -* _permissions_ -* _roles_ -* _users_ -* _billing_ -* _versions_ +The available `actions` are: _create_, _read_, _update_, _delete_ + +The available `objects` are: _backups_, _billing_, _databases_, _events_, _permissions_, _roles_, _tickets_, _users_, _versions_ + +### Permissions by Role + +The following are the default permission by role: + +| Role | Action |backups | billing | databases | events | roles | permissions | tickets | users | versions | +|-------------|--------|--------|---------|-----------|--------|-------|-------------|---------|-------|----------| +| owner | create | x | | x | | x | x | x | x | x | +| | read | x | x | x | x | x | x | x | x | x | +| | update | x | | x | | x | x | x | x | x | +| | delete | x | | x | | x | x | x | x | x | +| contributor | create | x | | x | | | | x | | | +| | read | x | x | x | x | x | x | x | x | x | +| | update | x | | x | | | | x | | | +| | delete | x | | x | | | | x | | | +| reader | create | | | | | | | | | | +| | read | x | x | x | | x | x | x | x | x | +| | update | | | | | | | | | | +| | delete | | | | | | | | | | ### Editing Roles From 83fd35690eaf3ae184e9bd56cda12d3a828f6e88 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 9 Aug 2021 18:27:52 -0400 Subject: [PATCH 235/317] initial markdown version Former-commit-id: 1ff3fd01b50331b4f028934dbf91f9b197e48edc --- .../edbcloud/beta/overview/06_support.mdx | 69 ++++++++++++++++++- 1 file changed, 66 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/06_support.mdx b/product_docs/docs/edbcloud/beta/overview/06_support.mdx index d8c25425bce..2205437bcef 100644 --- a/product_docs/docs/edbcloud/beta/overview/06_support.mdx +++ b/product_docs/docs/edbcloud/beta/overview/06_support.mdx @@ -2,11 +2,74 @@ title: "Support" --- -Document how and where customers can open support tickets: +If you experience problems with EDB Cloud, you have several options to engage with EDB's Support team to get help. If you have an EDB Cloud account, you can go directly to the Support portal or the EDB Cloud portal to open a support case, or you can leave Support a message using the Support widget kCase. -- Support ticket Portal: support.edbcloud.com +If you can’t log in to your account, send us an email to cloudsupport@enterprisedb.zendesk.com[support@enterprisedb.zendesk.com. + +## Creating a Support Case From the Support Portal (recommended) + +1. Initiate a support case using any one of these options: + - Go to the [Support portal](https://support.edbcloud.com/hc/en-us) and select **Submit a request** at the top right of the page. + - Log in to EDB Cloud, select the question mark (?) at the top right of the page, select **Support Portal**, and select **Submit a request** at the top right of the page. + - Log in to EDB Cloud, select the question mark (?) at the top right of the page, select **Create Support ticket**. +1. Enter a description in the **Subject** field. +1. (Optional) Select the cluster name from the **Cluster name** list. +1. Enter values for **Severity Level** and **Description**. +1. (Optional) Attach files to provide more details about the issue you're experiencing. +1. Select **Submit**. + +## Creating a Support Case From the Support Widget + +1. Log in to EDB Cloud and select **Support** on the bottom of the left navigation pane. +1. Fill in the **Leave us a message** form. + 1. (Optional) The **Your Name** field is pre-filled, but you can edit it. + 1. The **Email Address** field is pre-filled, but you can edit it. + 1. (Optional) Select the cluster name from the **Cluster name** list. + 1. Enter values for **Severity Level** and **Description**. + 1. (Optional) Attach files to provide more details about the issue you're experiencing. + 1. Select **Submit**. + +## Case Severity Level + +| Level | Description | +| -------- | ----------- | +| Severity 1 | The cloud service is down or there is an error with critical impact on the your production environment. Covers urgent problems including database service outage, data loss, and cluster provisioning failure. | +| Severity 2 | There is a cloud service error or an issue with significant impact on your production environment. The system is functioning but in a severely reduced capacity. Covers problems including database service interruption and backup failures. | +| Severity 3 | There is an error or issue that doesn't without a significant impact on your production environment. Covers problems including API issues, monitoring metrics, and logging issues. +| Severity 4 | General questions, inquiries, or non-technical requests. + +## Basic and Gold Support + +EDB offers two levels of support: Gold Support and Basic Support. + +### Gold Support +Tickets can be opened by authorized users 24/7. + +Initial response time goals are: + +| Severity Level | Response Time Goals | +| -------------- | ------------------- | +| Severity 1 | 15 minutes | +| Severity 2 | 30 minutes | +| Severity 3 | 60 minutes | +| Severity 4 | 4 hours | + +Time for issue resolution goals are: + +| Severity Level | Resolution Goals | +| -------------- | ------------------- | +| Severity 1 | 8 hours | +| Severity 2 | 12 hours | +| Severity 3 | 5 business days | +| Severity 4 | 10 business days | + +### Basic Support +Free support for general inquiries between the hours of 8AM-6PM EST Monday through Friday. + +Initial response time goal is within 4 hours. + +Time for issue resolution goal is 15 business days. -- Chat From c2658ebf092fae75252e9d571aefc0255473948f Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 15:47:56 -0700 Subject: [PATCH 236/317] Create 01_user_access.mdx Former-commit-id: 595a59c45190fc86a009e31fb676afc2b8e0a64d --- .../edbcloud/beta/administering_cluster/01_user_access.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 382e153672d..c0c99c7770e 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -71,7 +71,8 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** -!!!Note: Changing role permissions will affect every user who is assigned the same role. +!!! Note: + Changing role permissions will affect every user who is assigned the same role. ## Users From 8404b491796bb799f637013c332eb0e499081653 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Mon, 9 Aug 2021 15:51:45 -0700 Subject: [PATCH 237/317] Update 01_user_access.mdx Former-commit-id: bb2e90f457033867d5e6b33a07cc0e534547f60e --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index c0c99c7770e..53758aa50af 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -19,7 +19,6 @@ Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You u * _owner_ * _reader_ * _contributor_ - * These roles can be edited by changing their name or description. ### Permissions From 402194596ecc0249e15c54c36cd80fe8c9b7e597 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 9 Aug 2021 19:17:59 -0400 Subject: [PATCH 238/317] Changed title Former-commit-id: b5119d1a80d64670107c4dc6d7e7035fc400c0d3 --- product_docs/docs/edbcloud/beta/overview/06_support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/overview/06_support.mdx b/product_docs/docs/edbcloud/beta/overview/06_support.mdx index 2205437bcef..b90b1f070b8 100644 --- a/product_docs/docs/edbcloud/beta/overview/06_support.mdx +++ b/product_docs/docs/edbcloud/beta/overview/06_support.mdx @@ -1,5 +1,5 @@ --- -title: "Support" +title: "Support Options" --- If you experience problems with EDB Cloud, you have several options to engage with EDB's Support team to get help. If you have an EDB Cloud account, you can go directly to the Support portal or the EDB Cloud portal to open a support case, or you can leave Support a message using the Support widget kCase. From 40eef5b2dc9179ed90c4d67c030eda0144c5d3ae Mon Sep 17 00:00:00 2001 From: theadamwright Date: Mon, 9 Aug 2021 21:27:02 -0400 Subject: [PATCH 239/317] Update 03_security.mdx Added sub-bullet for PgAudit. Control plane wording suggestion committed Former-commit-id: 44f603e3f1e1ab1313fc06806000dda5fc5f2a03 --- product_docs/docs/edbcloud/beta/overview/03_security.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security.mdx b/product_docs/docs/edbcloud/beta/overview/03_security.mdx index 8c704bb0acb..baca2660fa4 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security.mdx @@ -6,6 +6,7 @@ EDB's cloud offering runs in your own cloud account, isolates your data from oth - **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another EDB Cloud customer's systems does not put your data at risk. - **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. - **Data Encryption:** All data in EDB Cloud is encrypted in motion and at rest. Network traffic is encrypted using Transport Layer Security (TLS) v1.2 or greater, where applicable, and EDB Cloud Postgres instances do not accept insecure connections. Data at rest is encrypted using AES with 256 bit keys. Data encryption keys are envelope encrypted and the wrapped data encryption keys are securely stored in an Azure Key Vault instance in your account. Encryption keys never leave your environment. -- **Control Plane Logging:** Activities in the control plan related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. -- **Database Logging and Auditing:** Creation and deletion of clusters are tracked automatically in the Activity Log and PostgreSQL logging, and auditing is supported. Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. +- **Portal Audit Logging:** Activities in the portal, such as those related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. +- **Database Logging and Auditing:** Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. + - **pgAudit:** The classes of statements being logged for pgAudit are set globally on a cluster with `pgaudit.log = 'write,ddl'`. The following statements made on tables will be logged by default when the cluster type is PostgreSQL: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, AND `COPY`. All `DDL` will be logged. - **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. From 084ef52862607d1f5a92ffc84d9511eebac5d685 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 10 Aug 2021 06:12:21 -0400 Subject: [PATCH 240/317] Addressed remaining comments from Ben on Security topic Former-commit-id: 70c18c9c7553d680018b1707cea549d9d828f5ca --- product_docs/docs/edbcloud/beta/overview/03_security.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security.mdx b/product_docs/docs/edbcloud/beta/overview/03_security.mdx index baca2660fa4..908988f1339 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security.mdx @@ -4,9 +4,9 @@ title: "Security" EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: - **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another EDB Cloud customer's systems does not put your data at risk. -- **Granular Access Control:** You can use _Single Sign On_ and define your own sets of _Roles_ and _Role Based Access Control_ policies to manage your individual cloud environments. +- **Granular Access Control:** You can use Single Sign On (SSO) and define your own sets of roles and Role Based Access Control (RBAC) policies to manage your individual cloud environments. See [Managing User Access](../administering_cluster/01_user_access) for more information. - **Data Encryption:** All data in EDB Cloud is encrypted in motion and at rest. Network traffic is encrypted using Transport Layer Security (TLS) v1.2 or greater, where applicable, and EDB Cloud Postgres instances do not accept insecure connections. Data at rest is encrypted using AES with 256 bit keys. Data encryption keys are envelope encrypted and the wrapped data encryption keys are securely stored in an Azure Key Vault instance in your account. Encryption keys never leave your environment. -- **Portal Audit Logging:** Activities in the portal, such as those related to User Roles, Organization updates, and Cluster Creation and Deletion are tracked automatically and viewed in the Activity Log. -- **Database Logging and Auditing:** Functionality to track and analyze database activities is enabled automatically. The PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced, the EDB Audit extension is enabled automatically for you. +- **Portal Audit Logging:** Activities in the portal, such as those related to user roles, organization updates, and cluster creation and deletion are tracked automatically and viewed in the Activity Log. +- **Database Logging and Auditing:** Functionality to track and analyze database activities is enabled automatically. For PostgreSQL, the PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced Server, the EDB Audit extension (edbAudit) is enabled automatically for you. - **pgAudit:** The classes of statements being logged for pgAudit are set globally on a cluster with `pgaudit.log = 'write,ddl'`. The following statements made on tables will be logged by default when the cluster type is PostgreSQL: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, AND `COPY`. All `DDL` will be logged. - **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. From ec538cafa75729cde6a23fd40644ee93ca269165 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 09:41:56 -0400 Subject: [PATCH 241/317] Update index.mdx Former-commit-id: c8ec4d5e9f9665d9bb89617127fd2656df68f841 --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 068ca29101b..77c050865a4 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -3,7 +3,7 @@ title: "Pricing and Billing " --- ## Pricing -Pricing is based on the database software distribution and the number of Virtual Central Processing Units (vCPUs) provisioned, and is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by three to calculate the full price for all resources used. See the full cost breakdown below: +Pricing is based on the number of Virtual Central Processing Units (vCPUs) provisioned for the database software offering. Consumption of vCPUs is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by three to calculate the full price for all resources used. See the full cost breakdown below: | Database Type | Hourly Price | Monthly Price* | | --------------------- | -------------- | -------------- | @@ -16,4 +16,4 @@ Pricing is based on the database software distribution and the number of Virtual All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) ## Cloud Infrastructure Costs -EDB does not bill you for cloud infrastructure such as compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run out of your Microsoft Azure account, so Azure will handle billing for cloud infrastructure used. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) +EDB does not bill you for cloud infrastructure such as compute, storage, data transfer, monitoring, and logging. EDB Cloud clusters run in your Microsoft Azure account. Azure bills you directly for the cloud infrastructure provisioned according to the terms of your account agreement. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) From c60318416522e0c463aca88c7119bb5a65899055 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 10 Aug 2021 10:36:21 -0400 Subject: [PATCH 242/317] Incorporated comments from Jozef from UPM-914 Notes in the ticket Former-commit-id: b5edb49e6c2c950f6d7704081dec89de69c4f08e --- .../01_connect_cloud_account.mdx | 41 ++++--------------- .../01a_check_resource_limits.mdx | 29 +++++++++++++ 2 files changed, 37 insertions(+), 33 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 627a6010b70..16cebe5619e 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -6,53 +6,28 @@ This topic describes how to set up your EDB Cloud account on Azure Marketplace. ## Before You Connect Your Cloud Account -Ensure you have an active Microsoft Azure subscription. Refer to these [instructions](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription) if you need to create a Azure subscription. +1. Ensure you have an active Microsoft Azure subscription. Refer to these [instructions](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription) if you need to create a Azure subscription. -Check that your subscription allows for a sufficient number of vCPU cores and a sufficient number of Public IP Addresses. See [Azure Resource Limits](#increase-azure-resource-limits). +1. Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure Active Directory (AD). -Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure Active Directory (AD). See [Azure AD Application](#create-azure-ad-application). -### Check Azure Resource Limits - -By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. - -The default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. You need to increase this limit to at least 50 virtual machines per region. EDB Cloud uses ESv3 Series virtual machines. - -The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to `Public IP Addresses Basic` and `Public IP Addresses Standards` is set to 10. You need to increase the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud Postgres clusters. - -To check the current Azure limits for virtual machines and public IP addresses: - -1. In the Azure Portal, select **Subscription**. -2. Select **Settings** > **Usage + quotas**. -1. Search for vCPU to view virtual machines limits. -1. Search for Public IP to view networks limits. - -If your role is Owner, Contributor, or [Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) for your Azure account, you can send requests to increase those limits. Please ensure that the *Default subscription filter* is updated for the expected *subscription id*. - -Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: - -```sh -Request Summary / New Limit: -Resource Manager, EASTUS, ESv3 Series / 50 -Resource Manager, UKSOUTH, ESv3 Series / 50 -``` - -To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). ### Create Azure Active Directory Application +!!! Note + Create your Azure AD application in the same tenant as the subscription you want it associated with.  + To create an Azure Active Directory (AD) Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). Take note of the **Application (client) ID**, you need it to configure your EDB cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. +1. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) Take note of the Azure AD App Secret, you need it to configure your cloud account. +1. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. + -2. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. -3. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) Take note of the Azure AD App Secret, you need it to configure your cloud account. -!!! Note - You have to ensure the Azure AD App ID and Azure Subscription ID are for the same Azure AD tenant. diff --git a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx new file mode 100644 index 00000000000..886146f62b1 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx @@ -0,0 +1,29 @@ +--- +title: Checking Your Azure Resource Limits +--- + +By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. + +The default [Azure Virtual Machine limit per region](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) is set to 20. You need to increase this limit to at least 50 virtual machines per region. EDB Cloud uses ESv3 Series virtual machines. + +The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) to Public IP Addresses Basic and Public IP Addresses Standards is set to 10. You need to increase the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to 100 for the regions where you plan to deploy your EDB Cloud Postgres clusters. + +To check the current Azure limits for virtual machines and public IP addresses: + +1. In the Azure Portal, select **Subscription**. +1. Select your specific subscription. +2. Select Settings > **Usage + quotas**. +1. Search for ESv3 vCPU to view virtual machines limits. +1. Search for Public IP to view networks limits. + +If your role is [Owner](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#owner), [Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#contributor), or [Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) for your Azure account, you can send requests to increase those limits. Please ensure that the *Default subscription filter* is updated for the expected *subscription id*. + +Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: + +```sh +Request Summary / New Limit: +Resource Manager, EASTUS, ESv3 Series / 50 +Resource Manager, UKSOUTH, ESv3 Series / 50 +``` + +To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). \ No newline at end of file From 80af01324acabb30de1ae6281cbe2f2f37d33408 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 13:20:23 -0400 Subject: [PATCH 243/317] Quoted search string Former-commit-id: b07edf01be6244edab0f4f4aa13b13533e3f6b9d --- .../beta/getting_started/01a_check_resource_limits.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx index 886146f62b1..a4246a0f175 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx @@ -13,7 +13,7 @@ To check the current Azure limits for virtual machines and public IP addresses: 1. In the Azure Portal, select **Subscription**. 1. Select your specific subscription. 2. Select Settings > **Usage + quotas**. -1. Search for ESv3 vCPU to view virtual machines limits. +1. Search for "ESv3 vCPU" to view virtual machines limits. 1. Search for Public IP to view networks limits. If your role is [Owner](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#owner), [Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#contributor), or [Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) for your Azure account, you can send requests to increase those limits. Please ensure that the *Default subscription filter* is updated for the expected *subscription id*. @@ -26,4 +26,4 @@ Resource Manager, EASTUS, ESv3 Series / 50 Resource Manager, UKSOUTH, ESv3 Series / 50 ``` -To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). \ No newline at end of file +To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). From fb1a0ce11dace4dd9961a026e584d164c4d579fc Mon Sep 17 00:00:00 2001 From: theadamwright Date: Tue, 10 Aug 2021 13:45:34 -0400 Subject: [PATCH 244/317] Update 04_responsibility_model.mdx Minor changes. Remove SOC2 compliance for now and wording updates for consistency. Former-commit-id: 02f7beae1afa36b5b35ba78c67c07069c06fba10 --- .../beta/overview/04_responsibility_model.mdx | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index 2f881372f99..dced00b10ae 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -14,13 +14,13 @@ The following Responsibility Model describes the distribution of specific respon | Task | EDB Responsibility | Your Responsibility | | ----- | ------------------------- | ------------------------ | -| **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary | Yes | No | -| **Database service availability:** customers can connect to a database cluster and read / write data | Yes | Yes | -| **Planning database schema:** database query performance is acceptable for the customer's business needs. | No | Yes | +| **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary. | Yes | No | +| **Database service availability:** customers can connect to a database cluster and read / write data. | Yes | Yes | +| **Planning database performance:** data modeling and query performance that meets your business needs. | No | Yes | | **Database cluster capacity planning:** the database clusters deployed on the platform are allocated sufficient resources (CPU/RAM/disk) to achieve acceptable performance. Disk space is monitored for exhaustion. | No | Yes | -| **Database cluster backups:** database clusters are configured to back up data at intervals that meet the customer's recovery point objective. | No | Yes | +| **Database cluster backups:** database clusters are configured to back up data at intervals that meet your recovery point objective. | No | Yes | | **Database cluster backups:** data in database clusters is backed up and made available for restore in a timely manner consistent with the configuration of the database cluster. | Yes | No | -| **Database cluster backups:** database backups can be restored in a timely fashion consistent with the customer's recovery time objective. | No | Yes | +| **Database cluster backups:** database backups can be restored in a timely fashion consistent with your recovery time objective. | No | Yes | @@ -31,9 +31,8 @@ The following Responsibility Model describes the distribution of specific respon | Task | EDB Responsibility | Your Responsibility | | ----- | ------------------------- | ------------------------ | -| **SOC2 Audit Compliance** | Yes | No | | **Database cluster credential management:** credentials for database clusters are kept secret and rotated as appropriate. | Yes | Yes | -| **Encryption of customer data at-rest:** Data stored in database clusters is encrypted appropriately. | Configuring encryption with appropriate keys | Only in "bring your own key" configurations | +| **Encryption of customer data at-rest:** Data stored in database clusters is encrypted appropriately. | Configuring encryption with appropriate keys | No | | **Vulnerability management:** operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. | Yes | No | | **Vulnerability management:** database software is kept up-to-date in accordance with policy. | Yes | No | | **Network security:** firewalls are configured to appropriately restrict east / west network traffic. | Yes | No | From 1b0a060dccb2089948af7c5778db29337542b310 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 10 Aug 2021 14:24:01 -0400 Subject: [PATCH 245/317] added product icon Former-commit-id: 4e21efab3952dce42cd0711464e63ec8270ac683 --- product_docs/docs/edbcloud/beta/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index d3584748c26..ff78620a0c3 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -3,6 +3,7 @@ title: EDB Cloud description: "EDB Cloud: DBaaS for PostgresSQL " indexCards: simple directoryDefaults: + iconName: clouddb navigation: - overview - getting_started From bc916763436f8e8954db5a3aa481948faa9874e4 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 14:49:23 -0400 Subject: [PATCH 246/317] Updated footnote Former-commit-id: ea9d09ccbdd634b80372073f58e38463bfb1e3c2 --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 77c050865a4..6104d930a05 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -10,7 +10,7 @@ Pricing is based on the number of Virtual Central Processing Units (vCPUs) provi | PostgreSQL | $0.1655 / vCPU | $120.82 / vCPU | | EDB Postgres Advanced Server | $0.2397 / vCPU | $174.98 / vCPU | -*The monthly cost is approximate and assumes 730 hours in a month. +*The monthly cost is approximate and assumes 730 hours in a month. Microsoft bills on actual hours in a given month. ## Billing All billing is handled directly by Microsoft Azure. Invoices and usage can be viewed on the Azure Portal billing page. [Learn more](https://docs.microsoft.com/en-us/azure/cost-management-billing/) From a261ba8e5f9898ae99aed1d2c7b52b446b4a34f8 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 15:51:20 -0400 Subject: [PATCH 247/317] Changed how we introduce the AD short name Former-commit-id: fccb0f4398f0ee9a5cef829f810f986231ba985e --- .../beta/getting_started/01_connect_cloud_account.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index 16cebe5619e..bda22c0f683 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -15,9 +15,9 @@ This topic describes how to set up your EDB Cloud account on Azure Marketplace. ### Create Azure Active Directory Application !!! Note - Create your Azure AD application in the same tenant as the subscription you want it associated with.  + Create your Azure AD Application in the same tenant as the subscription you want it associated with.  -To create an Azure Active Directory (AD) Application: +To create an Azure AD Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). Take note of the **Application (client) ID**, you need it to configure your EDB cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. From 0040894c2c76cb74d7188686cdff9c0177e19562 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 16:14:37 -0400 Subject: [PATCH 248/317] Added info on managing quotas through the UI Former-commit-id: d8621fa0f5224d99064c99a25543b9eef67a4073 --- .../beta/getting_started/01a_check_resource_limits.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx index a4246a0f175..f61551eb332 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx @@ -13,9 +13,10 @@ To check the current Azure limits for virtual machines and public IP addresses: 1. In the Azure Portal, select **Subscription**. 1. Select your specific subscription. 2. Select Settings > **Usage + quotas**. -1. Search for "ESv3 vCPU" to view virtual machines limits. +1. Search for "ESv3" to view virtual machines limits. 1. Search for Public IP to view networks limits. + If your role is [Owner](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#owner), [Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#contributor), or [Support Request Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#support-request-contributor) for your Azure account, you can send requests to increase those limits. Please ensure that the *Default subscription filter* is updated for the expected *subscription id*. Follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-requests#request-a-standard-quota-increase-from-help--support) to increase your ESv3 Series virtual machines limits for the regions where you are planning to deploy your EDB Cloud Postgres clusters. This is an example of a request to increase virtual machines limits: @@ -27,3 +28,5 @@ Resource Manager, UKSOUTH, ESv3 Series / 50 ``` To make requests to increase Azure Networking Limits follow [these instructions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support). + +If you have subscription-level permissions, you can use [these instructions](https://docs.microsoft.com/en-us/azure/machine-learning/how-to-manage-quotas) to directly manage your Azure quotas. From 6a52f2b4a3c00144da92c20884e4cd09c9e3e069 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 10 Aug 2021 16:38:14 -0400 Subject: [PATCH 249/317] Added note re checking resources and adjusted list spacing Former-commit-id: 9f516701fddc1900811b6028398898f6a6f19955 --- .../beta/getting_started/01_connect_cloud_account.mdx | 5 +++++ .../beta/getting_started/01a_check_resource_limits.mdx | 1 + .../docs/edbcloud/beta/getting_started/02_create_cluster.mdx | 5 +++++ 3 files changed, 11 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx index bda22c0f683..be3b87aedcf 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx @@ -21,6 +21,7 @@ To create an Azure AD Application: 1. Register an application with Azure AD and create a service principal using [these instructions](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal). Take note of the **Application (client) ID**, you need it to configure your EDB cloud account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure. + 1. Choose _application secret_ as an authentication option for the application. [Create a new Azure AD application secret. ](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) Take note of the Azure AD App Secret, you need it to configure your cloud account. 1. Assign _Owner_ role to the application as described [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application). Enter the **Display name** of the Azure AD application in the **Select** field of the [**Add role assignment** panel](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) panel. @@ -38,21 +39,25 @@ To connect your cloud account with your Azure subscription: #### 1. Select the EDB offer in the Azure portal. 1. Sign in to Azure portal [portal.azure.com](https://portal.azure.com/) and go to Azure **Marketplace**. + 2. Find an offer from **EnterpriseDB Corporation** and select it. 3. Select an available plan from the **Select Plan** drop-down list. 4. Select **Set up + subscribe**. #### 2. Fill out the details for your plan. 1. In the **Project details** section, enter or create a [**Resource Group**](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for your subscription. + 2. In the **SaaS details** section, enter the SaaS subscription name. 3. Select **Review + subscribe**. #### 3. Accept term of use. 1. Review the terms of use provided by EDB. + 2. Select **Subscribe**. #### 4. Configure your account. 1. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application. + 2. Fill in the following parameters in the form: | Parameter | Description | diff --git a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx index f61551eb332..773e5b37041 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx @@ -11,6 +11,7 @@ The default [Public IP address limits](https://docs.microsoft.com/en-us/azure/az To check the current Azure limits for virtual machines and public IP addresses: 1. In the Azure Portal, select **Subscription**. + 1. Select your specific subscription. 2. Select Settings > **Usage + quotas**. 1. Search for "ESv3" to view virtual machines limits. diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx index 8ce821ed211..6183abb593d 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx @@ -1,6 +1,11 @@ --- title: "Creating a Cluster" --- +!!! Note +Prior to creating your cluster, make sure you have adequate Azure resources. See [Checking Your Azure Resource Limits](../getting_started/01a_check_resource_limits/). +!!! + + To create a cluster: 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal. From 28366faef5c15665a44da0275738ee5ea993783a Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 10 Aug 2021 16:57:16 -0400 Subject: [PATCH 250/317] added intro text to section topics Former-commit-id: 2b8d1cd59517e98aa05d0a5760cdafc2d271895d --- product_docs/docs/edbcloud/beta/getting_started/index.mdx | 1 + product_docs/docs/edbcloud/beta/using_cluster/index.mdx | 2 ++ 2 files changed, 3 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 7cb5d7936c7..620144e8ce2 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -4,6 +4,7 @@ indexCards: simple description: "Configure your account and create a Postgres cluster" --- +With EDB Cloud, you can easily set up, manage, and scale your Postgres databases. To get started, learn how to connect your cloud and create a cluster as an account owner.
diff --git a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx index bd2adda4a72..ae379c26dd1 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx @@ -2,4 +2,6 @@ title: "Using Your Cluster" --- +In this section, account owners and contributors can learn how to connect, edit, scale, and monitor clusters through the EDB Cloud portal. This section also provides information on how EDB Cloud handles backup and restore. + From cb4f72eccb8d808293ed54ffd0c28d3b950efaa1 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 10 Aug 2021 17:08:29 -0400 Subject: [PATCH 251/317] Update index.mdx Former-commit-id: 58eb5103c4bdf7a9b3ba9093236a7b44b246168f --- product_docs/docs/edbcloud/beta/administering_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx index bbeb3dfdc5f..51ad8586040 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx @@ -2,4 +2,4 @@ title: "Administering Your Account" --- - +In this section, account owners can find information on EDB Cloud organization management including user access management, the user activity log, and security and networking protocols. From cc46bad8dbc0e185d21bdeeb1e1f393463cbf850 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 10 Aug 2021 21:02:02 -0400 Subject: [PATCH 252/317] reodered files to put azure resource limits first Former-commit-id: 592caf8491d0e400139e87a1a8daf78533eb9dee --- ...check_resource_limits.mdx => 01_check_resource_limits.mdx} | 0 ...connect_cloud_account.mdx => 02_connect_cloud_account.mdx} | 0 .../{02_create_cluster.mdx => 03_create_cluster.mdx} | 0 .../edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx | 4 ---- 4 files changed, 4 deletions(-) rename product_docs/docs/edbcloud/beta/getting_started/{01a_check_resource_limits.mdx => 01_check_resource_limits.mdx} (100%) rename product_docs/docs/edbcloud/beta/getting_started/{01_connect_cloud_account.mdx => 02_connect_cloud_account.mdx} (100%) rename product_docs/docs/edbcloud/beta/getting_started/{02_create_cluster.mdx => 03_create_cluster.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/01a_check_resource_limits.mdx rename to product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx b/product_docs/docs/edbcloud/beta/getting_started/02_connect_cloud_account.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/01_connect_cloud_account.mdx rename to product_docs/docs/edbcloud/beta/getting_started/02_connect_cloud_account.mdx diff --git a/product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx b/product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/getting_started/02_create_cluster.mdx rename to product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 11c589ee234..5fbcb46b9e5 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -2,10 +2,6 @@ title: "Monitoring and Logging" --- - -- Azure dashboards??? -- link to the Azure docs for the logging service - ## Accessing Logs and Metrics When EDB Cloud deploys workloads on Azure, the workloads applications logs are forwarded to Azure Log Workspace resource. From 5f1e4cb4e1c5bc841a2b7995d9d5d8604afa7b6e Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 10 Aug 2021 22:36:27 -0400 Subject: [PATCH 253/317] monitoring and logging Former-commit-id: e7c0cd77ba769488a0c08caea989bf47306d8838 --- .../05_monitoring_and_logging.mdx | 30 +++++++++---------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 5fbcb46b9e5..09925778bbd 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -2,31 +2,29 @@ title: "Monitoring and Logging" --- -## Accessing Logs and Metrics +## Azure Log Analytics -When EDB Cloud deploys workloads on Azure, the workloads applications logs are forwarded to Azure Log Workspace resource. +When EDB Cloud deploys workloads on Azure, the workloads applications logs are forwarded to Azure Log Workspace. +To query EDB Cloud Logs you need to use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). -## Query Log Workspace Tables -To query log workspace content, go to the Logs menu then you will see 3 tables Groups - - **ContainerInsights :** Azure native collected Kubernetes logs and metrics, (contains duplicates of some Kube state metrics in Kube* tables) +## Customer Log Analytics Workspace -- **LogManagement :** Azure native collected logs and metrics around azure resources -- **Custom Logs :** Tables created by the fluentbit containing : + All logs from your PostgreSQL clusters are stored in _Customer Log Analytic workspace_. To find your _Customer Log Analytics workspace_ workspace do the following: - - our components forwarded logs +1. Log in to Azure Portal +2. Select Resource Groups section - - others specifics Azure resources forwarded logs +2. Select the Resource Group corresponding to the region where you choose to deploy your EDB Cloud. You will see resources included in theat Resource Group -### EDB Container logs -To query the EDB components logs just write this kind of KQL Query from the desired table. +3. Select the resource of type _Log Analytics workspace_ with the suffix -customer -For example, we obtain here the K8S namespace upm-api-provisioning container logs from table MicroservicesLogs_CL. - -### Prometheus metrics - -To query the Prometheus collected metrics (from omsagent) just write this kind of KQL Query from the InsightsMetrics table in the Namespace field called prometheus. +4. Select the Log in the menu on the left +| Table Name | Description | +| --- | --- | +| PostgresLogs_CL | Logs of the Customer clusters databases (all postgres related logs) `logger = postgres` | +| PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases `logger = pgaudit or edb_audit` | From 5b5785eff8c14f1fff534ac73569b740872d139c Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 10 Aug 2021 22:50:52 -0400 Subject: [PATCH 254/317] monitoring and logging 2 Former-commit-id: 0f6f8a387348f3c1789af62cd44fd3b60e54d10f --- .../beta/using_cluster/05_monitoring_and_logging.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 09925778bbd..7c28cc6b298 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -23,8 +23,13 @@ To query EDB Cloud Logs you need to use [Azure Log Analytics](https://docs.micr 4. Select the Log in the menu on the left +5. Close the dashboard with prebuild queries. This will bring you to KQL Editor. + +The following two tables are available in _Customer Log Analytic workspace_. | Table Name | Description | | --- | --- | | PostgresLogs_CL | Logs of the Customer clusters databases (all postgres related logs) `logger = postgres` | | PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases `logger = pgaudit or edb_audit` | + +You can use KQL Query editor to compose your queries. From 7b9e9ffd204e4b2789ccd77e5c15f4025356a3ea Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 10 Aug 2021 23:31:06 -0400 Subject: [PATCH 255/317] monitoring and logging 3 Former-commit-id: 0533c2455b33bc53b7a18f4494b8175425d0853a --- .../05_monitoring_and_logging.mdx | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 7c28cc6b298..338577c4f3d 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -4,32 +4,33 @@ title: "Monitoring and Logging" ## Azure Log Analytics -When EDB Cloud deploys workloads on Azure, the workloads applications logs are forwarded to Azure Log Workspace. -To query EDB Cloud Logs you need to use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). +When EDB Cloud deploys workloads on Azure, the logs from the PostgreSQL clusters are forwarded to the Azure Log Workspace. +To query EDB Cloud Logs, you must use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). ## Customer Log Analytics Workspace - All logs from your PostgreSQL clusters are stored in _Customer Log Analytic workspace_. To find your _Customer Log Analytics workspace_ workspace do the following: +All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics workspace_. To find your _Customer Log Analytics workspace_, do the following: -1. Log in to Azure Portal -2. Select Resource Groups section +1. Log in to the Azure Portal. -2. Select the Resource Group corresponding to the region where you choose to deploy your EDB Cloud. You will see resources included in theat Resource Group +2. Select the Resource Groups section. -3. Select the resource of type _Log Analytics workspace_ with the suffix -customer +2. Select the Resource Group corresponding to the region where you choose to deploy your EDB Cloud. You will see resources included in that Resource Group. -4. Select the Log in the menu on the left +3. Select the resource of type _Log Analytics workspace_ with the suffix -customer. -5. Close the dashboard with prebuild queries. This will bring you to KQL Editor. +4. Select the Logs in the menu on the left in the General section. -The following two tables are available in _Customer Log Analytic workspace_. +5. Close the dashboard with prebuilt queries. This will bring you to the KQL Editor. + +The following two tables are available in the _Customer Log Analytic workspace_. | Table Name | Description | | --- | --- | | PostgresLogs_CL | Logs of the Customer clusters databases (all postgres related logs) `logger = postgres` | | PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases `logger = pgaudit or edb_audit` | -You can use KQL Query editor to compose your queries. +You can use the KQL Query editor to compose your queries over these tables. From 3fa7d7ff06a4c6ec5b5d9f94cbe9c028f27f640f Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 05:59:30 -0400 Subject: [PATCH 256/317] Update 03_modify_and_scale_cluster.mdx Former-commit-id: 912c04ba1ea89dc6fe260d51dbbe393e93cfe100 --- .../beta/using_cluster/03_modify_and_scale_cluster.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx index 7aa8cd508cb..bd8156601fb 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx @@ -20,5 +20,5 @@ title: "Modifying and Scaling Clusters" 5. Select **Save** to save your changes. 6. Select **Confirm Changes**. - !!! - Note: Saving changes may require a database restart. +!!! Note + Saving changes may require a database restart. From d6358ee1fdfbebec9d27f73df505bb8ec1d3cbf0 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 11 Aug 2021 05:00:51 -0700 Subject: [PATCH 257/317] Update 05_database_version_policy.mdx Former-commit-id: a959a2f7436680266f7e8d0f2e4bfcdee43a5110 --- .../beta/overview/05_database_version_policy.mdx | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx index 8eb7e26b179..3b09d206ba1 100644 --- a/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx +++ b/product_docs/docs/edbcloud/beta/overview/05_database_version_policy.mdx @@ -5,21 +5,16 @@ title: "Database Version Policy" ## Supported Postgres Types and Versions -| **Postgres Type** | **Major Version** | +| **Postgres Type** | **Major Versions** | | ----- | ------------------------- | -| PostgreSQL | 13 | -| PostgreSQL | 12 | -| PostgreSQL | 11 | -| EDB Postgres Advanced Server | 13 | -| EDB Postgres Advanced Server | 12 | -| EDB Postgres Advanced Server | 11 | +| PostgreSQL | 11 - 13 | +| EDB Postgres Advanced Server | 11 - 13 | -## Major Version Support -PostgreSQL major versions are supported from the date they are made available until the version is retired from the PostgreSQL community. See [Platform Compatibility](https://www.enterprisedb.com/product-compatibility#pg) for more details. +## Major Version Support -EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB. See [Platform Compatibility ](https://www.enterprisedb.com/product-compatibility#epas) for more details. +PostgreSQL and EDB Postgres Advanced Server major versions are supported from the date they are made available until the version is retired by EDB (generally 5 years). See [Platform Compatibility ](https://www.enterprisedb.com/product-compatibility#epas) for more details. From cc948592ea694ddb7c8fb6e6a8f90c3c34cae570 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 11 Aug 2021 05:15:04 -0700 Subject: [PATCH 258/317] Create 01_user_access.mdx Former-commit-id: e48f63e5b01ee8fc38a767e638f7599ea2a2c813 --- .../docs/edbcloud/beta/administering_cluster/01_user_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 53758aa50af..550ba47d215 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -44,7 +44,7 @@ The following are the default permission by role: | | update | x | | x | | | | x | | | | | delete | x | | x | | | | x | | | | reader | create | | | | | | | | | | -| | read | x | x | x | | x | x | x | x | x | +| | read | x | x | x | x | x | x | x | x | x | | | update | | | | | | | | | | | | delete | | | | | | | | | | From a3448720ac01549fd586b875fd0036c49ef2810a Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 11 Aug 2021 05:49:41 -0700 Subject: [PATCH 259/317] Update index.mdx Former-commit-id: 07f3201e05485e7333ad3b3a4669992d8709483c --- product_docs/docs/edbcloud/beta/getting_started/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 620144e8ce2..816385a7e58 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -4,7 +4,7 @@ indexCards: simple description: "Configure your account and create a Postgres cluster" --- -With EDB Cloud, you can easily set up, manage, and scale your Postgres databases. To get started, learn how to connect your cloud and create a cluster as an account owner. +In this section, Azure subscription administrators can learn how to initially set up their EDB Cloud account, invite others to join them in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin.
From b68d63e89dcc4d3d1e73b8ef9a851484e9df1e41 Mon Sep 17 00:00:00 2001 From: amrita-suresh <33535573+amrita-suresh@users.noreply.github.com> Date: Wed, 11 Aug 2021 09:12:31 -0400 Subject: [PATCH 260/317] Update index.mdx Former-commit-id: 687ad50d7a8d8c47f78659b4cb83d1d3dc61fb28 --- product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx index 6104d930a05..a79e94d3b83 100644 --- a/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx +++ b/product_docs/docs/edbcloud/beta/pricing_and_billing/index.mdx @@ -2,6 +2,8 @@ title: "Pricing and Billing " --- +This section covers the pricing breakdown for EDB Cloud as well as how to view invoices and infrastructure usage through Microsoft Azure. + ## Pricing Pricing is based on the number of Virtual Central Processing Units (vCPUs) provisioned for the database software offering. Consumption of vCPUs is metered hourly. A deployment is comprised of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, the number of vCPU per instance should be multiplied by three to calculate the full price for all resources used. See the full cost breakdown below: From 7bbea3946f0c721ede567a1da06eeaf787f21c37 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 11 Aug 2021 09:28:36 -0400 Subject: [PATCH 261/317] misc changes Initial review of activity log Changed title of resource limits set navigation for getting started Former-commit-id: 9cf4fd93ee1179c296ae7eda65443b1694b285a6 --- .../administering_cluster/02_activity_log.mdx | 22 +++++++++---------- .../01_check_resource_limits.mdx | 2 +- .../edbcloud/beta/getting_started/index.mdx | 5 +++++ 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx index 4bb0180ab43..506e2c88316 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx @@ -1,27 +1,27 @@ --- -title: "Using Activity Log" +title: "Using the Activity Log" --- -Activity Log collects **EDB Cloud events**. It can be used to audit activities performed by users from your organizations. +The activity log collects **EDB Cloud events**. It can be used to audit activities performed by users from your organizations. -**EDB Cloud Events** describe actions performed by EDB Cloud Users over EDB Cloud Resources. The available actions are: -* _Create _ -* _Read _ -* _Update _ +**EDB Cloud Events** describe actions performed by EDB Cloud users on EDB cloud resources. The available actions are: +* _Create_ +* _Read_ +* _Update_ * _Delete_ -EDB Cloud collects events related to the following Resource Types: +EDB Cloud collects events related to the following resource types: * _Database_ * _User_ * _User Roles_ * _Role Permissions_ * _Organization_ -To view the Activity Log table, navigate to Activity Log. +To view the activity log table, navigate to activity log. !!! Note - To view Activity Log, you need to have the role _owner_ or have the _read:event_ permission. + To view the activity log, you need to have the role _owner_ or have the _read:event_ permission. - The Activity Log table has the following fields: + The activity log table has the following fields: | Field | Description | | ---------------------| ---------------------------------------------------------------------------- | @@ -32,7 +32,7 @@ To view the Activity Log table, navigate to Activity Log. -To search the Activity Log table, use the filters at the top of the page. +To search the activity log table, use the filters at the top of the page. diff --git a/product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx b/product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx index 773e5b37041..075ba48c8c6 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/01_check_resource_limits.mdx @@ -1,5 +1,5 @@ --- -title: Checking Your Azure Resource Limits +title: Checking Azure Resource Limits --- By default, Azure sets a very low limit on the number of virtual machines per region and on the number of Public IP Addresses per region that are available in a given subscription. diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 620144e8ce2..9843af13a63 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -2,6 +2,11 @@ title: "Getting Started" indexCards: simple description: "Configure your account and create a Postgres cluster" +navigation: +02_connect_cloud_account +01_check_resource_limits +03_create_cluster + --- With EDB Cloud, you can easily set up, manage, and scale your Postgres databases. To get started, learn how to connect your cloud and create a cluster as an account owner. From 7d029f96690693cbbf1b6e4cbe43d4380bddf277 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Wed, 11 Aug 2021 10:10:22 -0400 Subject: [PATCH 262/317] Update 02_high_availibility.mdx Breaking up the two Supported Architectures: High Availability - {Enabled,Not Enabled} Former-commit-id: 5da7c430f868a7fc4db9f34b3803a08d5989d88c --- .../beta/overview/02_high_availibility.mdx | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx index dd62e66d5d6..1bfebcc46da 100644 --- a/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx +++ b/product_docs/docs/edbcloud/beta/overview/02_high_availibility.mdx @@ -1,8 +1,12 @@ --- -title: "High Availability" +title: "Supported Architectures" --- -EDB provides a high availability option to minimize downtime in case of failures. High Availability clusters are configured automatically with - one _primary_ and two _replicas_ - with replicas staying up-to-date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across multiple availability zones to provide fault tolerance in the face of a datacenter failure +EDB Cloud enables deploying a cluster with or without High Availability. The option is presented as a High Availablity on/off toggle button on the Create Cluster page in the EDB Cloud Portal. To view your cluster's current High Availability setting, navigate to your Cluster from the Clusters page in the EDB Cloud Portal and view whether High Availability is listed as Enabled or Not Enabled under Cluster Info. To modify the High Availability setting of a cluster, click on the Edit cluster button on the Cluster Info section of your cluster. From there, the High Availability toggle can be switched on/off. + +## High Availability - Enabled + +The high availability option is provided to minimize downtime in cases of failures. High Availability clusters are configured automatically with - one _primary_ and two _replicas_ - with replicas staying up-to-date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across multiple availability zones to provide fault tolerance in the face of a datacenter failure * Replicas are usually called _standby servers_ and can also be used for read-only workloads. @@ -14,4 +18,10 @@ Incoming client connections are always routed to the current primary. In case of By default, one replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit - in PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. This behavior can be modified on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. +## High Availability - Not Enabled + +For non-production use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one _primary_ with no _standby servers_ for failover or read-only workloads. + +* In case of permanent unavailability of the primary, a restore from a backup is required. + From c82ac17df0250f0eaed6927f1ddb0b8b820663fa Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 11 Aug 2021 10:31:53 -0400 Subject: [PATCH 263/317] incorporated comments from Kelly on various topics renamed Managing User Access to Managing Portal Access Fixed capitalization issue in Monitoring Logs Added headings to activity logs Former-commit-id: ba0e551261b8a88380dc09cb35053fe15e2bbcab --- .../beta/administering_cluster/01_user_access.mdx | 2 +- .../beta/administering_cluster/02_activity_log.mdx | 9 +++++---- .../beta/using_cluster/05_monitoring_and_logging.mdx | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 53758aa50af..7ab99263dc7 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -1,5 +1,5 @@ --- -title: "Managing User Access" +title: "Managing Portal Access" --- EDB Cloud uses Azure Active Directory to authenticate users and role based access controls to grant users access to different parts of the application. diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx index 506e2c88316..839f28f0bdc 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx @@ -3,6 +3,7 @@ title: "Using the Activity Log" --- The activity log collects **EDB Cloud events**. It can be used to audit activities performed by users from your organizations. +## Cloud Events **EDB Cloud Events** describe actions performed by EDB Cloud users on EDB cloud resources. The available actions are: * _Create_ * _Read_ @@ -16,12 +17,14 @@ EDB Cloud collects events related to the following resource types: * _Role Permissions_ * _Organization_ -To view the activity log table, navigate to activity log. +## Viewing and Searching the Activity Log Table !!! Note To view the activity log, you need to have the role _owner_ or have the _read:event_ permission. + +To view the activity log table, navigate to the activity log. To search the activity log table, use the filters at the top of the page. - The activity log table has the following fields: +The activity log table has the following fields: | Field | Description | | ---------------------| ---------------------------------------------------------------------------- | @@ -32,8 +35,6 @@ To view the activity log table, navigate to activity log. -To search the activity log table, use the filters at the top of the page. - diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 338577c4f3d..25d1037f647 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -5,7 +5,7 @@ title: "Monitoring and Logging" ## Azure Log Analytics When EDB Cloud deploys workloads on Azure, the logs from the PostgreSQL clusters are forwarded to the Azure Log Workspace. -To query EDB Cloud Logs, you must use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). +To query EDB Cloud logs, you must use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). From 4d59097ee40b0dceb21f703329a7221aa04aa5d9 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 10:36:29 -0400 Subject: [PATCH 264/317] Fixed list spacing Former-commit-id: 649addc085861f326403681813510eb7d1d4db46 --- .../beta/administering_cluster/01_user_access.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx index 7ab99263dc7..97b09987ef7 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx @@ -53,12 +53,14 @@ The following are the default permission by role: To edit roles: 1. Navigate to Admin > Roles. -2. Select the edit icon for the role in the list. + +3. Select the edit icon for the role in the list. #### Changing Role Name To change the name or description of the role: 1. Select the **Settings** tab. + 2. Edit **Name** or **Description**. 3. Press **Save**. @@ -66,6 +68,7 @@ To change the name or description of the role: To change permissions associated with the role: 1. Select **Permissions** tab. + 2. Select the **Change Permissions** button on the top right. 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** @@ -80,6 +83,7 @@ When you configured your Azure subscription, you also enabled EDB Cloud to authe ### Assigning Roles to Users To assign appropriate roles to users: 1. Navigate to Admin > Users. + 2. Select the edit icon for the user. 3. Select **Assign Roles**. 4. Select or deselect roles for the user. @@ -93,11 +97,13 @@ To assign appropriate roles to users: To view all users from your organization that have logged in at least once: 1. Navigate to Admin > Users. + 2. View the list of users sorted by most recent log in. ## Example Scenario 1. The EDB Cloud organization is created, and Tom logs in and is granted the **owner** role. + 1. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created. 1. Tom grants Sally the **contributor** role. Sally logs out and back in, and she can now create EDB Cloud clusters. 1. Sally asks Jerry to log in, and grants him the **reader** role. From 0438e0a8306f2c83a17336374d92b84b77da9ee2 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 10:43:13 -0400 Subject: [PATCH 265/317] Fixed nav issue with Getting Started index Former-commit-id: 86e5f43ffb657537d5968cf64fb0020411374b45 --- product_docs/docs/edbcloud/beta/getting_started/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 06d83e41b93..2ee2396eea3 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -3,9 +3,9 @@ title: "Getting Started" indexCards: simple description: "Configure your account and create a Postgres cluster" navigation: -02_connect_cloud_account -01_check_resource_limits -03_create_cluster + - 02_connect_cloud_account + - 01_check_resource_limits + - 03_create_cluster --- From c53fe22d3bec5ee920ee1e23482dbd46bfaf36c2 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 10:58:10 -0400 Subject: [PATCH 266/317] Minor changes to Security topic Former-commit-id: 92cf178c1a1e502192d3400900a358b8ea185415 --- product_docs/docs/edbcloud/beta/overview/03_security.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/03_security.mdx b/product_docs/docs/edbcloud/beta/overview/03_security.mdx index 908988f1339..751e4a8d99e 100644 --- a/product_docs/docs/edbcloud/beta/overview/03_security.mdx +++ b/product_docs/docs/edbcloud/beta/overview/03_security.mdx @@ -4,9 +4,10 @@ title: "Security" EDB's cloud offering runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are: - **Data Isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another EDB Cloud customer's systems does not put your data at risk. -- **Granular Access Control:** You can use Single Sign On (SSO) and define your own sets of roles and Role Based Access Control (RBAC) policies to manage your individual cloud environments. See [Managing User Access](../administering_cluster/01_user_access) for more information. + +- **Granular Access Control:** You can use Single Sign On (SSO) and define your own sets of roles and Role Based Access Control (RBAC) policies to manage your individual cloud environments. See [Managing Portal Access](../administering_cluster/01_user_access) for more information. - **Data Encryption:** All data in EDB Cloud is encrypted in motion and at rest. Network traffic is encrypted using Transport Layer Security (TLS) v1.2 or greater, where applicable, and EDB Cloud Postgres instances do not accept insecure connections. Data at rest is encrypted using AES with 256 bit keys. Data encryption keys are envelope encrypted and the wrapped data encryption keys are securely stored in an Azure Key Vault instance in your account. Encryption keys never leave your environment. -- **Portal Audit Logging:** Activities in the portal, such as those related to user roles, organization updates, and cluster creation and deletion are tracked automatically and viewed in the Activity Log. +- **Portal Audit Logging:** Activities in the portal, such as those related to user roles, organization updates, and cluster creation and deletion are tracked automatically and viewed in the activity log. - **Database Logging and Auditing:** Functionality to track and analyze database activities is enabled automatically. For PostgreSQL, the PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced Server, the EDB Audit extension (edbAudit) is enabled automatically for you. - **pgAudit:** The classes of statements being logged for pgAudit are set globally on a cluster with `pgaudit.log = 'write,ddl'`. The following statements made on tables will be logged by default when the cluster type is PostgreSQL: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, AND `COPY`. All `DDL` will be logged. - **Database Cluster Permissions** The `edb_admin` account created during the _Create Cluster_ process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the `edb_admin` account to create a new application user and new application database for further isolation. From 7553524e0b64c0aa5d66392a95c7ac22b4408231 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 11:24:55 -0400 Subject: [PATCH 267/317] changed 01_user_acess to 01_portal_access Former-commit-id: 386c902b62d6b84641102d99554d0e0d5a45e902 --- .../{01_user_access.mdx => 01_portal_access.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename product_docs/docs/edbcloud/beta/administering_cluster/{01_user_access.mdx => 01_portal_access.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/01_user_access.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx From a326d8b9a4178b3496b6afd088e6d9a737aa4e7a Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 11:47:43 -0400 Subject: [PATCH 268/317] managing database acess Former-commit-id: 77899aed91870cfae5a275eb834045b1d9156f85 --- .../beta/administering_cluster/01_portal_access.mdx | 8 ++++---- .../beta/administering_cluster/02_database_acess.mdx | 3 +++ .../{02_activity_log.mdx => 03_activity_log.mdx} | 0 3 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx rename product_docs/docs/edbcloud/beta/administering_cluster/{02_activity_log.mdx => 03_activity_log.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx index bebb349617e..445ec13a7c3 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx @@ -10,7 +10,7 @@ Each subscribed customer has a unique *organization*. Each organization’s data Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges. -EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. +EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. ## Roles Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. @@ -18,10 +18,10 @@ Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You u * Each organization will have three default `roles` available: * _owner_ * _reader_ - * _contributor_ + * _contributor_ * These roles can be edited by changing their name or description. -### Permissions +### Permissions Permissions are generally represented in the format `action:object` where `action` represents an operation that can be performed and `object` represents a category of portal functionality. @@ -39,7 +39,7 @@ The following are the default permission by role: | | read | x | x | x | x | x | x | x | x | x | | | update | x | | x | | x | x | x | x | x | | | delete | x | | x | | x | x | x | x | x | -| contributor | create | x | | x | | | | x | | | +| contributor | create | x | | x | | | | x | | | | | read | x | x | x | x | x | x | x | x | x | | | update | x | | x | | | | x | | | | | delete | x | | x | | | | x | | | diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx new file mode 100644 index 00000000000..42186679209 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx @@ -0,0 +1,3 @@ +--- +title: "Managing Database Access" +--- diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/03_activity_log.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/02_activity_log.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/03_activity_log.mdx From 032b627f6d9a93c0503caa9e2ac122d7400b8ed6 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 12:10:11 -0400 Subject: [PATCH 269/317] monitoring and logging Former-commit-id: d4272493e5a5eeed6e897fea13959a54f441cab2 --- .../05_monitoring_and_logging.mdx | 31 ++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 25d1037f647..fab254562ca 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -9,7 +9,7 @@ To query EDB Cloud logs, you must use [Azure Log Analytics](https://docs.microso -## Customer Log Analytics Workspace +## Querying PostgreSQL Cluster Logs All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics workspace_. To find your _Customer Log Analytics workspace_, do the following: @@ -34,3 +34,32 @@ The following two tables are available in the _Customer Log Analytic workspace_. | PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases `logger = pgaudit or edb_audit` | You can use the KQL Query editor to compose your queries over these tables. +The following are useful examples of KQL queries: + +`PostgresLogs_CL | project record_log_time_s, record_error_severity_s, record_detail_s | sort by record_log_time_s desc` + +`PostgresAuditLogs_CL +| where logger_s == "pgaudit" +| project record_log_time_s, record_error_severity_s, record_audit_statement_s +| sort by record_log_time_s desc ` + +`PostgresAuditLogs_CL +| where logger_s == "edb_audit" +| project record_log_time_s, record_error_severity_s, record_message_s +| sort by record_log_time_s desc ` + +## Using Shared Dashboards to View PostgreSQL Cluster Logs + +To view logs from your PostgreSQL clusters using Shared Dashboard, do the following: + +1. Log in to the Azure Portal. + +2. Select the Resource Groups section. + +2. Select the Resource Group corresponding to the region where you choose to deploy your EDB Cloud. You will see resources included in that Resource Group. + +3. Select the resource of type _Shared Dashboard_ with the suffix -customer. + +4. Select the link _Go to dashboard_ located at the top of the page. + + From 211934b81ed5c731e709e3b9dc709071f7309ff5 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 12:12:28 -0400 Subject: [PATCH 270/317] monitoring and logging 2 Former-commit-id: eeb4ddac2c91d345eb803e6b0868896249637d7d --- .../beta/using_cluster/05_monitoring_and_logging.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index fab254562ca..97876c5ad27 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -2,14 +2,14 @@ title: "Monitoring and Logging" --- -## Azure Log Analytics +### Azure Log Analytics When EDB Cloud deploys workloads on Azure, the logs from the PostgreSQL clusters are forwarded to the Azure Log Workspace. To query EDB Cloud logs, you must use [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) and [Kusto Query language](https://azure-training.com/azure-data-science/the-kusto-query-language/). -## Querying PostgreSQL Cluster Logs +### Querying PostgreSQL Cluster Logs All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics workspace_. To find your _Customer Log Analytics workspace_, do the following: @@ -48,7 +48,7 @@ The following are useful examples of KQL queries: | project record_log_time_s, record_error_severity_s, record_message_s | sort by record_log_time_s desc ` -## Using Shared Dashboards to View PostgreSQL Cluster Logs +### Using Shared Dashboards to View PostgreSQL Cluster Logs To view logs from your PostgreSQL clusters using Shared Dashboard, do the following: From 8914163e6f1f6a63fe1443c6ea94f97b011c56af Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 12:30:24 -0400 Subject: [PATCH 271/317] deleted security and networking Former-commit-id: 1ee5ee9a3dc955042bde206f6144519beed721ac --- .../security_and_networking/02_private_networking.mdx | 10 ---------- .../security_and_networking/images/assign-roles.png | 3 --- .../security_and_networking/images/users.png | 3 --- .../security_and_networking/index.mdx | 5 ----- 4 files changed, 21 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx deleted file mode 100644 index f3506d278f1..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/02_private_networking.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Private Networking" ---- - -Configuration: - -- Private network connectivity can be enabled or disabled -UPM-930 - - diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png deleted file mode 100644 index c88c0e1665b..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/assign-roles.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:28e916e18c2d8f6b45677b146e22bcdee4281f44dd90d1c830524f8bc7cdeae0 -size 57147 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png deleted file mode 100644 index d7991f425df..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/images/users.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:664251a723276272129cc79d30446d102ca4936b9946a8017abaddb34441baf7 -size 44124 diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx deleted file mode 100644 index 999616862f7..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/security_and_networking/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Security and Networking" ---- - - From 93f3185a034c5c8817d2a0879378c335eca2d0c9 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 14:07:49 -0400 Subject: [PATCH 272/317] renaming to postgres_cluster_acess Former-commit-id: aeaebddb7a891ac62fe3fe5d38cad98301e01e34 --- .../edbcloud/beta/administering_cluster/02_database_acess.mdx | 3 --- .../beta/administering_cluster/02_postgres_cluster_acess.mdx | 3 +++ 2 files changed, 3 insertions(+), 3 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx deleted file mode 100644 index 42186679209..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/02_database_acess.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Managing Database Access" ---- diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx new file mode 100644 index 00000000000..e8912b1ab0d --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx @@ -0,0 +1,3 @@ +--- +title: "Postgres Cluster Access" +--- From 723b3da47407f1637cb2c59c501f344ad9d8b063 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 14:10:19 -0400 Subject: [PATCH 273/317] renaming to postgres_cluster_access Former-commit-id: d77c38b579090966bba5c365efd309950e94f2ee --- ..._postgres_cluster_acess.mdx => 02_postgres_cluster_access.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename product_docs/docs/edbcloud/beta/administering_cluster/{02_postgres_cluster_acess.mdx => 02_postgres_cluster_access.mdx} (100%) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx similarity index 100% rename from product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_acess.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx From 06525cd015ecf6204aababfb2df721b9da878e62 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Wed, 11 Aug 2021 14:24:50 -0400 Subject: [PATCH 274/317] Update 02_connect_to_cluster.mdx Added Best Practice Recommendation for SSL Mode Former-commit-id: ef9972818a6389db6ad9e2f671ec4cb7cc0d9310 --- .../beta/using_cluster/02_connect_to_cluster.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 0fe7bbaafee..8855c91986a 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,6 +1,8 @@ --- title: "Connecting to Your Cluster" --- +## How-to Connect + You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based client for Postgres, or another client. To connect to your cluster using `psql`: @@ -12,4 +14,14 @@ To connect to your cluster using `psql`: To connect to your cluster using a client other than `psql`: 1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. 2. Select the name of your cluster. -3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the `edb_admin` user password. Please consult the client driver documentation for the connection string format the driver uses. +3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the `edb_admin` user password. Please consult the client driver documentation for the connection string format the driver uses. + +## Best Practice Recommendation - SSL Mode + +Different clients can have different default SSL modes. For example, `psql` defaults to `prefer`, which means the client will attempt to establish a SSL connection but fall back to non-SSL if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, SSL mode is explicitly set to `require`, which means the client will attempt an SSL connection and fail if the connection to the server can't be encrypted. + +For public connections and in most environments, EDB recommends setting SSL mode to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates *letsEncrypt* certificates, a trusted CA. Therefore, your client machine will need a CA Cert for Let's Encrypt[https://letsencrypt.org/certificates/]. Once the CA cert is in place on your client machine, add `PGSSLROOTCERT` and set `PGSSLMODE` to `verify-full` in your connection string to verify the certificate: + +``` +psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" +``` From a11fc72449001f209cf005d75c22cfe89e571219 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Wed, 11 Aug 2021 14:41:49 -0400 Subject: [PATCH 275/317] Update product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> Former-commit-id: 86294aa1c3148357135b220eaf842c0fa289ae8c --- .../docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 8855c91986a..317676a503b 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -20,7 +20,7 @@ To connect to your cluster using a client other than `psql`: Different clients can have different default SSL modes. For example, `psql` defaults to `prefer`, which means the client will attempt to establish a SSL connection but fall back to non-SSL if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, SSL mode is explicitly set to `require`, which means the client will attempt an SSL connection and fail if the connection to the server can't be encrypted. -For public connections and in most environments, EDB recommends setting SSL mode to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates *letsEncrypt* certificates, a trusted CA. Therefore, your client machine will need a CA Cert for Let's Encrypt[https://letsencrypt.org/certificates/]. Once the CA cert is in place on your client machine, add `PGSSLROOTCERT` and set `PGSSLMODE` to `verify-full` in your connection string to verify the certificate: +For public connections and in most environments, EDB recommends setting SSL mode to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, e.g., at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine will need a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: ``` psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" From df6215e6998e84c458039362dc061a67f82ad6ee Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 14:44:19 -0400 Subject: [PATCH 276/317] edits to monitoring and logging Former-commit-id: 74a225149aadd9c36b5ba40c0feb1a3b17be0476 --- .../05_monitoring_and_logging.mdx | 40 +++++++++++-------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 97876c5ad27..85e4dfe0a50 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -2,6 +2,9 @@ title: "Monitoring and Logging" --- + +EDB Cloud sends all metrics and logs from PostgreSQL clusters to Azure. This section describes what metrics and logs are sent and how to view them. + ### Azure Log Analytics When EDB Cloud deploys workloads on Azure, the logs from the PostgreSQL clusters are forwarded to the Azure Log Workspace. @@ -12,7 +15,7 @@ To query EDB Cloud logs, you must use [Azure Log Analytics](https://docs.microso ### Querying PostgreSQL Cluster Logs -All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics workspace_. To find your _Customer Log Analytics workspace_, do the following: +All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics workspace_. To find your _Customer Log Analytics workspace_: 1. Log in to the Azure Portal. @@ -26,31 +29,36 @@ All logs from your PostgreSQL clusters are stored in the _Customer Log Analytics 5. Close the dashboard with prebuilt queries. This will bring you to the KQL Editor. -The following two tables are available in the _Customer Log Analytic workspace_. +The following tables are available in the _Customer Log Analytic workspace_. -| Table Name | Description | -| --- | --- | -| PostgresLogs_CL | Logs of the Customer clusters databases (all postgres related logs) `logger = postgres` | -| PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases `logger = pgaudit or edb_audit` | +| Table Name | Description | Logger | +| ---------- | ----------- | ------ | +| PostgresLogs_CL | Logs of the Customer clusters databases (all postgres related logs) | `logger = postgres` | +| PostgresAuditLogs_CL | Audit Logs of the Customer clusters databases | `logger = pgaudit or edb_audit` | -You can use the KQL Query editor to compose your queries over these tables. -The following are useful examples of KQL queries: +You can use the KQL Query editor to compose your queries over these tables. For example, -`PostgresLogs_CL | project record_log_time_s, record_error_severity_s, record_detail_s | sort by record_log_time_s desc` - -`PostgresAuditLogs_CL +~~~ sql +PostgresLogs_CL +| project record_log_time_s, record_error_severity_s, record_detail_s +| sort by record_log_time_s desc +~~~ +~~~ sql +PostgresAuditLogs_CL | where logger_s == "pgaudit" | project record_log_time_s, record_error_severity_s, record_audit_statement_s -| sort by record_log_time_s desc ` - -`PostgresAuditLogs_CL +| sort by record_log_time_s desc +~~~ +~~~ sql +PostgresAuditLogs_CL | where logger_s == "edb_audit" | project record_log_time_s, record_error_severity_s, record_message_s -| sort by record_log_time_s desc ` +| sort by record_log_time_s desc +~~~ ### Using Shared Dashboards to View PostgreSQL Cluster Logs -To view logs from your PostgreSQL clusters using Shared Dashboard, do the following: +To view logs from your PostgreSQL clusters using Shared Dashboard: 1. Log in to the Azure Portal. From 986d44f2be49be8f33efc1db49fb72f3d9232ade Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 14:48:21 -0400 Subject: [PATCH 277/317] updated example formatting per George's recommendation Former-commit-id: 61efeeaa77480884b348c0f14b1ffe78cfded1da --- .../beta/using_cluster/05_monitoring_and_logging.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx index 85e4dfe0a50..432ee6a708d 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/05_monitoring_and_logging.mdx @@ -38,23 +38,21 @@ The following tables are available in the _Customer Log Analytic workspace_. You can use the KQL Query editor to compose your queries over these tables. For example, -~~~ sql +``` PostgresLogs_CL | project record_log_time_s, record_error_severity_s, record_detail_s | sort by record_log_time_s desc -~~~ -~~~ sql + PostgresAuditLogs_CL | where logger_s == "pgaudit" | project record_log_time_s, record_error_severity_s, record_audit_statement_s | sort by record_log_time_s desc -~~~ -~~~ sql + PostgresAuditLogs_CL | where logger_s == "edb_audit" | project record_log_time_s, record_error_severity_s, record_message_s | sort by record_log_time_s desc -~~~ +``` ### Using Shared Dashboards to View PostgreSQL Cluster Logs From 90f62072c8b27299ebb346ee882464d1c34fb061 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Wed, 11 Aug 2021 14:52:04 -0400 Subject: [PATCH 278/317] Update 02_connect_to_cluster.mdx Cleaned up wording, replacing SSL with TLS where appropriate. Former-commit-id: f7a23bb156dd069002bc559a18c0d3c53c14c67f --- .../edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index 317676a503b..a53f77c6691 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -18,9 +18,9 @@ To connect to your cluster using a client other than `psql`: ## Best Practice Recommendation - SSL Mode -Different clients can have different default SSL modes. For example, `psql` defaults to `prefer`, which means the client will attempt to establish a SSL connection but fall back to non-SSL if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, SSL mode is explicitly set to `require`, which means the client will attempt an SSL connection and fail if the connection to the server can't be encrypted. +Different clients can have different default TLS/SSL modes (sslmode). For example, `psql` defaults to `prefer`, which means the client will attempt to establish a TLS connection but fall back to non-TLS if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, `sslmode` is explicitly set to `require`, which means the client will attempt a TLS connection and fail if the connection to the server can't be encrypted. -For public connections and in most environments, EDB recommends setting SSL mode to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, e.g., at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine will need a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: +For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, e.g., at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine will need a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: ``` psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" From 46ea9b470318485a2533219a950b6965fb896f09 Mon Sep 17 00:00:00 2001 From: theadamwright Date: Wed, 11 Aug 2021 14:58:45 -0400 Subject: [PATCH 279/317] Update 02_connect_to_cluster.mdx Former-commit-id: daf281ace3b6d54a845712c9faaf51a43567c9c9 --- .../edbcloud/beta/using_cluster/02_connect_to_cluster.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index a53f77c6691..f7ff1df52e0 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -25,3 +25,11 @@ For public connections and in most environments, EDB recommends setting `sslmode ``` psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" ``` + +Once connected to the cluster using psql, the `conninfo` meta-command will show the encryption protocol being used for communication, in the case of EDB Cloud, TLS (v1.2+) is supported: + +``` +edb_admin=> \conninfo +You are connected to database "edb_admin" as user "edb_admin" on host "xxxxxxxxx.xxxxx.edbcloud.io" at port "5432". +SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) +``` From 9a68a7b5026e9cce7e1d5a448f6eddc1fedc941e Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 11 Aug 2021 15:33:16 -0400 Subject: [PATCH 280/317] renaming to managing_postgres_access, account_activity Former-commit-id: b09bb342ac4e16a982606348de14e3d60972e936 --- .../beta/administering_cluster/02_postgres_access.mdx | 3 +++ .../beta/administering_cluster/02_postgres_cluster_access.mdx | 3 --- .../{03_activity_log.mdx => 03_account_activity.mdx} | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_access.mdx delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx rename product_docs/docs/edbcloud/beta/administering_cluster/{03_activity_log.mdx => 03_account_activity.mdx} (97%) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_access.mdx new file mode 100644 index 00000000000..6ec8f35f8b3 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_access.mdx @@ -0,0 +1,3 @@ +--- +title: "Managing Postgres Access" +--- diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx deleted file mode 100644 index e8912b1ab0d..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/02_postgres_cluster_access.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Postgres Cluster Access" ---- diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/03_activity_log.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/03_account_activity.mdx similarity index 97% rename from product_docs/docs/edbcloud/beta/administering_cluster/03_activity_log.mdx rename to product_docs/docs/edbcloud/beta/administering_cluster/03_account_activity.mdx index 839f28f0bdc..46115407b5f 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/03_activity_log.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/03_account_activity.mdx @@ -1,5 +1,5 @@ --- -title: "Using the Activity Log" +title: "Reviewing Account Activity" --- The activity log collects **EDB Cloud events**. It can be used to audit activities performed by users from your organizations. @@ -21,7 +21,7 @@ EDB Cloud collects events related to the following resource types: !!! Note To view the activity log, you need to have the role _owner_ or have the _read:event_ permission. - + To view the activity log table, navigate to the activity log. To search the activity log table, use the filters at the top of the page. The activity log table has the following fields: From cbdf2647a239b718ea7e7d60936b10a734a0b45a Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 15:48:22 -0400 Subject: [PATCH 281/317] Update 01_portal_access.mdx Former-commit-id: 69cbe8d28553ac7f7d6405f235899cac6420687a --- .../01_portal_access.mdx | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx index 445ec13a7c3..e4910e3f1fc 100644 --- a/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx +++ b/product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx @@ -10,24 +10,24 @@ Each subscribed customer has a unique *organization*. Each organization’s data Each EDB Cloud organization is associated with an Azure Active Directory (AD) tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges. -EDB Cloud supports role based access control policies. A user with the **owner** role may assign roles to other users in the same organization. +EDB Cloud supports role based access control policies. A user with the owner role may assign roles to other users in the same organization. ## Roles Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users. -* Each organization will have three default `roles` available: - * _owner_ - * _reader_ - * _contributor_ +* Each organization will have three default roles available: + * owner + * reader + * contributor * These roles can be edited by changing their name or description. ### Permissions Permissions are generally represented in the format `action:object` where `action` represents an operation that can be performed and `object` represents a category of portal functionality. -The available `actions` are: _create_, _read_, _update_, _delete_ +The available `actions` are: create, read, update, delete -The available `objects` are: _backups_, _billing_, _databases_, _events_, _permissions_, _roles_, _tickets_, _users_, _versions_ +The available `objects` are: backups, billing, databases, events, permissions, roles, tickets, users, versions ### Permissions by Role @@ -73,7 +73,7 @@ To change permissions associated with the role: 3. Select the list of permissions you want to be associated with the role. 4. Press **Submit** -!!! Note: +!!! Note Changing role permissions will affect every user who is assigned the same role. ## Users @@ -102,10 +102,10 @@ To view all users from your organization that have logged in at least once: ## Example Scenario -1. The EDB Cloud organization is created, and Tom logs in and is granted the **owner** role. +1. The EDB Cloud organization is created, and Tom logs in and is granted the owner role. 1. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created. -1. Tom grants Sally the **contributor** role. Sally logs out and back in, and she can now create EDB Cloud clusters. -1. Sally asks Jerry to log in, and grants him the **reader** role. +1. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create EDB Cloud clusters. +1. Sally asks Jerry to log in, and grants him the reader role. 1. Jerry logs out and back in, and he can now see the clusters that Sally has created. From 874c540e49cda4f3a7b7503a0f12dec7711f05c1 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 11 Aug 2021 16:13:10 -0400 Subject: [PATCH 282/317] review comments on Connecting to Your Cluster Former-commit-id: 9c4b0bfd7de8c29f3085bfb7de809f2b83e28be6 --- .../using_cluster/02_connect_to_cluster.mdx | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx index f7ff1df52e0..0558338d171 100644 --- a/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx +++ b/product_docs/docs/edbcloud/beta/using_cluster/02_connect_to_cluster.mdx @@ -1,32 +1,35 @@ --- title: "Connecting to Your Cluster" --- -## How-to Connect -You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based client for Postgres, or another client. +You can connect to your cluster using [`psql`](http://postgresguide.com/utilities/psql.html), the terminal-based client for Postgres, or another client. See [Recommended Settings for SSL Mode](recommended-setting-for-ssl-mode) for EDB's recommendations for secure connections. +## Using `psql` To connect to your cluster using `psql`: 1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. -2. Select the name of your cluster. -3. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` will prompt for the `edb_admin` user password you selected at cluster creation time. -4. Paste the command in your terminal. +3. Select the name of your cluster. +4. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` will prompt for the `edb_admin` user password you selected at cluster creation time. +5. Paste the command in your terminal. + +## Using Another Client To connect to your cluster using a client other than `psql`: 1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. + 2. Select the name of your cluster. 3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the `edb_admin` user password. Please consult the client driver documentation for the connection string format the driver uses. -## Best Practice Recommendation - SSL Mode +## Recommended Settings for SSL Mode Different clients can have different default TLS/SSL modes (sslmode). For example, `psql` defaults to `prefer`, which means the client will attempt to establish a TLS connection but fall back to non-TLS if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, `sslmode` is explicitly set to `require`, which means the client will attempt a TLS connection and fail if the connection to the server can't be encrypted. -For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, e.g., at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine will need a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: +For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt, a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, for example, at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine needs a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: ``` psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" ``` -Once connected to the cluster using psql, the `conninfo` meta-command will show the encryption protocol being used for communication, in the case of EDB Cloud, TLS (v1.2+) is supported: +Once connected to the cluster using `psql`, the `conninfo` meta-command shows the encryption protocol being used for communication. In the case of EDB Cloud, TLS (v1.2+) is supported: ``` edb_admin=> \conninfo From 08447bb896177c95e41b96bbba97bb29504d86be Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 11 Aug 2021 16:33:15 -0400 Subject: [PATCH 283/317] removed index card descriptions from landing page per Kelly's feedback Former-commit-id: bf371257b3e0e09dfde0371fc37653af02bf446d --- product_docs/docs/edbcloud/beta/getting_started/index.mdx | 1 - product_docs/docs/edbcloud/beta/overview/index.mdx | 1 - 2 files changed, 2 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/getting_started/index.mdx b/product_docs/docs/edbcloud/beta/getting_started/index.mdx index 2ee2396eea3..a96c83f0484 100644 --- a/product_docs/docs/edbcloud/beta/getting_started/index.mdx +++ b/product_docs/docs/edbcloud/beta/getting_started/index.mdx @@ -1,7 +1,6 @@ --- title: "Getting Started" indexCards: simple -description: "Configure your account and create a Postgres cluster" navigation: - 02_connect_cloud_account - 01_check_resource_limits diff --git a/product_docs/docs/edbcloud/beta/overview/index.mdx b/product_docs/docs/edbcloud/beta/overview/index.mdx index b5c8b7f6199..9e552508e72 100644 --- a/product_docs/docs/edbcloud/beta/overview/index.mdx +++ b/product_docs/docs/edbcloud/beta/overview/index.mdx @@ -1,6 +1,5 @@ --- title: "Overview of Service" -description: "Learn about EDB Cloud " --- From f4c6dec29a41fdfa3c73d65ba4a041f1185752df Mon Sep 17 00:00:00 2001 From: aswright491 <36008570+aswright491@users.noreply.github.com> Date: Wed, 11 Aug 2021 16:55:16 -0400 Subject: [PATCH 284/317] Update 04_responsibility_model.mdx I completely re-worked this entire section with new content. Former-commit-id: f9695cceaa1bae8a3fed57ad4330cf9d678860ad --- .../beta/overview/04_responsibility_model.mdx | 48 ++++++++----------- 1 file changed, 19 insertions(+), 29 deletions(-) diff --git a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx index dced00b10ae..1bdecf43759 100644 --- a/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx +++ b/product_docs/docs/edbcloud/beta/overview/04_responsibility_model.mdx @@ -2,42 +2,32 @@ title: "Responsibility Model" --- -Security and confidentiality is a shared responsibility between you and EDB. EDB provides a secure platform that enables you to create and maintain secure database clusters deployed on EDB Cloud. You have numerous responsibilities around the security of your clusters and data held within them. - -Reference and link out to Terms +Security and confidentiality is a shared responsibility between you and EDB. EDB provides a secure platform that enables you to create and maintain secure database clusters deployed on EDB Cloud. You have numerous responsibilities around the security of your clusters and data held within them. The following Responsibility Model describes the distribution of specific responsibilities between you and EDB. -## Planning and Operations Management - - -| Task | EDB Responsibility | Your Responsibility | -| ----- | ------------------------- | ------------------------ | -| **Cloud infrastructure availability:** compute and network resources are operating properly - including performance - and can be scaled / reconfigured as necessary. | Yes | No | -| **Database service availability:** customers can connect to a database cluster and read / write data. | Yes | Yes | -| **Planning database performance:** data modeling and query performance that meets your business needs. | No | Yes | -| **Database cluster capacity planning:** the database clusters deployed on the platform are allocated sufficient resources (CPU/RAM/disk) to achieve acceptable performance. Disk space is monitored for exhaustion. | No | Yes | -| **Database cluster backups:** database clusters are configured to back up data at intervals that meet your recovery point objective. | No | Yes | -| **Database cluster backups:** data in database clusters is backed up and made available for restore in a timely manner consistent with the configuration of the database cluster. | Yes | No | -| **Database cluster backups:** database backups can be restored in a timely fashion consistent with your recovery time objective. | No | Yes | - - - - -## Security and Compliance - +## High Availability +- EDB is responsible for deploying clusters with one primary and two replicas. In cloud regions with availability zones, clusters will be deployed across multiple availability zones. +- Customers are responsible for choosing if they want to enable high availability. -| Task | EDB Responsibility | Your Responsibility | -| ----- | ------------------------- | ------------------------ | -| **Database cluster credential management:** credentials for database clusters are kept secret and rotated as appropriate. | Yes | Yes | -| **Encryption of customer data at-rest:** Data stored in database clusters is encrypted appropriately. | Configuring encryption with appropriate keys | No | -| **Vulnerability management:** operating system kernels and packages on computers hosting customer database clusters and the control plane are kept up-to-date in accordance with policy. | Yes | No | -| **Vulnerability management:** database software is kept up-to-date in accordance with policy. | Yes | No | -| **Network security:** firewalls are configured to appropriately restrict east / west network traffic. | Yes | No | -| **Network security:** firewalls are configured to appropriately restrict north / south network traffic. | Given a customer's network ingress configuration, EDB is responsible for implementing the correct set of firewall rules. | You must configure network ingress policies via the EDB Cloud API to allow traffic only from appropriate sources. | +## Database Performance +- EDB is responsible for managing and monitoring the underlying infrastructure resources. +- Customers are responsible for data modeling, query performance, and scaling the cluster to meet their performance needs. +## Scaling +- EDB is responsible for managing and monitoring the underlying infrastructure. +- Customers are responsible for choosing the appropriate resources for their workload, including instance type, storage, and connections. Customers are also responsible for managing their Azure resource limits to ensure the underlying infrastructure can be scaled. +## Backups and Restores +- EDB is responsible for taking automatic backups and storing them in cross-regional Azure Blob Storage. +- Customers are responsible for periodically restoring and verifying the restores to ensure that archives are completing frequently and successfully to meet their needs. +## Encryption +- EDB is responsible for data encryption at rest and in transit. EDB is also responsible for encrypting backups. +- Customers are responsible for column level encryption to protect sensitive database attributes from unauthorized access by authorized users and applications of the database. +## Credential Management +- EDB is responsible for making credentials available to customers. +- Customers are responsible for managing and securing their passwords, both for EDB Cloud and their database passwords. From 05e573b727a5e8da797d6e5b55c8b7aa8f13c5a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Gonz=C3=A1lez?= Date: Wed, 11 Aug 2021 18:53:30 -0500 Subject: [PATCH 285/317] Hide product version and show banner for EDB Cloud pages * Add frontmatter option to hide product version * Add edb cloud banner on edb cloud pages * Add hideVersion and displayBanner to the navTree * hide version from the page title Former-commit-id: 2236e1fff9831aff3e17393ff6139fc8ab662b35 --- gatsby-node.js | 2 ++ product_docs/docs/edbcloud/beta/index.mdx | 4 +++- src/components/left-nav.js | 9 +++++--- src/constants/gatsby-utils.js | 2 ++ src/templates/doc.js | 27 ++++++++++++++++++----- 5 files changed, 35 insertions(+), 9 deletions(-) diff --git a/gatsby-node.js b/gatsby-node.js index ec6000a6ded..0d404be13e2 100644 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -125,6 +125,8 @@ exports.createPages = async ({ actions, graphql, reporter }) => { initializeCommand codelanguages } + hideVersion + displayBanner directoryDefaults { description prevNext diff --git a/product_docs/docs/edbcloud/beta/index.mdx b/product_docs/docs/edbcloud/beta/index.mdx index ff78620a0c3..c160aaab204 100644 --- a/product_docs/docs/edbcloud/beta/index.mdx +++ b/product_docs/docs/edbcloud/beta/index.mdx @@ -1,7 +1,9 @@ --- -title: EDB Cloud +title: EDB Cloud Preview description: "EDB Cloud: DBaaS for PostgresSQL " indexCards: simple +hideVersion: true +displayBanner: 'edbcloud' directoryDefaults: iconName: clouddb navigation: diff --git a/src/components/left-nav.js b/src/components/left-nav.js index 573e036f5dc..e7183ea8e6e 100644 --- a/src/components/left-nav.js +++ b/src/components/left-nav.js @@ -33,6 +33,7 @@ const SectionHeadingWithVersions = ({ path, versionArray, iconName, + hideVersion, }) => { return (
  • @@ -49,13 +50,13 @@ const SectionHeadingWithVersions = ({ > {navTree.title} - {versionArray.length > 1 ? ( + {!navTree.hideVersion && versionArray.length > 1 ? (
    - ) : ( + ) : !navTree.hideVersion ? (
    Version {versionArray[0].version}
    - )} + ) : null}
    • ); @@ -68,6 +69,7 @@ const LeftNav = ({ versionArray, iconName, hideEmptySections = false, + hideVersion = false, }) => { return (