Setting Host Properties When Provisioning Hosts

The following table describes the properties that are frequently used when provisioning a host. For complete descriptions of all properties, see Host Properties (default.properties).

Host Property Name Description

domain

domainPassword

The domain property specifies the name of the domain. This property must be set to the same value on every host in a domain. The default domain name is domain.

The domainPassword property sets the password used by this broker or agent to join the named domain. Every broker and agent in the domain uses the same password to peer into the domain. In other words, the domainPassword property is set to the same value on every host in a domain. This enables:

  • Every broker and agent to securely connect.
  • Bootstrapping creation of the initial domain administrator account. See About Domain Credentials.

For security reasons, there is no default password. As with all properties in the default.properties file , leading and trailing whitespace is ignored.

region

Automation and availability use the concept of a region, which is a string property you can use to tag a host. For example, when you add a data center you can choose a different region.

peer

Specifies an existing broker in the domain through which this new host will initially enter the domain. Always use address and port, for example "ec2-21-20-22-171:48004". Make sure that the address and port are accessible. For example, you can use telnet and issue a special short command "~~~~stat " (4 tilde characters following by stat) to the broker:

$ telnet ec2-21-20-22-171 48004 
Trying 127.0.0.1...
Connected to ec2-21-20-22-171.
Escape character is '^]'.
~~~~stat  
<ok/>
Connection closed by foreign host.

altAddr

advertiseAlt

The altAddr property sets an alternate address on the host, which tells the management tier that there is an additional address by which the host is known. On Amazon AWS, for example, there is a private address (configured on the server) and the public address (only known through the AWS APIs). In order for this alternate address to be used anywhere, however, it must be advertised (advertiseAlt).

The advertiseAlt property tells the broker whether to use the native or the alternate form when advertising the host in all cases. This is how peer formation is driven and how SQL/management clients connect. The reason for this property is that you might want one broker advertising the internal addresses and another advertising the alternate form (for example, for clients connecting from outside a network).

Amazon is the canonical platform where this feature is used.

removeSelfOnShutdown

The default is that this property is set to false, which means that this broker remains in the durable domain configurationThe durable domain configuration provides domain configuration information that is stored consistently on each broker in the domain by means of a Raft log. after it shuts down. Set this property to true if a broker JVM termination (kill -TERM, including service restart) should remove itself from the durable domain configuration.

NuoDB recommends that deployments use the default (false) while development projects use true.