You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ja...@apache.org on 2022/09/08 21:04:10 UTC
[pinot] branch master updated: Allow hiding pinot broker swagger UI by config (#9343)
This is an automated email from the ASF dual-hosted git repository.
jackie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 9d76fcf244 Allow hiding pinot broker swagger UI by config (#9343)
9d76fcf244 is described below
commit 9d76fcf2444d1c419b48d0ad0d1740b0d887ee5d
Author: Xiaoman Dong <xi...@startree.ai>
AuthorDate: Thu Sep 8 14:04:02 2022 -0700
Allow hiding pinot broker swagger UI by config (#9343)
---
.../pinot/broker/broker/BrokerAdminApiApplication.java | 13 ++++++++++++-
.../java/org/apache/pinot/spi/utils/CommonConstants.java | 2 ++
2 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerAdminApiApplication.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerAdminApiApplication.java
index 1a43f7cf25..17ee575f2a 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerAdminApiApplication.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerAdminApiApplication.java
@@ -46,14 +46,18 @@ import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.hk2.utilities.binding.AbstractBinder;
import org.glassfish.jersey.jackson.JacksonFeature;
import org.glassfish.jersey.server.ResourceConfig;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
public class BrokerAdminApiApplication extends ResourceConfig {
+ private static final Logger LOGGER = LoggerFactory.getLogger(BrokerAdminApiApplication.class);
private static final String RESOURCE_PACKAGE = "org.apache.pinot.broker.api.resources";
public static final String PINOT_CONFIGURATION = "pinotConfiguration";
public static final String BROKER_INSTANCE_ID = "brokerInstanceId";
private final boolean _useHttps;
+ private final boolean _swaggerBrokerEnabled;
private HttpServer _httpServer;
@@ -62,6 +66,8 @@ public class BrokerAdminApiApplication extends ResourceConfig {
packages(RESOURCE_PACKAGE);
property(PINOT_CONFIGURATION, brokerConf);
_useHttps = Boolean.parseBoolean(brokerConf.getProperty(CommonConstants.Broker.CONFIG_OF_SWAGGER_USE_HTTPS));
+ _swaggerBrokerEnabled = brokerConf.getProperty(CommonConstants.Broker.CONFIG_OF_SWAGGER_BROKER_ENABLED,
+ CommonConstants.Broker.DEFAULT_SWAGGER_BROKER_ENABLED);
if (brokerConf.getProperty(CommonConstants.Broker.BROKER_SERVICE_AUTO_DISCOVERY, false)) {
register(ServiceAutoDiscoveryFeature.class);
}
@@ -100,7 +106,12 @@ public class BrokerAdminApiApplication extends ResourceConfig {
} catch (IOException e) {
throw new RuntimeException("Failed to start http server", e);
}
- PinotReflectionUtils.runWithLock(this::setupSwagger);
+
+ if (_swaggerBrokerEnabled) {
+ PinotReflectionUtils.runWithLock(this::setupSwagger);
+ } else {
+ LOGGER.info("Hiding Swagger UI for Broker, by {}", CommonConstants.Broker.CONFIG_OF_SWAGGER_BROKER_ENABLED);
+ }
}
private void setupSwagger() {
diff --git a/pinot-spi/src/main/java/org/apache/pinot/spi/utils/CommonConstants.java b/pinot-spi/src/main/java/org/apache/pinot/spi/utils/CommonConstants.java
index 2ca5801b1a..5b67b47217 100644
--- a/pinot-spi/src/main/java/org/apache/pinot/spi/utils/CommonConstants.java
+++ b/pinot-spi/src/main/java/org/apache/pinot/spi/utils/CommonConstants.java
@@ -263,6 +263,8 @@ public class CommonConstants {
public static final boolean DEFAULT_BROKER_REQUEST_CLIENT_IP_LOGGING = false;
public static final String CONFIG_OF_LOGGER_ROOT_DIR = "pinot.broker.logger.root.dir";
+ public static final String CONFIG_OF_SWAGGER_BROKER_ENABLED = "pinot.broker.swagger.enabled";
+ public static final boolean DEFAULT_SWAGGER_BROKER_ENABLED = true;
public static class Request {
public static final String SQL = "sql";
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org