adoroszlai commented on code in PR #8226:
URL: https://github.com/apache/ozone/pull/8226#discussion_r2087125586


##########
hadoop-hdds/docs/content/concept/NetworkPorts.md:
##########
@@ -0,0 +1,102 @@
+---
+title: "Network Ports"
+date: "2025-04-03"
+weight: 9
+menu: 
+  main:
+     parent: Architecture
+summary: Understanding and correctly configuring the network ports used by 
Apache Ozone is essential for the successful deployment, operation, and 
maintenance of Apache Ozone clusters.
+
+---
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+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.
+
+# **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. If 
ozone.scm.client.address is defined (default is empty), 
ozone.scm.client.address overrides it |
+| 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. If ozone.scm.datanode.address is 
defined (default is empty), ozone.scm.datanode.address overrides it |
+| 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 `scm service_id.node_id`.

Review Comment:
   ```suggestion
   Note: all the above SCM properties are suffixed with `service_id.node_id`.
   ```



##########
hadoop-hdds/docs/content/concept/NetworkPorts.md:
##########
@@ -0,0 +1,102 @@
+---
+title: "Network Ports"
+date: "2025-04-03"
+weight: 9
+menu: 
+  main:
+     parent: Architecture
+summary: Understanding and correctly configuring the network ports used by 
Apache Ozone is essential for the successful deployment, operation, and 
maintenance of Apache Ozone clusters.
+
+---
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+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.
+
+# **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`.

Review Comment:
   ```suggestion
   Note: except for `ozone.om.grpc.port`, all the above OM properties are 
suffixed with `service_id.node_id`.
   ```



##########
hadoop-hdds/docs/content/concept/NetworkPorts.md:
##########
@@ -0,0 +1,102 @@
+---
+title: "Network Ports"
+date: "2025-04-03"
+weight: 9
+menu: 
+  main:
+     parent: Architecture
+summary: Understanding and correctly configuring the network ports used by 
Apache Ozone is essential for the successful deployment, operation, and 
maintenance of Apache Ozone clusters.
+
+---
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+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.
+
+# **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. If 
ozone.scm.client.address is defined (default is empty), 
ozone.scm.client.address overrides it |
+| 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. If ozone.scm.datanode.address is 
defined (default is empty), ozone.scm.datanode.address overrides it |

Review Comment:
   ```suggestion
   | 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) |
   ```



##########
hadoop-hdds/docs/content/concept/NetworkPorts.md:
##########
@@ -0,0 +1,102 @@
+---
+title: "Network Ports"
+date: "2025-04-03"
+weight: 9
+menu: 
+  main:
+     parent: Architecture
+summary: Understanding and correctly configuring the network ports used by 
Apache Ozone is essential for the successful deployment, operation, and 
maintenance of Apache Ozone clusters.
+
+---
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+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.
+
+# **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. If 
ozone.scm.client.address is defined (default is empty), 
ozone.scm.client.address overrides it |

Review Comment:
   ```suggestion
   | 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) |
   ```



##########
hadoop-hdds/docs/content/concept/NetworkPorts.md:
##########
@@ -0,0 +1,102 @@
+---
+title: "Network Ports"
+date: "2025-04-03"
+weight: 9
+menu: 
+  main:
+     parent: Architecture
+summary: Understanding and correctly configuring the network ports used by 
Apache Ozone is essential for the successful deployment, operation, and 
maintenance of Apache Ozone clusters.
+
+---
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+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.
+
+# **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. If 
ozone.scm.client.address is defined (default is empty), 
ozone.scm.client.address overrides it |
+| 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. If ozone.scm.datanode.address is 
defined (default is empty), ozone.scm.datanode.address overrides it |
+| 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 `scm 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 |

Review Comment:
   ```suggestion
   | 14000 | `httpfs.http.port` | HTTP or HTTPS | The HTTP port for HttpFS REST 
API. TLS is enabled if `httpfs.ssl.enabled` is true |
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to