A bootstrap configuration object.

NameType/ValueDescription
action‘create_cluster’
‘join_cluster’
‘recover_cluster’		Action to perform
clustercluster_identity objectCluster to join or create
cnm_https_portintegerPort to join a cluster with non-default cnm_https port
crdb_coordinator_portinteger, (range: 1024-65535) (default: 9081)CRDB coordinator port
credentialscredentials objectCluster admin credentials
dns_suffixes

[{
  "name": string,
  "cluster_default": boolean,
  "use_aaaa_ns": boolean,
  "use_internal_addr": boolean,
  "slaves": array
}, ...]
Explicit configuration of DNS suffixes
name: DNS suffix name
cluster_default: Should this suffix be the default cluster suffix
use_aaaa_ns: Should AAAA records be published for NS records
use_internal_addr: Should internal cluster IPs be published for databases
slaves: List of replica servers that should be published as NS and notified
envoy_admin_portinteger, (range: 1024-65535)Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.
envoy_mgmt_server_portinteger, (range: 1024-65535)Envoy management server port
gossip_envoy_admin_portinteger, (range: 1024-65535)Gossip envoy admin port
licensestringLicense string. If not provided, a trial license is set by default.
max_retriesintegerMax number of retries in case of recoverable errors
nodenode_identity objectNode description
policypolicy objectPolicy object
recovery_filenamestringName of backup file to recover from
required_versionstringThis node can only join the cluster if all nodes in the cluster have a version greater than the required_version
retry_timeintegerMax waiting time between retries (in seconds)