Skip to content

Commit cf300bf

Browse files
karenyrxreta
authored and
meetvm
committed
Fix GRPC AUX_TRANSPORT_PORT and SETTING_GRPC_PORT settings and remove lingering HTTP terminology (opensearch-project#17037)
* [GRPC] Rename AUX_TRANSPORT_PORT and SETTING_GRPC_PORT settings and remove lingering HTTP terminology Signed-off-by: Karen Xu <karenxyr@gmail.com> * Update CHANGELOG Signed-off-by: Karen Xu <karenxyr@gmail.com> * remove extra space in CHANGELOG Signed-off-by: Karen Xu <karenxyr@gmail.com> * Update plugins/transport-grpc/src/main/java/org/opensearch/transport/grpc/Netty4GrpcServerTransport.java Co-authored-by: Andriy Redko <drreta@gmail.com> Signed-off-by: Karen X <karenxyr@gmail.com> --------- Signed-off-by: Karen Xu <karenxyr@gmail.com> Signed-off-by: Karen X <karenxyr@gmail.com> Co-authored-by: Andriy Redko <drreta@gmail.com> Signed-off-by: meetvm <meetvm@amazon.com>
1 parent eafeede commit cf300bf

File tree

6 files changed

+18
-16
lines changed

6 files changed

+18
-16
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
100100
- Fix Shallow copy snapshot failures on closed index ([#16868](https://github.com/opensearch-project/OpenSearch/pull/16868))
101101
- Fix multi-value sort for unsigned long ([#16732](https://github.com/opensearch-project/OpenSearch/pull/16732))
102102
- The `phone-search` analyzer no longer emits the tel/sip prefix, international calling code, extension numbers and unformatted input as a token ([#16993](https://github.com/opensearch-project/OpenSearch/pull/16993))
103+
- Fix GRPC AUX_TRANSPORT_PORT and SETTING_GRPC_PORT settings and remove lingering HTTP terminology ([#17037](https://github.com/opensearch-project/OpenSearch/pull/17037))
103104

104105
### Security
105106

‎plugins/transport-grpc/src/main/java/org/opensearch/transport/grpc/GrpcPlugin.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.GRPC_TRANSPORT_SETTING_KEY;
2626
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_BIND_HOST;
2727
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_HOST;
28-
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_PORTS;
28+
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_PORT;
2929
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_PUBLISH_HOST;
3030
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_PUBLISH_PORT;
3131
import static org.opensearch.transport.grpc.Netty4GrpcServerTransport.SETTING_GRPC_WORKER_COUNT;
@@ -58,7 +58,7 @@ public Map<String, Supplier<AuxTransport>> getAuxTransports(
5858
@Override
5959
public List<Setting<?>> getSettings() {
6060
return List.of(
61-
SETTING_GRPC_PORTS,
61+
SETTING_GRPC_PORT,
6262
SETTING_GRPC_HOST,
6363
SETTING_GRPC_PUBLISH_HOST,
6464
SETTING_GRPC_BIND_HOST,

‎plugins/transport-grpc/src/main/java/org/opensearch/transport/grpc/Netty4GrpcServerTransport.java

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ public class Netty4GrpcServerTransport extends NetworkPlugin.AuxTransport {
6363

6464
/**
6565
* Port range on which to bind.
66-
* Note this setting is configured through AffixSetting AUX_TRANSPORT_PORTS where the aux transport type matches the GRPC_TRANSPORT_SETTING_KEY.
66+
* Note this setting is configured through AffixSetting AUX_TRANSPORT_PORT where the aux transport type matches the GRPC_TRANSPORT_SETTING_KEY.
6767
*/
68-
public static final Setting<PortsRange> SETTING_GRPC_PORTS = AUX_TRANSPORT_PORTS.getConcreteSettingForNamespace(
68+
public static final Setting<PortsRange> SETTING_GRPC_PORT = AUX_TRANSPORT_PORT.getConcreteSettingForNamespace(
6969
GRPC_TRANSPORT_SETTING_KEY
7070
);
7171

@@ -134,20 +134,21 @@ public class Netty4GrpcServerTransport extends NetworkPlugin.AuxTransport {
134134
* @param networkService the bind/publish addresses.
135135
*/
136136
public Netty4GrpcServerTransport(Settings settings, List<BindableService> services, NetworkService networkService) {
137+
logger.debug("Initializing Netty4GrpcServerTransport with settings = {}", settings);
137138
this.settings = Objects.requireNonNull(settings);
138139
this.services = Objects.requireNonNull(services);
139140
this.networkService = Objects.requireNonNull(networkService);
140141

141-
final List<String> httpBindHost = SETTING_GRPC_BIND_HOST.get(settings);
142-
this.bindHosts = (httpBindHost.isEmpty() ? NetworkService.GLOBAL_NETWORK_BIND_HOST_SETTING.get(settings) : httpBindHost).toArray(
142+
final List<String> grpcBindHost = SETTING_GRPC_BIND_HOST.get(settings);
143+
this.bindHosts = (grpcBindHost.isEmpty() ? NetworkService.GLOBAL_NETWORK_BIND_HOST_SETTING.get(settings) : grpcBindHost).toArray(
143144
Strings.EMPTY_ARRAY
144145
);
145146

146-
final List<String> httpPublishHost = SETTING_GRPC_PUBLISH_HOST.get(settings);
147-
this.publishHosts = (httpPublishHost.isEmpty() ? NetworkService.GLOBAL_NETWORK_PUBLISH_HOST_SETTING.get(settings) : httpPublishHost)
147+
final List<String> grpcPublishHost = SETTING_GRPC_PUBLISH_HOST.get(settings);
148+
this.publishHosts = (grpcPublishHost.isEmpty() ? NetworkService.GLOBAL_NETWORK_PUBLISH_HOST_SETTING.get(settings) : grpcPublishHost)
148149
.toArray(Strings.EMPTY_ARRAY);
149150

150-
this.port = SETTING_GRPC_PORTS.get(settings);
151+
this.port = SETTING_GRPC_PORT.get(settings);
151152
this.nettyEventLoopThreads = SETTING_GRPC_WORKER_COUNT.get(settings);
152153
}
153154

@@ -229,7 +230,7 @@ private void bindServer() {
229230
+ publishInetAddress
230231
+ "). "
231232
+ "Please specify a unique port by setting "
232-
+ SETTING_GRPC_PORTS.getKey()
233+
+ SETTING_GRPC_PORT.getKey()
233234
+ " or "
234235
+ SETTING_GRPC_PUBLISH_PORT.getKey()
235236
);

‎plugins/transport-grpc/src/test/java/org/opensearch/transport/grpc/Netty4GrpcServerTransportTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ public void test() {
4444
}
4545

4646
private static Settings createSettings() {
47-
return Settings.builder().put(Netty4GrpcServerTransport.SETTING_GRPC_PORTS.getKey(), getPortRange()).build();
47+
return Settings.builder().put(Netty4GrpcServerTransport.SETTING_GRPC_PORT.getKey(), getPortRange()).build();
4848
}
4949
}

‎server/src/main/java/org/opensearch/bootstrap/Security.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
import static org.opensearch.bootstrap.FilePermissionUtils.addDirectoryPath;
7575
import static org.opensearch.bootstrap.FilePermissionUtils.addSingleFilePath;
7676
import static org.opensearch.plugins.NetworkPlugin.AuxTransport.AUX_PORT_DEFAULTS;
77-
import static org.opensearch.plugins.NetworkPlugin.AuxTransport.AUX_TRANSPORT_PORTS;
77+
import static org.opensearch.plugins.NetworkPlugin.AuxTransport.AUX_TRANSPORT_PORT;
7878
import static org.opensearch.plugins.NetworkPlugin.AuxTransport.AUX_TRANSPORT_TYPES_SETTING;
7979

8080
/**
@@ -423,7 +423,7 @@ private static void addSocketPermissionForHttp(final Permissions policy, final S
423423
}
424424

425425
/**
426-
* Add dynamic {@link SocketPermission} based on AffixSetting AUX_TRANSPORT_PORTS.
426+
* Add dynamic {@link SocketPermission} based on AffixSetting AUX_TRANSPORT_PORT.
427427
* If an auxiliary transport type is enabled but has no corresponding port range setting fall back to AUX_PORT_DEFAULTS.
428428
*
429429
* @param policy the {@link Permissions} instance to apply the dynamic {@link SocketPermission}s to.
@@ -432,7 +432,7 @@ private static void addSocketPermissionForHttp(final Permissions policy, final S
432432
private static void addSocketPermissionForAux(final Permissions policy, final Settings settings) {
433433
Set<PortsRange> portsRanges = new HashSet<>();
434434
for (String auxType : AUX_TRANSPORT_TYPES_SETTING.get(settings)) {
435-
Setting<PortsRange> auxTypePortSettings = AUX_TRANSPORT_PORTS.getConcreteSettingForNamespace(auxType);
435+
Setting<PortsRange> auxTypePortSettings = AUX_TRANSPORT_PORT.getConcreteSettingForNamespace(auxType);
436436
if (auxTypePortSettings.exists(settings)) {
437437
portsRanges.add(auxTypePortSettings.get(settings));
438438
} else {

‎server/src/main/java/org/opensearch/plugins/NetworkPlugin.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ abstract class AuxTransport extends AbstractLifecycleComponent {
7979
public static final String AUX_SETTINGS_PREFIX = "aux.transport.";
8080
public static final String AUX_TRANSPORT_TYPES_KEY = AUX_SETTINGS_PREFIX + "types";
8181
public static final String AUX_PORT_DEFAULTS = "9400-9500";
82-
public static final Setting.AffixSetting<PortsRange> AUX_TRANSPORT_PORTS = affixKeySetting(
82+
public static final Setting.AffixSetting<PortsRange> AUX_TRANSPORT_PORT = affixKeySetting(
8383
AUX_SETTINGS_PREFIX,
84-
"ports",
84+
"port",
8585
key -> new Setting<>(key, AUX_PORT_DEFAULTS, PortsRange::new, Setting.Property.NodeScope)
8686
);
8787

0 commit comments

Comments
 (0)