Bootstrap object

An object for bootstrap configuration

A bootstrap configuration object.

Name Type/Value Description
action 'create_cluster'
Action to perform
cluster cluster_identity object Cluster to join or create
cnm_https_port integer Port to join a cluster with non-default cnm_https port
crdb_coordinator_port integer, (range: 1024-65535) (default: 9081) CRDB coordinator port
credentials credentials object Cluster admin credentials

  "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_port integer, (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_port integer, (range: 1024-65535) Envoy management server port
gossip_envoy_admin_port integer, (range: 1024-65535) Gossip envoy admin port
license string License string. If not provided, a trial license is set by default.
max_retries integer Max number of retries in case of recoverable errors
node node_identity object Node description
policy policy object Policy object
recovery_filename string Name of backup file to recover from
required_version string This node can only join the cluster if all nodes in the cluster have a version greater than the required_version
retry_time integer Max waiting time between retries (in seconds)
Back to top ↑