From 64e84cfe04733a7fb1602afba56662ef24e813bf Mon Sep 17 00:00:00 2001
From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com>
Date: Tue, 4 Jul 2023 15:20:17 +0100
Subject: [PATCH] Automatically enable free servers (#837)

The ability to automatically enable free servers results in the
following docs change:
1. Addition of a config setting
`initial.dbms.automatically_enable_free_servers`
2. Adjustment of `dbms.showTopologyGraphConfig()` procedure's output
3. Introduction of `dbms.cluster.setAutomaticallyEnableFreeServers()`
procedure
---
 .../configuration/configuration-settings.adoc | 16 +++++++++++++++
 modules/ROOT/pages/reference/procedures.adoc  | 20 ++++++++++++++++++-
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc
index 9279ce8b4..81f23729b 100644
--- a/modules/ROOT/pages/configuration/configuration-settings.adoc
+++ b/modules/ROOT/pages/configuration/configuration-settings.adoc
@@ -571,6 +571,22 @@ a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default
 m|+++20m+++
 |===
 
+[[config_initial.dbms.automatically_enable_free_servers]]
+=== `initial.dbms.automatically_enable_free_servers`
+
+label:enterprise-edition[Enterprise Edition]
+
+.initial.dbms.automatically_enable_free_servers
+[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
+|===
+|Description
+a|Automatically enable free servers.
+|Valid values
+a|a boolean
+|Default value
+m|+++false+++
+|===
+
 [[config_initial.dbms.database_allocator]]
 === `initial.dbms.database_allocator`
 
diff --git a/modules/ROOT/pages/reference/procedures.adoc b/modules/ROOT/pages/reference/procedures.adoc
index 7d5a0dc69..b391f9753 100644
--- a/modules/ROOT/pages/reference/procedures.adoc
+++ b/modules/ROOT/pages/reference/procedures.adoc
@@ -210,6 +210,11 @@ In 4.2, signature changed to `db.listLocks() :: (mode :: STRING?, resourceType :
 // Internal
 // dbms.clientConfig()
 
+| xref:reference/procedures.adoc#procedure_dbms_cluster_setAutomaticallyEnableFreeServers[`dbms.cluster.setAutomaticallyEnableFreeServers()`]
+| label:no[]
+| label:yes[]
+| label:admin-only[]
+
 | xref:reference/procedures.adoc#procedure_dbms_cluster_checkConnectivity[`dbms.cluster.checkConnectivity()`]
 | label:no[]
 | label:yes[]
@@ -1226,6 +1231,19 @@ m|DBMS
 // m|admin
 |===
 
+[[procedure_dbms_cluster_setAutomaticallyEnableFreeServers]]
+.dbms.cluster.setAutomaticallyEnableFreeServers() label:enterprise-edition[] label:admin-only[]
+[cols="<15s,<85"]
+|===
+| Description
+a|
+With this method you can set whether free servers are automatically enabled.
+| Signature
+m|dbms.cluster.setAutomaticallyEnableFreeServers(autoEnable :: BOOLEAN?)
+| Mode
+m|WRITE
+|===
+
 [[procedure_dbms_cluster_checkConnectivity]]
 .dbms.cluster.checkConnectivity() label:enterprise-edition[] label:admin-only[]
 [cols="<15s,<85"]
@@ -1739,7 +1757,7 @@ m|DBMS
 | Description
 a| With this method the configuration of the Topology Graph can be displayed.
 | Signature
-m|dbms.showTopologyGraphConfig() :: (allocator :: STRING?, defaultPrimariesCount :: INTEGER?, defaultSecondariesCount :: INTEGER?, defaultDatabase :: STRING?)
+m|dbms.showTopologyGraphConfig() :: (allocator :: STRING?, defaultPrimariesCount :: INTEGER?, defaultSecondariesCount :: INTEGER?, defaultDatabase :: STRING?, autoEnableFreeServers :: BOOLEAN?)
 | Mode
 m|READ
 |===