Network requirements

Daria Barysheva

Overview

The network requirements for Arenadata DB installation are listed below:

  • One or more dedicated and separate peer-to-peer Interconnect networks are required for internal cluster communication.

  • All cluster hosts should be connected to Interconnect networks.

  • All cluster hosts should have IP addresses and the ability to communicate with each other at required speeds.

  • Ping access to any cluster host (ICMP) should be provided.

  • The jumbo frame MTU = 9000 should be specified in Interconnect networks to allow packets formed by ADB (gp_max_packet_size + overhead) to fit into these frames.

  • The Ethernet speed 1 Gbps or more should be provided (the standard value is 10 Gbps).

  • There should be no firewall or other software that blocks or slows down the traffic (firewalld, iptables, ufw, etc.). If firewall software is not deactivated, you should configure your software to allow required communication between ADB hosts. For more information, see Greenplum documentation.

  • From the outside, the ADB cluster should be available on the following ports:

    • 22 — SSH;

    • 5432 — income PostgreSQL interface.

  • To access NTP (Network Time Protocol) servers, the master host should be allowed to connect to it (by default, via the 123/udp port).

  • To send cluster component statuses to Arenadata Cluster Manager (ADCM), ADB hosts should be allowed to connect to it (by default, via the 8000/tcp port). See the Install ADCM article for details on how to install ADCM.

  • On the host where the monitoring cluster is installed, the ports 3000/tcp (default Grafana port) and 80/tcp (default Graphite port) should be open. The default values can be changed via ADCM. The monitoring cluster installation is described in the Online installation and Offline installation sections.

  • To send metrics to the monitoring cluster, ADB hosts should be allowed to connect to it (by default, via the 2015/tcp, 2016/udp ports).

  • For offline installation of ADB, access to Arenadata Enterprise Tools repositories deployed on a dedicated host is required (by default, via the 81/tcp port). The Install Enterprise Tools cluster section contains instructions on how to install Arenadata Enterprise Tools.

  • All ports that are listed below should be open on the respective hosts. If you use firewall, add ports to the exception list.

Ports

ADB ports

  • Master/standby

  • All cluster hosts

  • Cluster or external hosts

  • ADQM/ClickHouse host

Service Port Protocol Note

ADB

5432

TCP

SQL client connection port on the ADB master host. Supports clients using the PostgreSQL libpq API. Configurable

Standby master replicator

1025-65535

TCP

Ports for replication the master log to the standby master
Service Port Protocol Note

Secure shell (SSH): gpssh, gpscp, gpssh-exkeys, gppkg

22

SSH

Many Greenplum utilities use SCP (Secure Copy Protocol) and SSH to manage a cluster and transfer files between hosts

Interconnect

10000-65535

UDP

The Interconnect transports database tuples between ADB segments during query execution (for exact ports refer to the gp_segment_configuration system view)

Gpperfmon agents

8888

TCP

Connection port for gpperfmon agents (gpmmon and gpsmon) executing on ADB hosts. Configure by setting the gpperfmon_port parameter in postgresql.conf on master and segment hosts

PXF

5888

TCP

The PXF Java service runs on the 5888 port on each ADB segment host

gpbackup

25

587

TCP

 — 
Service Port Protocol Note

gpfdist

8080

HTTP

The gpfdist file serving utility can run on ADB hosts or external hosts. You can specify the port range with the -p (start port) and -P (end port) options when starting the server. The 8080 value is used as the start port by default

gpload

8000-9000

HTTPS

The gpload utility runs one or more instances of gpfdist with ports or port ranges specified in the configuration file. The 8000-9000 range is used by default and can be changed
Service Port Protocol Note

ADB ClickHouse Connector

8123

HTTP

All ADB nodes should have access to the 8123 HTTP port on all ADQM/ClickHouse nodes through which you plan to load data

If you use ADB to ADB Connector, ensure that TCP ports that are used in connection are allowed on remote ADB cluster hosts (master host, segment hosts, standby host). You can obtain the list of these ports using the following query on remote ADB cluster:

SELECT port FROM gp_segment_configuration;

Add exceptions for the ports from the command output in case of using firewall.

ADB Control ports

NOTE

For more information on the ADB Control architecture, see Arenadata DB Control overview.

  • ADB Control host

  • ADB hosts

Service Port Protocol Note

Service Registry

6567

gRPC (HTTP 2.0)

gRPC endpoint of Service Registry instances

8761

HTTP

 — 

Router

81

HTTP

Entry to the ADB Control UI

Web UI

3000

TCP

 — 

PlanChecker

8887

HTTP

 — 

UI Backend Server

6566

gRPC (HTTP 2.0)

 — 

8890

HTTP

 — 

Backend Server

6565

gRPC (HTTP 2.0)

 — 

8081

HTTP

 — 

Scheduler

6572

gRPC (HTTP 2.0)

 — 

Query DB (PostgreSQL)

5433

TCP

The outside port is mapped to 5432 inside a container

Metrics DB (ClickHouse)

8123

HTTP

HTTP API port for HTTP requests. Used by JDBC, ODBC, and web interfaces

9000

TCP

Native protocol port (also referred to as ClickHouse TCP protocol). Used by ClickHouse applications and processes like clickhouse-server, clickhouse-client, and native ClickHouse tools. Used for distributed queries via inter-server communication

Migration

8899

HTTP

 — 
Service Port Protocol Note

Agent

6581

TCP

Port for the utility service that is used to manage GUCs which are changed via ADB Control

ADBM ports

NOTE

For more information on the ADBM architecture, see Arenadata DB Backup Manager overview.

  • ADBM host

  • ADB hosts

Service Port Protocol Note

Backup Manager

6570

TCP

 — 

8870

TCP

 — 

8988

TCP

The outside port is mapped to 8843 inside a container

Service Registry

6568

TCP

 — 

8761

TCP

 — 

PostgreSQL

5432

TCP

The PostgreSQL database service is available on localhost and the default PostgreSQL port is 5432

etcd

2391

2392

2393

TCP

The outside ports are mapped to 2379 inside each instance of etcd correspondingly
Service Port Protocol Note

Agent

6571

TCP

The port through which gRPC calls from ADBM to agents come
Found a mistake? Seleсt text and press Ctrl+Enter to report it