From bf4e955e51eb71e20ba8ef2cda5bdfd76f87e7b6 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:11:26 +0100 Subject: [PATCH 01/26] create branch --- modules/ROOT/content-nav.adoc | 5 +++-- .../read-only-secondaries.adoc | 21 +++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index ab47594ae..7dd77ff8f 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -53,10 +53,11 @@ AuraDB Start ** xref:auradb/importing/import-database.adoc[] * Managing instances +** xref:auradb/managing-databases/database-actions.adoc[] ** xref:auradb/managing-databases/monitoring.adoc[] -** xref:auradb/managing-databases/advanced-metrics.adoc[] ** xref:auradb/managing-databases/backup-restore-export.adoc[] -** xref:auradb/managing-databases/database-actions.adoc[] +** xref:auradb/managing-databases/advanced-metrics.adoc[] +** xref:auradb/managing-databases/read-only-secondaries.adoc[] * xref:auradb/connecting-applications/overview.adoc[Connecting applications] //// diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc new file mode 100644 index 000000000..c5803c060 --- /dev/null +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -0,0 +1,21 @@ +[[aura-read-only-secondaries]] += Read only secondaries + +secondaries: part of scaling and performance initiative at neo4j +it adds an extension of a database + +Because they don't necessarily need to get started with secondaries, and not everyone needs them + +It's for read intensive projects e.g. for analytics companies that are giving people recommendations with less write actions. + +Makes it speedy to read from the database, b/c if someone is read & writing it can get slow if there’s lots of reads. + +It means that in high read projects there's no bottlenecks, and companies can do more reads batch processing. + +If a company was to do a lot of writing and reading then it could potentially slow down everything. + +Simple fixed routing? + + + + From 86e9b17c7769b81aa6e1f7462ac8dd0f922f0e14 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:41:57 +0100 Subject: [PATCH 02/26] add more info --- .../read-only-secondaries.adoc | 112 ++++++++++++++++++ 1 file changed, 112 insertions(+) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index c5803c060..647e0a46e 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -1,6 +1,8 @@ [[aura-read-only-secondaries]] = Read only secondaries +serving those with a need for high Read throughput, to distribute those read queries. + secondaries: part of scaling and performance initiative at neo4j it adds an extension of a database @@ -16,6 +18,116 @@ If a company was to do a lot of writing and reading then it could potentially sl Simple fixed routing? +Scope of the EAP + +Up to 15 static Read-Only Secondaries can be added per AuraDB Enterprise database instance. +Single region only. Read-Only secondaries available in same region as their Primary database. + +The following routing policy will apply when at least one secondary is available: Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability + +Available for all clouds (AWS, Azure & GCP) + +During EAP each Secondary is will consume credits at ⅓ (‘a third’) of the normal running rate of an AuraDB Enterprise database. We reserve the right to adjust this once the feature is made generally available. + +We will not support use cases for isolated workloads (customer routing) or multi region replication at this time, but will be gathering feedback on those use cases during EAP. + +// + +The introduction of secondaries in Aura expands Neo4j's capabilities by enabling additional read-only database instances for horizontal scaling and enhanced cluster resilience. + +With secondaries, users can scale the READ capacity of their clusters, paving the way for improved support for READ-intensive use cases. These secondary instances are configurable via the Aura console and API, allowing users to launch, manage, and terminate them effortlessly. Secondaries are orchestrated to maintain availability and balanced distribution across availability zones, ensuring optimal performance and cost efficiency. + +== Console UI - Create Secondaries + +Once the secondaries EAP feature is enabled for your tenant you’ll see Secondary count set to Zero, and the ability to Edit secondaries in UI of the DB Overview and Details tile + +== Aura Provisioning API - simple request + +Once enabled for the user’s tenant a GET instance details call will show secondary count + +[source] +---- + +GET/instances/{instanceId]{ + "data": { + "cloud_provider": "azure", + "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", + "id": "xxxxxx", + "memory": "2GB", + "name": "Neo4j", + "region": "uk south", + "secondaries_count": 0, + "status": "running", + "storage": "4GB", + "tenant_id": "XXXXXXXXXXXXXXXXXXXX", + "type": "enterprise-db" + } +} + +---- + +PATCH/instances/{instanceId] +{ + "secondaries_count": 2 +}' + + +[source] +---- + +A simple Secondaries count patch request will request update { + "data": { + "cloud_provider": "azure", + "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", + "id": "xxxxxx", + "memory": "2GB", + "name": "Neo4j", + "region": "uk south", + "secondaries_count": 2, + "status": "running", + "storage": "4GB", + "tenant_id": "XXXXXXXXXXXXXXXXXXXXX", + "type": "enterprise-db" + } +} + +---- + +How is this different to before? +Until now AuraDBE customers could create a Database Instance which consists of a 3 node cluster, where the nodes are either fulfilling the role of Leader (one and only one at any point in time) or Follower (multiple). The Leader is responsible for the WRITES but also serves READ queries. The followers only serve READ queries. Customers mark queries explicitly for READ in their code to best utilise the available resources of the Leader. + +The new Read-only secondaries will allow customers with a need for high Read throughput to distribute those read queries. + + +How many Secondaries can I create? +Users can create up to 15 secondaries although as this is a billable EAP we advise caution. +How dynamic are these Read-only secondaries? +These are static right now, they are not elastic, though we will use these to underpin an Auto-scaling initiative in the future + +Will these be cross region? +In line with AuraDB Instances which are today deployed in a single region, read-only secondaries are also single region only at this time. + +We will gather feedback during EAP on multi-region for reduced latency use cases as we plan out our roadmap. + +Can you create these at the same time a database is created? +Not right now, they are currently appended to an existing Databases via API or Console, the ability to create these at the point of DB creation is a future roadmap item +If I Pause/Resume my Aura Database, will my secondaries count be retained +Yes. Example; when an AuraDB Enterprise database with 3 Secondaries is Paused (either via the Console or API), once that Database is Resumed, it will resume with 3 Secondaries. +What about Cloning or Resizing? +Retaining the secondaries on Clone or Resize is out of scope right now as for use cases where customers are cloning data to dev / test, or resizing, this can be costly. Initially customers will need to re-add their secondaries again after Clone or Resize is successfully completed. We will gather feedback on this. + +What is the Routing policy? +The following routing policy should apply when at least one secondary is available: Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. + +We will gather feedback during EAP on workload isolation requiring custom routing policies as we plan out our roadmap. +Are Secondaries included in Metrics & Logs during EAP? +Secondaries will appear in Query Logs as usual, we have a roadmap item to include Secondaries in Advanced Metrics. + +Who do I contact during EAP? +While in early access, if you have any questions or feedback, please reach out to your Customer Success Manager / Field Account Manager, or via Support teams. + + + From 2648262705eb5247b435522b38ed7c58ce48f562 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Fri, 19 Jul 2024 13:59:31 +0100 Subject: [PATCH 03/26] edits --- .../read-only-secondaries.adoc | 79 ++++--------------- 1 file changed, 17 insertions(+), 62 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 647e0a46e..2c3aa2924 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -1,45 +1,38 @@ [[aura-read-only-secondaries]] -= Read only secondaries += Read-only secondaries -serving those with a need for high Read throughput, to distribute those read queries. +label:EAP[] -secondaries: part of scaling and performance initiative at neo4j -it adds an extension of a database - -Because they don't necessarily need to get started with secondaries, and not everyone needs them - -It's for read intensive projects e.g. for analytics companies that are giving people recommendations with less write actions. - -Makes it speedy to read from the database, b/c if someone is read & writing it can get slow if there’s lots of reads. +Available for all clouds (AWS, Azure & GCP) -It means that in high read projects there's no bottlenecks, and companies can do more reads batch processing. +Read-only secondaries serve those with a need for high READ queries (e.g. for analytics companies making recommendations that are giving people recommendations, and using less WRITE actions than READ actions). -If a company was to do a lot of writing and reading then it could potentially slow down everything. +Read-only secondaries make it speedy to read from the database, if a system is using READ & WRITE, if there’s lots of READ queries, using read-only secondaries means that in high read projects there's no bottlenecks, and companies can do more reads batch processing. -Simple fixed routing? +The introduction of secondaries in Aura expands Neo4j's capabilities by enabling additional read-only database instances for horizontal scaling (adding additional machines to an infrastructure, to adapt to increased demand) and enhanced cluster resilience. -Scope of the EAP +With secondaries, users can scale the READ capacity of their clusters, paving the way for improved support for READ-intensive use cases. +These secondary instances configurable via the Aura console and API, where they can be launched, managed, or terminated. -Up to 15 static Read-Only Secondaries can be added per AuraDB Enterprise database instance. -Single region only. Read-Only secondaries available in same region as their Primary database. +* Up to 15 static Read-Only Secondaries can be added per AuraDB Enterprise database instance. +* Single region only. +* Read-only secondaries available in same region as their Primary database. -The following routing policy will apply when at least one secondary is available: Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability +== Routing policy -Available for all clouds (AWS, Azure & GCP) +The following routing policy will apply when at least one secondary is available: -During EAP each Secondary is will consume credits at ⅓ (‘a third’) of the normal running rate of an AuraDB Enterprise database. We reserve the right to adjust this once the feature is made generally available. +Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability -We will not support use cases for isolated workloads (customer routing) or multi region replication at this time, but will be gathering feedback on those use cases during EAP. +We will not support use cases for isolated workloads (customer routing) or multi region replication. // -The introduction of secondaries in Aura expands Neo4j's capabilities by enabling additional read-only database instances for horizontal scaling and enhanced cluster resilience. - -With secondaries, users can scale the READ capacity of their clusters, paving the way for improved support for READ-intensive use cases. These secondary instances are configurable via the Aura console and API, allowing users to launch, manage, and terminate them effortlessly. Secondaries are orchestrated to maintain availability and balanced distribution across availability zones, ensuring optimal performance and cost efficiency. +Secondaries are orchestrated to maintain availability and balanced distribution across availability zones, ensuring optimal performance and cost efficiency. == Console UI - Create Secondaries -Once the secondaries EAP feature is enabled for your tenant you’ll see Secondary count set to Zero, and the ability to Edit secondaries in UI of the DB Overview and Details tile +Once this feature is enabled for your tenant you will see Secondary count set to Zero, and the ability to Edit secondaries in UI of the DB Overview and Details tile. * change grammar tense * == Aura Provisioning API - simple request @@ -91,43 +84,5 @@ A simple Secondaries count patch request will request update { } } ----- - -How is this different to before? -Until now AuraDBE customers could create a Database Instance which consists of a 3 node cluster, where the nodes are either fulfilling the role of Leader (one and only one at any point in time) or Follower (multiple). The Leader is responsible for the WRITES but also serves READ queries. The followers only serve READ queries. Customers mark queries explicitly for READ in their code to best utilise the available resources of the Leader. - -The new Read-only secondaries will allow customers with a need for high Read throughput to distribute those read queries. - - -How many Secondaries can I create? -Users can create up to 15 secondaries although as this is a billable EAP we advise caution. -How dynamic are these Read-only secondaries? -These are static right now, they are not elastic, though we will use these to underpin an Auto-scaling initiative in the future - -Will these be cross region? -In line with AuraDB Instances which are today deployed in a single region, read-only secondaries are also single region only at this time. - -We will gather feedback during EAP on multi-region for reduced latency use cases as we plan out our roadmap. - -Can you create these at the same time a database is created? -Not right now, they are currently appended to an existing Databases via API or Console, the ability to create these at the point of DB creation is a future roadmap item -If I Pause/Resume my Aura Database, will my secondaries count be retained -Yes. Example; when an AuraDB Enterprise database with 3 Secondaries is Paused (either via the Console or API), once that Database is Resumed, it will resume with 3 Secondaries. -What about Cloning or Resizing? -Retaining the secondaries on Clone or Resize is out of scope right now as for use cases where customers are cloning data to dev / test, or resizing, this can be costly. Initially customers will need to re-add their secondaries again after Clone or Resize is successfully completed. We will gather feedback on this. - -What is the Routing policy? -The following routing policy should apply when at least one secondary is available: Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. - -We will gather feedback during EAP on workload isolation requiring custom routing policies as we plan out our roadmap. -Are Secondaries included in Metrics & Logs during EAP? -Secondaries will appear in Query Logs as usual, we have a roadmap item to include Secondaries in Advanced Metrics. - -Who do I contact during EAP? -While in early access, if you have any questions or feedback, please reach out to your Customer Success Manager / Field Account Manager, or via Support teams. - - - - From 017e4b418b42887813fe8f7777aec9ee44ac83da Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 12:19:57 +0100 Subject: [PATCH 04/26] add info --- .../read-only-secondaries.adoc | 51 ++++++++++--------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 2c3aa2924..098317238 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -1,42 +1,45 @@ [[aura-read-only-secondaries]] -= Read-only secondaries += Read-only secondary instances +:description: The main responsibility of Read-only secondaries is to scale out read workloads. -label:EAP[] +label:AuraDB-Virtual-Dedicated-Cloud[] -Available for all clouds (AWS, Azure & GCP) +Using read-only secondaries makes database reading much faster. A read-only secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the read-only secondary. In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. -Read-only secondaries serve those with a need for high READ queries (e.g. for analytics companies making recommendations that are giving people recommendations, and using less WRITE actions than READ actions). +Read-only secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. +For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. -Read-only secondaries make it speedy to read from the database, if a system is using READ & WRITE, if there’s lots of READ queries, using read-only secondaries means that in high read projects there's no bottlenecks, and companies can do more reads batch processing. +Up to 15 static read-only secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. +These secondaries can be added, managed, and removed through the Aura Console or the Aura API. -The introduction of secondaries in Aura expands Neo4j's capabilities by enabling additional read-only database instances for horizontal scaling (adding additional machines to an infrastructure, to adapt to increased demand) and enhanced cluster resilience. +== Read-only secondaries info: -With secondaries, users can scale the READ capacity of their clusters, paving the way for improved support for READ-intensive use cases. -These secondary instances configurable via the Aura console and API, where they can be launched, managed, or terminated. + • *Availability zones:* Distributed across availability zones to maintain high availability and performance. + • *Static configuration:* Currently, read-only secondaries are static and do not support elastic or auto-scaling behavior. + • *Region constraints:* Available only within the same region as their primary database instance (single region). + • *Pause/Resume:* When an AuraDB Enterprise database is paused and resumed, the count of read-only secondaries is retained. For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. -* Up to 15 static Read-Only Secondaries can be added per AuraDB Enterprise database instance. -* Single region only. -* Read-only secondaries available in same region as their Primary database. +[CAUTION] +==== +*Note:* Secondaries are currently not included in consumption reports. +==== -== Routing policy - -The following routing policy will apply when at least one secondary is available: - -Route READ to secondaries + non-leader primaries. This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability - -We will not support use cases for isolated workloads (customer routing) or multi region replication. +== Add secondaries using Aura console -// +Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. +Edit the number of secondaries directly through the Aura console. -Secondaries are orchestrated to maintain availability and balanced distribution across availability zones, ensuring optimal performance and cost efficiency. - -== Console UI - Create Secondaries +== Routing policy -Once this feature is enabled for your tenant you will see Secondary count set to Zero, and the ability to Edit secondaries in UI of the DB Overview and Details tile. * change grammar tense * +The following routing policy should apply when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* +This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. +It allows to further balance the READ and improve scalability. == Aura Provisioning API - simple request -Once enabled for the user’s tenant a GET instance details call will show secondary count +Using the Aura API, secondaries can be launched, managed, or terminated. + +Once enabled for the user’s tenant a GET instance details call will show secondary count. [source] ---- From 971c2841967c80aa24d3144ddb7d510b8621615a Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:01 +0100 Subject: [PATCH 05/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../auradb/managing-databases/read-only-secondaries.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 098317238..d8bde7cc7 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -4,7 +4,9 @@ label:AuraDB-Virtual-Dedicated-Cloud[] -Using read-only secondaries makes database reading much faster. A read-only secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the read-only secondary. In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. +Using secondary instances makes database reading faster. +A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. +In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. Read-only secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. From aba35cd3cad2f9bfb4a94a2a1c5a15b4b528ec34 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:07 +0100 Subject: [PATCH 06/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index d8bde7cc7..10c9f598b 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -1,5 +1,5 @@ [[aura-read-only-secondaries]] -= Read-only secondary instances += Secondary instances :description: The main responsibility of Read-only secondaries is to scale out read workloads. label:AuraDB-Virtual-Dedicated-Cloud[] From 5f90a0bcd5befd152db7f449209cb53557b0dfa9 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:13 +0100 Subject: [PATCH 07/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 10c9f598b..c01e6158d 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -8,7 +8,7 @@ Using secondary instances makes database reading faster. A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. -Read-only secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. +Secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. Up to 15 static read-only secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. From 5523b9c293546a6c888c147ceccd7a8316283499 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:20 +0100 Subject: [PATCH 08/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index c01e6158d..f6307090a 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -11,7 +11,7 @@ In this way, you can scale out beyond the capacity constraints of a single insta Secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. -Up to 15 static read-only secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. +Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. These secondaries can be added, managed, and removed through the Aura Console or the Aura API. == Read-only secondaries info: From 386b681373d406866202b5beda16ab1054f24590 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:38 +0100 Subject: [PATCH 09/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index f6307090a..66f897e29 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -19,7 +19,8 @@ These secondaries can be added, managed, and removed through the Aura Console or • *Availability zones:* Distributed across availability zones to maintain high availability and performance. • *Static configuration:* Currently, read-only secondaries are static and do not support elastic or auto-scaling behavior. • *Region constraints:* Available only within the same region as their primary database instance (single region). - • *Pause/Resume:* When an AuraDB Enterprise database is paused and resumed, the count of read-only secondaries is retained. For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. + • *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. + For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. [CAUTION] ==== From 95eb59aa3d49e8e28e88bd79594667ca71ad5925 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:32:57 +0100 Subject: [PATCH 10/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 66f897e29..4b3439a1a 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -1,6 +1,6 @@ [[aura-read-only-secondaries]] = Secondary instances -:description: The main responsibility of Read-only secondaries is to scale out read workloads. +:description: This section describes the use of secondary instances for scaling out read workloads. label:AuraDB-Virtual-Dedicated-Cloud[] From 9cc02e5a6575066ee08702cee751ec4c1b4d41cf Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:33:31 +0100 Subject: [PATCH 11/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 4b3439a1a..73a8a026c 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -17,7 +17,7 @@ These secondaries can be added, managed, and removed through the Aura Console or == Read-only secondaries info: • *Availability zones:* Distributed across availability zones to maintain high availability and performance. - • *Static configuration:* Currently, read-only secondaries are static and do not support elastic or auto-scaling behavior. + • *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. • *Region constraints:* Available only within the same region as their primary database instance (single region). • *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. From 605df25d010070fc58213b21cbf2c74b879d5e98 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:33:39 +0100 Subject: [PATCH 12/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index 73a8a026c..f9609702a 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -24,7 +24,7 @@ These secondaries can be added, managed, and removed through the Aura Console or [CAUTION] ==== -*Note:* Secondaries are currently not included in consumption reports. +Secondaries are currently not included in consumption reports. ==== == Add secondaries using Aura console From 59f94e8b254600b4a06e341cc8fa60e8f5bcbe36 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:49:39 +0100 Subject: [PATCH 13/26] change filename --- .../managing-databases/secondaries.adoc | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 modules/ROOT/pages/auradb/managing-databases/secondaries.adoc diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc new file mode 100644 index 000000000..f9609702a --- /dev/null +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -0,0 +1,94 @@ +[[aura-read-only-secondaries]] += Secondary instances +:description: This section describes the use of secondary instances for scaling out read workloads. + +label:AuraDB-Virtual-Dedicated-Cloud[] + +Using secondary instances makes database reading faster. +A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. +In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. + +Secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. +For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. + +Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. +These secondaries can be added, managed, and removed through the Aura Console or the Aura API. + +== Read-only secondaries info: + + • *Availability zones:* Distributed across availability zones to maintain high availability and performance. + • *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. + • *Region constraints:* Available only within the same region as their primary database instance (single region). + • *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. + For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. + +[CAUTION] +==== +Secondaries are currently not included in consumption reports. +==== + +== Add secondaries using Aura console + +Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. +Edit the number of secondaries directly through the Aura console. + +== Routing policy + +The following routing policy should apply when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* +This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. +It allows to further balance the READ and improve scalability. + +== Aura Provisioning API - simple request + +Using the Aura API, secondaries can be launched, managed, or terminated. + +Once enabled for the user’s tenant a GET instance details call will show secondary count. + +[source] +---- + +GET/instances/{instanceId]{ + "data": { + "cloud_provider": "azure", + "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", + "id": "xxxxxx", + "memory": "2GB", + "name": "Neo4j", + "region": "uk south", + "secondaries_count": 0, + "status": "running", + "storage": "4GB", + "tenant_id": "XXXXXXXXXXXXXXXXXXXX", + "type": "enterprise-db" + } +} + +---- + +PATCH/instances/{instanceId] +{ + "secondaries_count": 2 +}' + + +[source] +---- + +A simple Secondaries count patch request will request update { + "data": { + "cloud_provider": "azure", + "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", + "id": "xxxxxx", + "memory": "2GB", + "name": "Neo4j", + "region": "uk south", + "secondaries_count": 2, + "status": "running", + "storage": "4GB", + "tenant_id": "XXXXXXXXXXXXXXXXXXXXX", + "type": "enterprise-db" + } +} + + + From 38c6f4233b9258c6b4c9f096242c247ff327e117 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:50:15 +0100 Subject: [PATCH 14/26] Update modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- .../pages/auradb/managing-databases/read-only-secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc index f9609702a..2580f3933 100644 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc @@ -89,6 +89,6 @@ A simple Secondaries count patch request will request update { "type": "enterprise-db" } } - +---- From 8da59b9ea40a13754360a234182855163de4edaf Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:55:28 +0100 Subject: [PATCH 15/26] remove title --- modules/ROOT/pages/auradb/managing-databases/secondaries.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index f9609702a..30e1e4c1c 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -14,8 +14,6 @@ For workloads with heavy read operations, these secondaries prevent bottlenecks Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. These secondaries can be added, managed, and removed through the Aura Console or the Aura API. -== Read-only secondaries info: - • *Availability zones:* Distributed across availability zones to maintain high availability and performance. • *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. • *Region constraints:* Available only within the same region as their primary database instance (single region). From 06fc3bbe19dfc5f89a57ca63d5ab5e16efdf8337 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:56:31 +0100 Subject: [PATCH 16/26] remove file --- .../read-only-secondaries.adoc | 94 ------------------- 1 file changed, 94 deletions(-) delete mode 100644 modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc diff --git a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc deleted file mode 100644 index 2580f3933..000000000 --- a/modules/ROOT/pages/auradb/managing-databases/read-only-secondaries.adoc +++ /dev/null @@ -1,94 +0,0 @@ -[[aura-read-only-secondaries]] -= Secondary instances -:description: This section describes the use of secondary instances for scaling out read workloads. - -label:AuraDB-Virtual-Dedicated-Cloud[] - -Using secondary instances makes database reading faster. -A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. -In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. - -Secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. -For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. - -Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. -These secondaries can be added, managed, and removed through the Aura Console or the Aura API. - -== Read-only secondaries info: - - • *Availability zones:* Distributed across availability zones to maintain high availability and performance. - • *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. - • *Region constraints:* Available only within the same region as their primary database instance (single region). - • *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. - For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. - -[CAUTION] -==== -Secondaries are currently not included in consumption reports. -==== - -== Add secondaries using Aura console - -Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. -Edit the number of secondaries directly through the Aura console. - -== Routing policy - -The following routing policy should apply when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* -This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. -It allows to further balance the READ and improve scalability. - -== Aura Provisioning API - simple request - -Using the Aura API, secondaries can be launched, managed, or terminated. - -Once enabled for the user’s tenant a GET instance details call will show secondary count. - -[source] ----- - -GET/instances/{instanceId]{ - "data": { - "cloud_provider": "azure", - "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", - "id": "xxxxxx", - "memory": "2GB", - "name": "Neo4j", - "region": "uk south", - "secondaries_count": 0, - "status": "running", - "storage": "4GB", - "tenant_id": "XXXXXXXXXXXXXXXXXXXX", - "type": "enterprise-db" - } -} - ----- - -PATCH/instances/{instanceId] -{ - "secondaries_count": 2 -}' - - -[source] ----- - -A simple Secondaries count patch request will request update { - "data": { - "cloud_provider": "azure", - "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", - "id": "xxxxxx", - "memory": "2GB", - "name": "Neo4j", - "region": "uk south", - "secondaries_count": 2, - "status": "running", - "storage": "4GB", - "tenant_id": "XXXXXXXXXXXXXXXXXXXXX", - "type": "enterprise-db" - } -} ----- - - From b0e88567c77ee3e59b078a7fc1d976744a52aac4 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:57:47 +0100 Subject: [PATCH 17/26] update content nav --- modules/ROOT/content-nav.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 7dd77ff8f..df4a7ea41 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -57,7 +57,7 @@ AuraDB Start ** xref:auradb/managing-databases/monitoring.adoc[] ** xref:auradb/managing-databases/backup-restore-export.adoc[] ** xref:auradb/managing-databases/advanced-metrics.adoc[] -** xref:auradb/managing-databases/read-only-secondaries.adoc[] +** xref:auradb/managing-databases/secondaries.adoc[] * xref:auradb/connecting-applications/overview.adoc[Connecting applications] //// From 1d82aaffb0b5064c5eb2c46eec977a9848920b57 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:37:34 +0100 Subject: [PATCH 18/26] add link to API --- .../managing-databases/secondaries.adoc | 63 ++----------------- 1 file changed, 6 insertions(+), 57 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index 30e1e4c1c..1a17148f5 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -25,68 +25,17 @@ These secondaries can be added, managed, and removed through the Aura Console or Secondaries are currently not included in consumption reports. ==== -== Add secondaries using Aura console +== Edit secondaries using Aura console Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. Edit the number of secondaries directly through the Aura console. +== Edit secondaries using the Aura API + +To edit the secondary instance count for your database, you can use the following API that link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[edits the instance configuration] + == Routing policy The following routing policy should apply when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. -It allows to further balance the READ and improve scalability. - -== Aura Provisioning API - simple request - -Using the Aura API, secondaries can be launched, managed, or terminated. - -Once enabled for the user’s tenant a GET instance details call will show secondary count. - -[source] ----- - -GET/instances/{instanceId]{ - "data": { - "cloud_provider": "azure", - "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", - "id": "xxxxxx", - "memory": "2GB", - "name": "Neo4j", - "region": "uk south", - "secondaries_count": 0, - "status": "running", - "storage": "4GB", - "tenant_id": "XXXXXXXXXXXXXXXXXXXX", - "type": "enterprise-db" - } -} - ----- - -PATCH/instances/{instanceId] -{ - "secondaries_count": 2 -}' - - -[source] ----- - -A simple Secondaries count patch request will request update { - "data": { - "cloud_provider": "azure", - "connection_url": "neo4j+s://xxxxxx.databases.neo4j.io", - "id": "xxxxxx", - "memory": "2GB", - "name": "Neo4j", - "region": "uk south", - "secondaries_count": 2, - "status": "running", - "storage": "4GB", - "tenant_id": "XXXXXXXXXXXXXXXXXXXXX", - "type": "enterprise-db" - } -} - - - +It allows to further balance the READ and improve scalability. \ No newline at end of file From 74ef8a38968636093a36e9d2aca3b2494c3c4c9f Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:51:34 +0100 Subject: [PATCH 19/26] edit list formatting --- .../pages/auradb/managing-databases/secondaries.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index 1a17148f5..cf527a452 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -14,10 +14,10 @@ For workloads with heavy read operations, these secondaries prevent bottlenecks Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. These secondaries can be added, managed, and removed through the Aura Console or the Aura API. - • *Availability zones:* Distributed across availability zones to maintain high availability and performance. - • *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. - • *Region constraints:* Available only within the same region as their primary database instance (single region). - • *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. +* *Availability zones:* Distributed across availability zones to maintain high availability and performance. +* *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. +* *Region constraints:* Available only within the same region as their primary database instance (single region). +* *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. [CAUTION] @@ -32,7 +32,7 @@ Edit the number of secondaries directly through the Aura console. == Edit secondaries using the Aura API -To edit the secondary instance count for your database, you can use the following API that link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[edits the instance configuration] +To edit the secondary instance count for your database, you can use the following API that link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[edits the instance configuration]. == Routing policy From afe950b5d1deccc6d5c15a147e6ca3e000daf4ac Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Fri, 6 Sep 2024 10:52:48 +0100 Subject: [PATCH 20/26] Update modules/ROOT/pages/auradb/managing-databases/secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- modules/ROOT/pages/auradb/managing-databases/secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index cf527a452..120d8ed2c 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -32,7 +32,7 @@ Edit the number of secondaries directly through the Aura console. == Edit secondaries using the Aura API -To edit the secondary instance count for your database, you can use the following API that link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[edits the instance configuration]. +You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/{instanceId}`] endpoint. == Routing policy From bf955a705728eb304ef2a43e09688e2399567019 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Fri, 6 Sep 2024 10:52:57 +0100 Subject: [PATCH 21/26] Update modules/ROOT/pages/auradb/managing-databases/secondaries.adoc Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com> --- modules/ROOT/pages/auradb/managing-databases/secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index 120d8ed2c..bc01898b0 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -36,6 +36,6 @@ You can edit the secondary instance count for your database with the link:https: == Routing policy -The following routing policy should apply when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* +The following routing policy applies when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. \ No newline at end of file From ed1df710805b4e7f553d999a1e281ecf4038635f Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Fri, 6 Sep 2024 11:35:11 +0100 Subject: [PATCH 22/26] move routing policy --- .../auradb/managing-databases/secondaries.adoc | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index bc01898b0..aeb5c77ba 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -16,13 +16,16 @@ These secondaries can be added, managed, and removed through the Aura Console or * *Availability zones:* Distributed across availability zones to maintain high availability and performance. * *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. -* *Region constraints:* Available only within the same region as their primary database instance (single region). -* *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. - For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. +* *Region constraints:* Available only within the same region as their primary database instance (single region). +* *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. +For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. +* *The following routing policy applies when at least one secondary is available:* Route READ to secondaries + non-leader primaries. +This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. +It allows to further balance the READ and improve scalability. [CAUTION] ==== -Secondaries are currently not included in consumption reports. +Secondaries will be included in manual consumption reports that a customer gets from their CSM, and their invoices, but they won't be included in the Billing screens in the Console yet. ==== == Edit secondaries using Aura console @@ -33,9 +36,3 @@ Edit the number of secondaries directly through the Aura console. == Edit secondaries using the Aura API You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/{instanceId}`] endpoint. - -== Routing policy - -The following routing policy applies when at least one secondary is available: *Route READ to secondaries + non-leader primaries.* -This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. -It allows to further balance the READ and improve scalability. \ No newline at end of file From be4f101d219a8553c03cb360746fb1b94fbab8cb Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Fri, 6 Sep 2024 16:17:27 +0100 Subject: [PATCH 23/26] remove banner --- .../ROOT/pages/auradb/managing-databases/secondaries.adoc | 5 ----- 1 file changed, 5 deletions(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index aeb5c77ba..daa04c072 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -23,11 +23,6 @@ For example, if a database with 3 secondaries is paused, it will resume with the This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. -[CAUTION] -==== -Secondaries will be included in manual consumption reports that a customer gets from their CSM, and their invoices, but they won't be included in the Billing screens in the Console yet. -==== - == Edit secondaries using Aura console Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. From d561d6e77ed84460a65aaed2a533b3a1f1ceec18 Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Wed, 18 Sep 2024 14:15:56 +0100 Subject: [PATCH 24/26] Update modules/ROOT/pages/auradb/managing-databases/secondaries.adoc Co-authored-by: Nicola Vitucci --- modules/ROOT/pages/auradb/managing-databases/secondaries.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index daa04c072..894880fef 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -30,4 +30,4 @@ Edit the number of secondaries directly through the Aura console. == Edit secondaries using the Aura API -You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/{instanceId}`] endpoint. +You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/\{instanceId}`] endpoint. From 26c43d5146a07c4027032dad39f3032d1be94dbb Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Wed, 25 Sep 2024 21:55:16 +0200 Subject: [PATCH 25/26] change to secondary instances --- modules/ROOT/content-nav.adoc | 2 +- .../managing-databases/secondaries.adoc | 26 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index df4a7ea41..107622621 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -57,7 +57,7 @@ AuraDB Start ** xref:auradb/managing-databases/monitoring.adoc[] ** xref:auradb/managing-databases/backup-restore-export.adoc[] ** xref:auradb/managing-databases/advanced-metrics.adoc[] -** xref:auradb/managing-databases/secondaries.adoc[] +** xref:auradb/managing-databases/secondary-instances.adoc[] * xref:auradb/connecting-applications/overview.adoc[Connecting applications] //// diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc index 894880fef..b0d4d6cbb 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc @@ -1,4 +1,4 @@ -[[aura-read-only-secondaries]] +[[aura-read-only-secondary-instances]] = Secondary instances :description: This section describes the use of secondary instances for scaling out read workloads. @@ -8,26 +8,26 @@ Using secondary instances makes database reading faster. A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. -Secondaries are distributed across availability zones to ensure high availability, performance, and cost efficiency. -For workloads with heavy read operations, these secondaries prevent bottlenecks and allow batch processing. +Secondary instances are distributed across availability zones to ensure high availability, performance, and cost efficiency. +For workloads with heavy read operations, secondary instances prevent bottlenecks and allow batch processing. -Up to 15 static secondaries can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. -These secondaries can be added, managed, and removed through the Aura Console or the Aura API. +Up to 15 static secondary instances can be added per database instance, significantly increasing read capacity to handle read-heavy workloads. +Secondary instances can be added, managed, and removed through the Aura Console or the Aura API. * *Availability zones:* Distributed across availability zones to maintain high availability and performance. -* *Static configuration:* Currently, secondaries are static and do not support elastic or auto-scaling behavior. +* *Static configuration:* Currently, secondary instances are static and do not support elastic or auto-scaling behavior. * *Region constraints:* Available only within the same region as their primary database instance (single region). -* *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondaries is retained. -For example, if a database with 3 secondaries is paused, it will resume with the same number of secondaries. -* *The following routing policy applies when at least one secondary is available:* Route READ to secondaries + non-leader primaries. -This policy extends the READ payload to the primaries that are not currently serving in an elected leader role. +* *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondary instances is retained. +For example, if a database with 3 secondary instances is paused, it will resume with the same number of secondary instances. +* *The following routing policy applies when at least one secondary instance is available:* Route READ to secondary instances + non-leader primaries. +This policy extends the READ payload to the primary instances that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. -== Edit secondaries using Aura console +== Edit secondary instances using Aura console -Once the secondaries feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. +Once the feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. Edit the number of secondaries directly through the Aura console. -== Edit secondaries using the Aura API +== Edit secondary instances using the Aura API You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/\{instanceId}`] endpoint. From 1e17b2183cf3e42a684d20e3c50a5715ce908ceb Mon Sep 17 00:00:00 2001 From: Fi Quick <47183728+fiquick@users.noreply.github.com> Date: Thu, 26 Sep 2024 17:59:19 +0200 Subject: [PATCH 26/26] secondary edit --- .../{secondaries.adoc => secondary-instances.adoc} | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename modules/ROOT/pages/auradb/managing-databases/{secondaries.adoc => secondary-instances.adoc} (71%) diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondary-instances.adoc similarity index 71% rename from modules/ROOT/pages/auradb/managing-databases/secondaries.adoc rename to modules/ROOT/pages/auradb/managing-databases/secondary-instances.adoc index b0d4d6cbb..dc942edff 100644 --- a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc +++ b/modules/ROOT/pages/auradb/managing-databases/secondary-instances.adoc @@ -1,11 +1,11 @@ -[[aura-read-only-secondary-instances]] +[[aura-secondary-instances]] = Secondary instances :description: This section describes the use of secondary instances for scaling out read workloads. label:AuraDB-Virtual-Dedicated-Cloud[] Using secondary instances makes database reading faster. -A secondary instance is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. +A secondary is a read-only copy of an instance that reduces the load on your primary instance by routing queries from your applications to the secondary. In this way, you can scale out beyond the capacity constraints of a single instance for read-heavy workloads. Secondary instances are distributed across availability zones to ensure high availability, performance, and cost efficiency. @@ -18,16 +18,16 @@ Secondary instances can be added, managed, and removed through the Aura Console * *Static configuration:* Currently, secondary instances are static and do not support elastic or auto-scaling behavior. * *Region constraints:* Available only within the same region as their primary database instance (single region). * *Pause/Resume:* When an AuraDB Virtual Dedicated Cloud database is paused and resumed, the count of secondary instances is retained. -For example, if a database with 3 secondary instances is paused, it will resume with the same number of secondary instances. -* *The following routing policy applies when at least one secondary instance is available:* Route READ to secondary instances + non-leader primaries. +For example, if a database with 3 secondary instances is paused, it will resume with 3 secondary instances. +* *The following routing policy applies when at least one secondary is available:* Route READ to secondary instances + non-leader primary instances. This policy extends the READ payload to the primary instances that are not currently serving in an elected leader role. It allows to further balance the READ and improve scalability. == Edit secondary instances using Aura console -Once the feature is enabled for your tenant, you will see the secondary count set to zero in the UI of the *Database Overview and Details* tile. -Edit the number of secondaries directly through the Aura console. +Once the feature is enabled for your tenant, you will see the secondary instances count set to zero on an instance card. +To edit the number of secondary instances via the Aura console, click the three dots on an instance card. == Edit secondary instances using the Aura API -You can edit the secondary instance count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/\{instanceId}`] endpoint. +You can edit the secondary count for your database with the link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/patch-instance-id[`/instances/\{instanceId}`] endpoint.