apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[CELEBORN-1513][FOLLOWUP] Enrich doc for wildcard address

Browse Source 
### What changes were proposed in this pull request?
enrich the docs for supporting wildcard address bind in this [PR](https://github.com/apache/celeborn/pull/2713).

### Why are the changes needed?
better docs

### Does this PR introduce _any_ user-facing change?
No

### How was this patch tested?
N/A - just docs change

Closes #2736 from akpatnam25/CELEBORN-1513-doc-followup.

Authored-by: Aravind Patnam <akpatnam25@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
This commit is contained in:
Aravind Patnam 2024-09-13 16:15:37 +08:00 committed by Cheng Pan
parent 5f02f3e8f1
commit dd25388955
No known key found for this signature in database
GPG Key ID: 8001952629BCC75D
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
common/src/main/java/org/apache/celeborn/common/protocol/TransportModuleConstants.java
View File

@ -45,5 +45,6 @@ public class TransportModuleConstants {
public static final String DATA_MODULE = "data";
// When using null, InetSocketAddress will resolve to a wildcard address for bind operations.
public static final String WILDCARD_BIND_ADDRESS = null;
}

6
common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
View File

@ -1735,8 +1735,10 @@ object CelebornConf extends Logging {
.categories("network")
.version("0.6.0")
.doc("When `true`, the bind address will be set to a wildcard address, while the advertise address will " +
"remain as whatever is set by `celeborn.network.advertise.preferIpAddress`. This is helpful in dual-stack " +
"environments, where the service must listen to both IPv4 and IPv6 clients.")
"remain as whatever is set by `celeborn.network.advertise.preferIpAddress`. The wildcard address is a special " +
"local IP address, and usually refers to 'any' and can only be used for bind operations. In the case of IPv4, " +
"this is 0.0.0.0 and in the case of IPv6 this is ::0. This is helpful in dual-stack environments, where the " +
"service must listen to both IPv4 and IPv6 clients.")
.booleanConf
.createWithDefault(false)

2
docs/configuration/network.md
View File

@ -43,7 +43,7 @@ license: |
| celeborn.io.maxDefaultNettyThreads | 64 | false | Max default netty threads | 0.3.2 | |
| celeborn.network.advertise.preferIpAddress | &lt;value of celeborn.network.bind.preferIpAddress&gt; | false | When `true`, prefer to use IP address, otherwise FQDN for advertise address. | 0.6.0 | |
| celeborn.network.bind.preferIpAddress | true | false | When `true`, prefer to use IP address, otherwise FQDN. This configuration only takes effects when the bind hostname is not set explicitly, in such case, Celeborn will find the first non-loopback address to bind. | 0.3.0 | |
| celeborn.network.bind.wildcardAddress | false | false | When `true`, the bind address will be set to a wildcard address, while the advertise address will remain as whatever is set by `celeborn.network.advertise.preferIpAddress`. This is helpful in dual-stack environments, where the service must listen to both IPv4 and IPv6 clients. | 0.6.0 | |
| celeborn.network.bind.wildcardAddress | false | false | When `true`, the bind address will be set to a wildcard address, while the advertise address will remain as whatever is set by `celeborn.network.advertise.preferIpAddress`. The wildcard address is a special local IP address, and usually refers to 'any' and can only be used for bind operations. In the case of IPv4, this is 0.0.0.0 and in the case of IPv6 this is ::0. This is helpful in dual-stack environments, where the service must listen to both IPv4 and IPv6 clients. | 0.6.0 | |
| celeborn.network.connect.timeout | 10s | false | Default socket connect timeout. | 0.2.0 | |
| celeborn.network.memory.allocator.numArenas | &lt;undefined&gt; | false | Number of arenas for pooled memory allocator. Default value is Runtime.getRuntime.availableProcessors, min value is 2. | 0.3.0 | |
| celeborn.network.memory.allocator.verbose.metric | false | false | Whether to enable verbose metric for pooled allocator. | 0.3.0 | |