This is an automated email from the ASF dual-hosted git repository.
weichiu pushed a commit to branch HDDS-9225-website-v2
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/HDDS-9225-website-v2 by this
push:
new d08258897 HDDS-14401. [Website v2] [Docs] [Administrator Guide]
Network Ports (#237)
d08258897 is described below
commit d0825889734097a6a059227e1364a48a5c424b34
Author: Eric C. Ho <[email protected]>
AuthorDate: Wed Jan 14 06:24:16 2026 +0800
HDDS-14401. [Website v2] [Docs] [Administrator Guide] Network Ports (#237)
---
.../01-basic/02-network/07-default-ports.md | 83 +++++++++++++++++++++-
1 file changed, 81 insertions(+), 2 deletions(-)
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/02-network/07-default-ports.md
b/docs/05-administrator-guide/02-configuration/01-basic/02-network/07-default-ports.md
index aad1901e2..05d8534d4 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/02-network/07-default-ports.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/02-network/07-default-ports.md
@@ -4,6 +4,85 @@ sidebar_label: Default Ports
# Default Ports Used by Ozone
-**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
+This document provides a comprehensive overview of the network ports utilized
by Apache Ozone.
+Due to its distributed nature and the requirement for high performance in
handling data-intensive tasks, understanding and correctly configuring these
network ports is essential for the successful deployment, operation, and
maintenance of Apache Ozone clusters.
-Include a list of all default port values used throughout Ozone.
+## **Ozone Manager (OM)**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :--- | :--- | :--- | :--- |
+| 9862 | `ozone.om.address.<service_id>.<node_id>` | Hadoop RPC | Primary RPC
endpoint for Ozone clients |
+| 9874 | `ozone.om.http-address.<service_id>.<node_id>` | HTTP | Web UI for
monitoring OM status and metadata |
+| 9875 | `ozone.om.https-address.<service_id>.<node_id>` | HTTPS | Secure Web
UI for monitoring OM status and metadata |
+| 9872 | `ozone.om.ratis.port.<service_id>.<node_id>` | HTTP/2 | RPC endpoint
for OM HA instances to form a RAFT consensus ring |
+| 8981 | `ozone.om.grpc.port` | HTTP/2 | gRPC endpoint for Ozone Manager
clients |
+
+:::note
+Except for `ozone.om.grpc.port`, all the above OM properties are suffixed with
`service_id.node_id`.
+For example: `ozone.om.address.cluster1.om1`.
+:::
+
+## **Storage Container Manager (SCM)**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :---- | :---- | :---- | :---- |
+| 9860 | `ozone.scm.client.port.<service_id>.<node_id>` | Hadoop RPC |
Communication with Ozone clients for namespace and container management.
`ozone.scm.client.address` overrides it, if defined (default is empty) |
+| 9863 | `ozone.scm.block.client.port.<service_id>.<node_id>` | Hadoop RPC |
Communication with Datanodes for block-level operations |
+| 9861 | `ozone.scm.datanode.port.<service_id>.<node_id>` | Hadoop RPC | Port
used by Datanodes to communicate with the SCM. `ozone.scm.datanode.address`
overrides it, if defined (default is empty) |
+| 9961 | `ozone.scm.security.service.port.<service_id>.<node_id>` | Hadoop RPC
| SCM security server port |
+| 9876 | `ozone.scm.http-address.<service_id>.<node_id>` | HTTP | Web UI for
monitoring SCM status |
+| 9877 | `ozone.scm.https-address.<service_id>.<node_id>` | HTTPS | Secure Web
UI for monitoring SCM status |
+| 9894 | `ozone.scm.ratis.port.<service_id>.<node_id>` | HTTP/2 | SCM Ratis HA
|
+| 9895 | `ozone.scm.grpc.port.<service_id>.<node_id>` | HTTP/2 | SCM gRPC
server port |
+
+:::note
+All the above SCM properties are suffixed with `service_id.node_id`.
+For example: `ozone.scm.client.port.scmservice.scm1`.
+:::
+
+## **Recon**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :---- | :---- | :---- | :---- |
+| 9891 | `ozone.recon.address` | Hadoop RPC | RPC address for Recon to collect
metadata from other Ozone services |
+| 9888 | `ozone.recon.http-address` | HTTP | Web-based management and
monitoring console for the entire Ozone cluster |
+| 9889 | `ozone.recon.https-address` | HTTPS | Web-based management and
monitoring console for the entire Ozone cluster |
+
+## **S3 Gateway (S3G)**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :---- | :---- | :---- | :---- |
+| 9878 | `ozone.s3g.http-address` | HTTP | S3-compatible RESTful API endpoint |
+| 9879 | `ozone.s3g.https-address` | HTTPS | Secure S3-compatible RESTful API
endpoint |
+| 19878 | `ozone.s3g.webadmin.http-address` | HTTP | Ozone S3Gateway serves
web content |
+| 19879 | `ozone.s3g.webadmin.https-address` | HTTPS | Ozone S3Gateway serves
web content |
+
+## **HttpFS Server**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :---- | :---- | :---- | :---- |
+| 14000 | `httpfs.http.port` | HTTP or HTTPS | The HTTP port for HttpFS REST
API. TLS is enabled if `httpfs.ssl.enabled` is true |
+
+## **Datanode**
+
+| Default Port Number | Configuration Key | Endpoint Protocol | Purpose |
+| :---- | :---- | :---- | :---- |
+| 9859 | `hdds.container.ipc.port` | HTTP/2 | Inter-process communication
related to container operations |
+| 9855 | `hdds.container.ratis.datastream.port` | TCP | Ratis data streaming
for container replication (if enabled) |
+| 9858 | `hdds.container.ratis.ipc.port` | HTTP/2 | Communication with
embedded Ratis server for replication coordination |
+| 9857 | `hdds.container.ratis.admin.port` | HTTP/2 | Administrative requests
to the Ratis server |
+| 9856 | `hdds.container.ratis.server.port` | HTTP/2 | Communication between
Ratis peers in a replication pipeline |
+| 9882 | `hdds.datanode.http-address` | HTTP | Web UI for monitoring Datanode
status and resource utilization |
+| 9883 | `hdds.datanode.https-address` | HTTPS | Secure Web UI for monitoring
Datanode status and resource utilization |
+| 19864 | `hdds.datanode.client.port` | Hadoop RPC | The port number of the
Ozone Datanode client service |
+
+:::note
+
+- The default port values can be overridden within the `ozone-site.xml`
configuration file, with the exception of HttpFS ports, which are configurable
via the `httpfs-site.xml` configuration file.
+- Hadoop RPC, a binary protocol operating over TCP, may be authenticated and
encrypted using the Java SASL mechanism.
+- Authentication of the Web UI and HttpFS is achievable through
Kerberos/SPNEGO, with encryption facilitated by HTTPS.
+- S3 client connections to the S3 Gateway undergo authentication utilizing S3
secrets and encryption via TLS.
+- A series of Ozone service ports are established by gRPC and Ratis, the
latter employing gRPC. gRPC, a protocol based on HTTP/2, is capable of being
encrypted with TLS.
+- Ratis streaming ports, initiated by Netty, can be secured through TLS
encryption.
+
+:::
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
