Scribd
Upload
64 views7 pages

Table A.1, "Voltdb Port Usage" Section A.5.8, "TLS/SSL Encryption (Including

This document summarizes the network ports used by VoltDB and how to configure them. It provides the default port values for the client port, admin port, web interface ports, internal server port, replication port, and Zookeeper port. It describes how to change the port values either through the VoltDB start command or configuration file. The document also provides examples of connecting to non-default ports in Java and C++ client applications.

Uploaded by

CSK
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
64 views7 pages

Table A.1, "Voltdb Port Usage" Section A.5.8, "TLS/SSL Encryption (Including

This document summarizes the network ports used by VoltDB and how to configure them. It provides the default port values for the client port, admin port, web interface ports, internal server port, replication port, and Zookeeper port. It describes how to change the port values either through the VoltDB start command or configuration file. The document also provides examples of connecting to non-default ports in Java and C++ client applications.

Uploaded by

CSK
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

A.5.

Network Ports
A VoltDB cluster opens network ports to manage its own operation and to
provide services to client applications. When using the command line, the
network ports are configurable as part of the command that starts the VoltDB
database process or through the configuration file. When specifying a port on
the command line, you can specify just a port number or the network interface
and the port number, separated by a colon.
Table A.1, “VoltDB Port Usage” summarizes the ports that VoltDB uses, their
default value, and how to change the default. The following sections describe
each port in more detail. Section A.5.8, “TLS/SSL Encryption (Including
HTTPS)” explains how to enable TLS encryption for the web port and the
programming interface ports, client and admin.
Table A.1. VoltDB Port Usage
Default
Port How to Set
Value
Client Port 21212 VoltDB start command
VoltDB start command line or
Admin Port 21211
configuration file
VoltDB start command line or
Web Interface Port (httpd) 8080
configuration file
Web Interface Port VoltDB start command line or
8443
(withTSL/SSLenabled) configuration file
Internal Server Port 3021 VoltDB start command line
Replication Port 5555 VoltDB start command line
Zookeeper port 7181 VoltDB start command line

A.5.1.Client Port
The client port is the port VoltDB client applications use to communicate with
the database cluster nodes. By default, VoltDB uses port 21212 as the client
port. You can change the client port. However, all client applications must
then use the specified port when creating connections to the cluster nodes.
To specify a different client port on the command line, use the --client flag
when starting the VoltDB database. For example, the following command
starts the database using port 12345 as the client port:
$ voltdb start -l ~/license.xml \
--dir=~/mydb -H serverA \

--client=12345

If you change the default client port, all client applications must also connect
to the new port. The client interfaces for Java and C++ accept an additional,
optional argument to the createConnection method for this purpose. The
following examples demonstrate how to connect to an alternate port using the
Java and C++ client interfaces.

Java
org.voltdb.client.Client voltclient;
voltclient = ClientFactory.createClient();
voltclient.createConnection("myserver",12345);

C++
boost::shared_ptr<voltdb::Client> client =
voltdb::Client::create();
client->createConnection("myserver", 12345);

A.5.2.Admin Port
The admin port is similar to the client port, it accepts and processes requests
from applications. However, the admin port has the special feature that it
continues to accept write requests when the database enters admin, or read-
only, mode.
By default, VoltDB uses port 21211 on the default external network interface
as the admin port. You can change the port assignment in the configuration
file using the <admin-mode> tag or on the command line using the --
admin flag. For example, the following configuration file sets the admin port to
2222:
<deployment>
...

<admin-mode port="2222" />

</deployment>
The same effect can be achieved using the --admin flag on the command
line:
$ voltdb start -l ~/license.xml \
--dir=~/mydb -H serverA \

--admin=2222

When the admin port is set in both the configuration file and on the command
line, the command line setting supersedes the configuration file.

A.5.3.Web Interface Port (httpd)


The web interface port is the port that VoltDB listens to for web-based
connections. This port is used for both the JSON interface and access to the
VoltDB Management Center. There are two related attributes associated with
the web interface. The first attribute is whether the port is enabled. If the port
is not enabled, then neither the JSON interface nor the Management Center
are available from the cluster. The second attribute is which port to use. (Note
that you can also use the –http flag on the command line to set the httpd
port.) By default, the web interface is enabled and the default port is 8080.
You can also enable TLS (Transport Layer Security) encryption on the web
interface so that all interaction uses the HTTPS protocol. When TLS is
enabled, the default port changes to 8443. See Section A.5.8, “TLS/SSL
Encryption (Including HTTPS)” for information on enabling encryption in the
configuration file.

A.5.4.JSON Interface
In addition to the overall availability and port for the web interface, you can
also specify separately whether the JSON interface is available. To enable
the httpd port but disable the JSON interface, specify the attribute =
enabled="false" in the <jsonapi> tag in the deployment file when starting
VoltDB. For example, the following deployment file fragment enables the web
interface and the JSON interface, specifying the alternate port 8083.
<httpd port="8083">
<jsonapi enabled="true"/>

</httpd>
If you change the port number, be sure to use the new port number when
connecting to the cluster using the JSON interface. For example, the
following URL connects to the port 8083, instead of 8080:
http://athena.mycompany.com:8083/api/1.0/?
Procedure=@SystemInformation

For more information about the JSON interface, see the section on "How the
JSON Interface Works" in the Using VoltDB manual.

A.5.5.Internal Server Port


A VoltDB cluster uses ports to communicate among the cluster nodes. This
port is internal to VoltDB and should not be used by other applications.
By default, the internal server port is port 3021 for all nodes in t1he cluster[2].
You can specify an alternate port using the –internal flag when starting the
VoltDB process. For example, the following command starts the VoltDB
process using an internal port of 4000:
$ voltdb start -l ~/license.xml \
--dir=~/mydb -H serverA \

--internal=4000

A.5.6.Replication Port
During database replication, producer databases (that is, the master
database in passive DR and all clusters in XDCR) use a dedicated port to
share data to their consumers. By default, the replication port is port 5555.
You can use a different port by specifying a different port number either on
the voltdb command line or in the configuration file when starting the cluster.
 On the command line, use the –replication flag to specify a
different port (and, optionally, a different network interface):
$ voltdb start -l ~/license.xml \
--dir=~/mydb -H serverA \

--replication=6666

 In the configuration file, specify the replication port number


using the portattribute of the <dr> tag:
<dr id="3" port="6666" />
Adding the replication port to the configuration file is useful when setting the
port for all nodes in the cluster. Using the command line option is useful for
changing the default port for only one node in the cluster or for specifying a
specific network interface. If you specify the replication port in both the
configuration file and on the command line, the command line argument takes
precedence.
Note that if you set the replication port on the producer to something other
than the default, you must notify the consumers of this change. The replica or
other XDCR clusters must specify the port along with the network address or
hostname in the src attribute of the <connection>element when configuring
the DR relationship. For example, if the server nyc2 has changed its
replication port to 3333, another cluster in the XDCR relationship might have
the following configuration:
<dr id="1" role="xdcr" >
<connection source="nyc1,nyc2:3333" />

</dr>

Finally, in some cloud environments, such as Kubernetes, remote clusters


may not be able to access the producer cluster by its internal network
interface. Consumers can specify the location of the producer in the DR
configuration using a remapped IP address. But once they initialize contact
with the producer, the producer sends a list of IP addresses to use for
ongoing replication. By default, these are the internal addresses the producer
cluster knows about.
You can tell the producer to advertise a different interface (and port) for this
second phase by specifying the alternate interface using the--drpublic
argument in the voltdb start command. If you do not specify a port on the --
drpublicargument, the internal replication port is used. For example:
$ voltdb start --drpublic=some.external.addr

A.5.7.Zookeeper Port
VoltDB uses a version of Apache Zookeeper to communicate among
supplementary functions that require coordination but are not directly tied to
database transactions. Zookeeper provides reliable synchronization for
functions such as command logging without interfering with the database's
own internal communications.
VoltDB uses a network port bound to the local interface (127.0.0.1) to interact
with Zookeeper. By default, 7181 is assigned as the Zookeeper port for
VoltDB. You can specify a different port number using the --zookeeper lag
when starting the VoltDB process. It is also possible to specify a different
network interface, like with other ports. However, accepting the default for the
zookeeper network interface is recommended where possible. For example:
$ voltdb start -l ~/license.xml \
--dir=~/mydb -H serverA \

--zookeeper=2288

A.5.8.TLS/SSL Encryption (Including HTTPS)


VoltDB lets you enable Transport Layer Security (TLS) — the recommended
upgrade from Secure Socket Layer (SSL) encryption — for all of its
externally-facing interfaces: the web port, client port, admin port, and
replication (DR) port. When you enable TLS, you automatically enable
encryption for the web port. You can then optionally enable encryption for the
external ports (client and admin) and/or the replication port.
To enable TLS encryption you need an appropriate certificate. How you
configure TLS depends on whether you create a local certificate or receive
one from an authorized certificate provider, such as VeriSign, GeoTrust and
others. If you use a commercial certificate, you only need to identify the
certificate as the key store. If you create your own, you must specify both the
key store and the trust store. (See the section onusing TLS/SSL for security
=in the Using VoltDB manual for an example of creating your own certificate.)
You enable TLS encryption in the deployment file using the <ssl> element.
Within <ssl> you specify the location and password for the key store and, for
locally generated certificates, the trust store in separate elements like so:
<ssl>
<keystore path="/etc/mydb/keystore" password="twiddledee"/
>
<truststore path="/etc/mydb/truststore"
password="twiddledum"/>
</ssl>
When you enable the <ssl> element in the configuration file, TLS encryption
is enabled for the web port and all access to the httpd port and JSON
interface must use the HTTPS protocol. When you enable TLS, the default
web port changes from 8080 to 8443.
You can explicitly enable or disable TLS encryption by including the
enableattribute. (For example, if you want to include the key store and trust
store in the configuration but not turn on TLS during testing, you can include
enabled="false".) You can specify that the client and admin API ports are
also TLS encrypted by adding the external attribute and setting it to true.
Similarly, you can enable TLS encryption for the DR port by adding thedr
attribute. For example, the following configuration sample, explicitly enables
TLS for all externally-facing ports:
<ssl enabled="true" external="true" dr="true">
<keystore path="/etc/mydb/keystore" password="twiddledee"/
>
<truststore path="/etc/mydb/truststore"
password="twiddledum"/>
</ssl>

Note that you cannotdisable TLS encryption for the web port separately. TLS
is always enabled for the web port if you enable encryption for any ports.

You might also like