This is an automated email from the ASF dual-hosted git repository.
pdallig pushed a commit to branch branch-0.12
in repository https://gitbox.apache.org/repos/asf/zeppelin.git
The following commit(s) were added to refs/heads/branch-0.12 by this push:
new 5551cd4c9e [ZEPPELIN-6143] Add Interpreter Event Server Port
configuration option
5551cd4c9e is described below
commit 5551cd4c9ebdb3b7020fe7b181abef7b993c68d6
Author: ChanHo Lee <[email protected]>
AuthorDate: Thu Dec 5 17:39:27 2024 +0900
[ZEPPELIN-6143] Add Interpreter Event Server Port configuration option
### What is this PR for?
This PR introduces the `ZEPPELIN_EVENT_SERVER_PORT` configuration option.
When this option is set, the Event server that communicates with
interpreters will listen on the specified port.
The `ZEPPELIN_EVENT_SERVER_PORT` option takes precedence over
`ZEPPELIN_SERVER_RPC_PORTRANGE` option.
If `ZEPPELIN_EVENT_SERVER_PORT` is set, the `ZEPPELIN_SERVER_RPC_PORTRANGE`
range will be ignored.
This option is particularly useful when running individual Zeppelin
components in container orchestration environments like Kubernetes.
By explicitly specifying the port, it allows for a more declarative and
clearer configuration of service resources compared to
`ZEPPELIN_SERVER_RPC_PORTRANGE`.
### What type of PR is it?
Improvement
### Todos
* [ ] - Task
### What is the Jira issue?
* Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN-6143
### How should this be tested?
* Run Zeppelin with and without this configuration and check
zeppelin-server logs for the message `"InterpreterEventServer is starting at
"`. Verify that the specified port is used as intended(If the option is set).
### Questions:
* Does the license files need to update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Yes
Closes #4893 from tbonelee/add-fixed-interpreter-event-server-port-option.
Signed-off-by: Philipp Dallig <[email protected]>
(cherry picked from commit f3551eb3a8a0141a670809a994f050baced3ac66)
Signed-off-by: Philipp Dallig <[email protected]>
---
conf/zeppelin-env.sh.template | 1 +
conf/zeppelin-site.xml.template | 6 +++++
docs/setup/operation/configuration.md | 27 ++++++++++++++++++++++
.../zeppelin/conf/ZeppelinConfiguration.java | 9 ++++++++
.../interpreter/RemoteInterpreterEventServer.java | 8 +++----
5 files changed, 47 insertions(+), 4 deletions(-)
diff --git a/conf/zeppelin-env.sh.template b/conf/zeppelin-env.sh.template
index 755849f053..e8160b563c 100644
--- a/conf/zeppelin-env.sh.template
+++ b/conf/zeppelin-env.sh.template
@@ -29,6 +29,7 @@
# export ZEPPELIN_SSL_PORT # ssl port (used when ssl
environment variable is set to true)
# export ZEPPELIN_JMX_ENABLE # Enable JMX feature by
defining "true"
# export ZEPPELIN_JMX_PORT # Port number which JMX uses.
If not set, JMX won't be enabled
+# export ZEPPELIN_SERVER_RPC_PORT # Port for the Zeppelin
Interpreter Event Server. If not set, an available port will be used
automatically.
# export ZEPPELIN_LOG_DIR # Where log files are stored.
PWD by default.
# export ZEPPELIN_PID_DIR # The pid files are stored.
${ZEPPELIN_HOME}/run by default.
diff --git a/conf/zeppelin-site.xml.template b/conf/zeppelin-site.xml.template
index 91b7a15029..24218ce67a 100755
--- a/conf/zeppelin-site.xml.template
+++ b/conf/zeppelin-site.xml.template
@@ -43,6 +43,12 @@
<description>Context Path of the Web Application</description>
</property>
+<property>
+ <name>zeppelin.server.rpc.port</name>
+ <value></value>
+ <description>Port for the Zeppelin Interpreter Event Server. If not set, an
available port will be used automatically.</description>
+</property>
+
<property>
<name>zeppelin.war.tempdir</name>
<value>webapps</value>
diff --git a/docs/setup/operation/configuration.md
b/docs/setup/operation/configuration.md
index a2184314d2..9588cd25a5 100644
--- a/docs/setup/operation/configuration.md
+++ b/docs/setup/operation/configuration.md
@@ -61,6 +61,33 @@ Sources descending by priority:
<td>8443</td>
<td>Zeppelin Server ssl port (used when ssl environment/property is set to
true)</td>
</tr>
+ <tr>
+ <td><h6 class="properties">ZEPPELIN_SERVER_RPC_PORTRANGE</h6></td>
+ <td><h6 class="properties">zeppelin.server.rpc.portRange</h6></td>
+ <td>:</td>
+ <td>
+ Specifies the port range for the Zeppelin Interpreter Event Server.
+ <br />Format: <code><startPort>:<endPort></code>
+ <br />If the <code><startPort></code> is omitted, the range will
begin at 1024. If the <code><endPort></code> is omitted, the range will
extend up to 65535.
+ <br /><span style="font-style:italic; color: gray"> Note: If
<code>zeppelin.server.rpc.port</code> is set, this property will be
ignored.</span>
+ </td>
+ </tr>
+ <tr>
+ <td><h6 class="properties">ZEPPELIN_INTERPRETER_RPC_PORTRANGE</h6></td>
+ <td><h6 class="properties">zeppelin.interpreter.rpc.portRange</h6></td>
+ <td>:</td>
+ <td>
+ Specifies the port range for the Zeppelin Interpreter.
+ <br />Format: <code><startPort>:<endPort></code>
+ <br />If the <code><startPort></code> is omitted, the range will
begin at 1024. If the <code><endPort></code> is omitted, the range will
extend up to 65535.
+ </td>
+ </tr>
+ <tr>
+ <td><h6 class="properties">ZEPPELIN_SERVER_RPC_PORT</h6></td>
+ <td><h6 class="properties">zeppelin.server.rpc.port</h6></td>
+ <td></td>
+ <td>Port for the Zeppelin Interpreter Event Server. If not set, an
available port will be used automatically.</td>
+ </tr>
<tr>
<td><h6 class="properties">ZEPPELIN_JMX_ENABLE</h6></td>
<td><h6 class="properties">zeppelin.jmx.enable</h6></td>
diff --git
a/zeppelin-interpreter/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java
b/zeppelin-interpreter/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java
index b590fa8dda..3b9ebee0ba 100644
---
a/zeppelin-interpreter/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java
+++
b/zeppelin-interpreter/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java
@@ -338,6 +338,14 @@ public class ZeppelinConfiguration {
return getInt(ConfVars.ZEPPELIN_PORT);
}
+ public OptionalInt getZeppelinServerRpcPort() {
+ String zeppelinServerRpcPort =
getString(ConfVars.ZEPPELIN_SERVER_RPC_PORT);
+ if (StringUtils.isBlank(zeppelinServerRpcPort)) {
+ return OptionalInt.empty();
+ }
+ return OptionalInt.of(Integer.parseInt(zeppelinServerRpcPort));
+ }
+
public String getServerContextPath() {
return getString(ConfVars.ZEPPELIN_SERVER_CONTEXT_PATH);
}
@@ -948,6 +956,7 @@ public class ZeppelinConfiguration {
ZEPPELIN_SSL_TRUSTSTORE_PATH("zeppelin.ssl.truststore.path", null),
ZEPPELIN_SSL_TRUSTSTORE_TYPE("zeppelin.ssl.truststore.type", null),
ZEPPELIN_SSL_TRUSTSTORE_PASSWORD("zeppelin.ssl.truststore.password", null),
+ ZEPPELIN_SERVER_RPC_PORT("zeppelin.server.rpc.port", null),
ZEPPELIN_WAR("zeppelin.war", "zeppelin-web/dist"),
ZEPPELIN_ANGULAR_WAR("zeppelin.angular.war",
"zeppelin-web-angular/dist/zeppelin"),
ZEPPELIN_WAR_TEMPDIR("zeppelin.war.tempdir", "webapps"),
diff --git
a/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/RemoteInterpreterEventServer.java
b/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/RemoteInterpreterEventServer.java
index d2649ab226..bab3ee7b2a 100644
---
a/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/RemoteInterpreterEventServer.java
+++
b/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/RemoteInterpreterEventServer.java
@@ -20,6 +20,7 @@ package org.apache.zeppelin.interpreter;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
+import java.util.OptionalInt;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.thrift.TException;
@@ -49,7 +50,6 @@ import
org.apache.zeppelin.interpreter.thrift.RemoteInterpreterEventService;
import org.apache.zeppelin.interpreter.thrift.RemoteInterpreterResultMessage;
import org.apache.zeppelin.interpreter.thrift.RunParagraphsEvent;
import org.apache.zeppelin.interpreter.thrift.WebUrlInfo;
-import org.apache.zeppelin.notebook.Note;
import org.apache.zeppelin.resource.RemoteResource;
import org.apache.zeppelin.resource.Resource;
import org.apache.zeppelin.resource.ResourceId;
@@ -78,7 +78,6 @@ public class RemoteInterpreterEventServer implements
RemoteInterpreterEventServi
private static final Logger LOGGER =
LoggerFactory.getLogger(RemoteInterpreterEventServer.class);
private static final Gson GSON = new Gson();
- private String portRange;
private int port;
private String host;
private ZeppelinConfiguration zConf;
@@ -96,7 +95,6 @@ public class RemoteInterpreterEventServer implements
RemoteInterpreterEventServi
public RemoteInterpreterEventServer(ZeppelinConfiguration zConf,
InterpreterSettingManager
interpreterSettingManager) {
this.zConf = zConf;
- this.portRange = zConf.getZeppelinServerRPCPortRange();
this.interpreterSettingManager = interpreterSettingManager;
this.listener =
interpreterSettingManager.getRemoteInterpreterProcessListener();
this.appListener = interpreterSettingManager.getAppEventListener();
@@ -106,7 +104,9 @@ public class RemoteInterpreterEventServer implements
RemoteInterpreterEventServi
Thread startingThread = new Thread() {
@Override
public void run() {
- try (TServerSocket tSocket = new
TServerSocket(RemoteInterpreterUtils.findAvailablePort(portRange))){
+ try (TServerSocket tSocket = new
TServerSocket(zConf.getZeppelinServerRpcPort().orElse(
+
RemoteInterpreterUtils.findAvailablePort(zConf.getZeppelinServerRPCPortRange())))
+ ) {
port = tSocket.getServerSocket().getLocalPort();
host = RemoteInterpreterUtils.findAvailableHostAddress();
LOGGER.info("InterpreterEventServer is starting at {}:{}", host,
port);
