org.apache.hive
@@ -303,6 +419,22 @@
+
+ org.springframework.boot
+ spring-boot-maven-plugin
+ ${spring-boot.version}
+
+ org.apache.iceberg.rest.standalone.StandaloneRESTCatalogServer
+ exec
+
+
+
+
+ repackage
+
+
+
+
diff --git a/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/HMSReadinessHealthIndicator.java b/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/HMSReadinessHealthIndicator.java
new file mode 100644
index 000000000000..45780c69a495
--- /dev/null
+++ b/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/HMSReadinessHealthIndicator.java
@@ -0,0 +1,69 @@
+/*
+ * 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.
+ */
+package org.apache.iceberg.rest.standalone;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hive.metastore.HiveMetaStoreClient;
+import org.apache.hadoop.hive.metastore.conf.MetastoreConf;
+import org.apache.hadoop.hive.metastore.conf.MetastoreConf.ConfVars;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.stereotype.Component;
+
+/**
+ * Custom health indicator for HMS connectivity.
+ * Verifies that HMS is reachable via Thrift, not just that configuration is present.
+ * Used by Kubernetes readiness probes to determine if the server is ready to accept traffic.
+ */
+@Component
+public class HMSReadinessHealthIndicator implements HealthIndicator {
+ private static final Logger LOG = LoggerFactory.getLogger(HMSReadinessHealthIndicator.class);
+
+ private final Configuration conf;
+
+ public HMSReadinessHealthIndicator(Configuration conf) {
+ this.conf = conf;
+ }
+
+ @Override
+ public Health health() {
+ String hmsThriftUris = MetastoreConf.getVar(conf, ConfVars.THRIFT_URIS);
+ if (hmsThriftUris == null || hmsThriftUris.isEmpty()) {
+ return Health.down()
+ .withDetail("reason", "HMS Thrift URIs not configured")
+ .build();
+ }
+
+ try (HiveMetaStoreClient client = new HiveMetaStoreClient(conf)) {
+ // Lightweight call to verify HMS is reachable
+ client.getAllDatabases();
+ return Health.up()
+ .withDetail("hmsThriftUris", hmsThriftUris)
+ .withDetail("warehouse", MetastoreConf.getVar(conf, ConfVars.WAREHOUSE))
+ .build();
+ } catch (Exception e) {
+ LOG.warn("HMS connectivity check failed: {}", e.getMessage());
+ return Health.down()
+ .withDetail("hmsThriftUris", hmsThriftUris)
+ .withDetail("error", e.getMessage())
+ .build();
+ }
+ }
+}
diff --git a/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/StandaloneRESTCatalogServer.java b/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/StandaloneRESTCatalogServer.java
index 79c89b2cae8d..499a72db84fe 100644
--- a/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/StandaloneRESTCatalogServer.java
+++ b/standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/StandaloneRESTCatalogServer.java
@@ -18,23 +18,24 @@
package org.apache.iceberg.rest.standalone;
import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
import com.google.common.annotations.VisibleForTesting;
import org.apache.hadoop.conf.Configuration;
-import org.apache.hadoop.hive.metastore.ServletServerBuilder;
import org.apache.hadoop.hive.metastore.conf.MetastoreConf;
import org.apache.hadoop.hive.metastore.conf.MetastoreConf.ConfVars;
import org.apache.iceberg.rest.HMSCatalogFactory;
-import org.eclipse.jetty.server.Server;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.web.context.WebServerInitializedEvent;
+import org.springframework.boot.web.servlet.ServletRegistrationBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.event.EventListener;
/**
- * Standalone REST Catalog Server.
+ * Standalone REST Catalog Server with Spring Boot.
*
* This server runs independently of HMS and provides a REST API for Iceberg catalog operations.
* It connects to an external HMS instance via Thrift.
@@ -46,85 +47,107 @@
*
*
Multiple instances can run behind a Kubernetes Service for load balancing.
*/
+@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class StandaloneRESTCatalogServer {
private static final Logger LOG = LoggerFactory.getLogger(StandaloneRESTCatalogServer.class);
private final Configuration conf;
- private Server server;
+ private String restEndpoint;
private int port;
- public StandaloneRESTCatalogServer(Configuration conf) {
- this.conf = conf;
- }
-
/**
- * Starts the standalone REST Catalog server.
+ * Constructor that accepts Configuration.
+ * Standard Hive approach - caller controls Configuration creation.
*/
- public void start() {
+ public StandaloneRESTCatalogServer(Configuration conf) {
+ this.conf = conf;
+
// Validate required configuration
String thriftUris = MetastoreConf.getVar(conf, ConfVars.THRIFT_URIS);
if (thriftUris == null || thriftUris.isEmpty()) {
throw new IllegalArgumentException("metastore.thrift.uris must be configured to connect to HMS");
}
- int servletPort = MetastoreConf.getIntVar(conf, ConfVars.CATALOG_SERVLET_PORT);
+ LOG.info("Hadoop Configuration initialized");
+ LOG.info(" HMS Thrift URIs: {}", thriftUris);
+ LOG.info(" Warehouse: {}", MetastoreConf.getVar(conf, ConfVars.WAREHOUSE));
+ }
+
+ /**
+ * Exposes the Configuration as a Spring bean.
+ */
+ @Bean
+ public Configuration hadoopConfiguration() {
+ return conf;
+ }
+
+ /**
+ * Registers the REST Catalog servlet with Spring Boot.
+ */
+ @Bean
+ public ServletRegistrationBean restCatalogServlet() {
+ // Get servlet path from config or use default
String servletPath = MetastoreConf.getVar(conf, ConfVars.ICEBERG_CATALOG_SERVLET_PATH);
-
if (servletPath == null || servletPath.isEmpty()) {
servletPath = "iceberg"; // Default path
MetastoreConf.setVar(conf, ConfVars.ICEBERG_CATALOG_SERVLET_PATH, servletPath);
}
- LOG.info("Starting Standalone REST Catalog Server");
- LOG.info(" HMS Thrift URIs: {}", thriftUris);
- LOG.info(" Servlet Port: {}", servletPort);
+ // Get port from configuration or use default
+ port = MetastoreConf.getIntVar(conf, ConfVars.CATALOG_SERVLET_PORT);
+ if (port == 0) {
+ port = 8080; // Default port
+ MetastoreConf.setLongVar(conf, ConfVars.CATALOG_SERVLET_PORT, port);
+ }
+
+ LOG.info("Creating REST Catalog servlet");
LOG.info(" Servlet Path: /{}", servletPath);
+ LOG.info(" Port: {}", port);
// Create servlet using factory
- ServletServerBuilder.Descriptor catalogDescriptor = HMSCatalogFactory.createServlet(conf);
- if (catalogDescriptor == null) {
+ org.apache.hadoop.hive.metastore.ServletServerBuilder.Descriptor descriptor =
+ HMSCatalogFactory.createServlet(conf);
+ if (descriptor == null) {
+ throw new IllegalStateException(
+ "HMSCatalogFactory.createServlet returned null. Ensure metastore.catalog.servlet.port " +
+ "is set to 0 or a positive value (negative disables the servlet).");
+ }
+ HttpServlet catalogServlet = descriptor.getServlet();
+ if (catalogServlet == null) {
throw new IllegalStateException("Failed to create REST Catalog servlet. " +
"Check that metastore.catalog.servlet.port and metastore.iceberg.catalog.servlet.path are configured.");
}
- // Create health check servlet
- HealthCheckServlet healthServlet = new HealthCheckServlet();
+ // Register servlet with Spring Boot
+ ServletRegistrationBean registration =
+ new ServletRegistrationBean<>(catalogServlet, "/" + servletPath + "/*");
+ registration.setName("IcebergRESTCatalog");
+ registration.setLoadOnStartup(1);
- // Build and start server
- ServletServerBuilder builder = new ServletServerBuilder(conf);
- builder.addServlet(catalogDescriptor);
- builder.addServlet(servletPort, "health", healthServlet);
+ // Store endpoint
+ restEndpoint = "http://localhost:" + port + "/" + servletPath;
- server = builder.start(LOG);
- if (server == null || !server.isStarted()) {
- // Server failed to start - likely a port conflict
- throw new IllegalStateException(String.format(
- "Failed to start REST Catalog server on port %d. Port may already be in use. ", servletPort));
- }
+ LOG.info("REST Catalog servlet registered successfully");
+ LOG.info(" REST Catalog endpoint: {}", restEndpoint);
- // Get actual port (may be auto-assigned)
- port = catalogDescriptor.getPort();
- LOG.info("Standalone REST Catalog Server started successfully on port {}", port);
- LOG.info(" REST Catalog endpoint: http://localhost:{}/{}", port, servletPath);
- LOG.info(" Health check endpoint: http://localhost:{}/health", port);
+ return registration;
}
-
+
/**
- * Stops the server.
+ * Updates port and restEndpoint with the actual server port once the web server has started.
+ * Handles RANDOM_PORT (tests) and server.port=0 where the real port differs from config.
*/
- public void stop() {
- if (server != null && server.isStarted()) {
- try {
- LOG.info("Stopping Standalone REST Catalog Server");
- server.stop();
- server.join();
- LOG.info("Standalone REST Catalog Server stopped");
- } catch (InterruptedException e) {
- Thread.currentThread().interrupt();
- LOG.warn("Server stop interrupted", e);
- } catch (Exception e) {
- LOG.error("Error stopping server", e);
+ @EventListener
+ public void onWebServerInitialized(WebServerInitializedEvent event) {
+ int actualPort = event.getWebServer().getPort();
+ if (actualPort > 0) {
+ this.port = actualPort;
+ String servletPath = MetastoreConf.getVar(conf, ConfVars.ICEBERG_CATALOG_SERVLET_PATH);
+ if (servletPath == null || servletPath.isEmpty()) {
+ servletPath = "iceberg";
}
+ this.restEndpoint = "http://localhost:" + actualPort + "/" + servletPath;
+ LOG.info("REST endpoint set to actual server port: {}", restEndpoint);
}
}
@@ -142,27 +165,7 @@ public int getPort() {
* @return the endpoint URL
*/
public String getRestEndpoint() {
- String servletPath = MetastoreConf.getVar(conf, ConfVars.ICEBERG_CATALOG_SERVLET_PATH);
- if (servletPath == null || servletPath.isEmpty()) {
- servletPath = "iceberg";
- }
- return "http://localhost:" + port + "/" + servletPath;
- }
-
- /**
- * Simple health check servlet for Kubernetes readiness/liveness probes.
- */
- private static final class HealthCheckServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
- try {
- resp.setContentType("application/json");
- resp.setStatus(HttpServletResponse.SC_OK);
- resp.getWriter().println("{\"status\":\"healthy\"}");
- } catch (IOException e) {
- LOG.warn("Failed to write health check response", e);
- }
- }
+ return restEndpoint;
}
/**
@@ -183,26 +186,26 @@ public static void main(String[] args) {
}
}
+ // Sync port from MetastoreConf to Spring's Environment so server.port uses it
+ int port = MetastoreConf.getIntVar(conf, ConfVars.CATALOG_SERVLET_PORT);
+ if (port > 0) {
+ System.setProperty(ConfVars.CATALOG_SERVLET_PORT.getVarname(), String.valueOf(port));
+ }
+
StandaloneRESTCatalogServer server = new StandaloneRESTCatalogServer(conf);
- // Add shutdown hook
- Runtime.getRuntime().addShutdownHook(new Thread(() -> {
- LOG.info("Shutdown hook triggered");
- server.stop();
- }));
+ // Start Spring Boot with the pre-configured server instance
+ SpringApplication app = new SpringApplication(StandaloneRESTCatalogServer.class);
+ app.addInitializers(ctx -> {
+ // Register the pre-created server instance as the primary bean
+ ctx.getBeanFactory().registerSingleton("standaloneRESTCatalogServer", server);
+ });
- try {
- server.start();
- LOG.info("Server running. Press Ctrl+C to stop.");
-
- // Keep server running
- server.server.join();
- } catch (InterruptedException e) {
- Thread.currentThread().interrupt();
- LOG.warn("Server stop interrupted", e);
- } catch (Exception e) {
- LOG.error("Failed to start server", e);
- System.exit(1);
- }
+ app.run(args);
+
+ LOG.info("Standalone REST Catalog Server started successfully");
+ LOG.info("Server running. Press Ctrl+C to stop.");
+
+ // Spring Boot's graceful shutdown will handle cleanup automatically
}
}
diff --git a/standalone-metastore/metastore-rest-catalog/src/main/resources/application.properties b/standalone-metastore/metastore-rest-catalog/src/main/resources/application.properties
new file mode 100644
index 000000000000..a631a8c95e82
--- /dev/null
+++ b/standalone-metastore/metastore-rest-catalog/src/main/resources/application.properties
@@ -0,0 +1,27 @@
+# Spring Boot Configuration for Standalone HMS REST Catalog Server
+
+# Server configuration
+# Port is set via MetastoreConf.CATALOG_SERVLET_PORT
+server.port=${metastore.catalog.servlet.port:8080}
+server.shutdown=graceful
+spring.lifecycle.timeout-per-shutdown-phase=30s
+
+# Actuator endpoints for Kubernetes
+management.endpoints.web.exposure.include=health,prometheus,info
+management.endpoint.health.show-details=always
+management.endpoint.health.probes.enabled=true
+management.health.livenessState.enabled=true
+management.health.readinessState.enabled=true
+
+# Prometheus metrics for HPA
+management.metrics.export.prometheus.enabled=true
+
+# Logging
+logging.level.org.apache.iceberg.rest.standalone=INFO
+logging.level.org.apache.hadoop.hive.metastore=INFO
+logging.level.org.springframework.boot=WARN
+
+# Application info
+info.app.name=Standalone HMS REST Catalog Server
+info.app.description=Standalone REST Catalog Server for Apache Hive Metastore
+info.app.version=@project.version@