Skip to content

HIVE-29285: Iceberg: Add docker-compose setups for REST Catalog int… #6147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 28, 2025
Merged

HIVE-29285: Iceberg: Add docker-compose setups for REST Catalog int… #6147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bf6ed8
HIVE-29285: Iceberg: Add docker-compose setups for REST Catalog integ…
Oct 21, 2025
94d41be
code review comments.
Oct 28, 2025
455ba13
code review comments - 2.
Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 242 additions & 0 deletions packaging/src/docker/thirdparties/gravitino/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
<!--
{% comment %}
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.
{% endcomment %}
-->

# Hive + Gravitino + Keycloak: Docker-Compose Setup
Copy link
Member

@deniskuzZ deniskuzZ Oct 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think that should be part of Hive dev setup: https://hive.apache.org/development/quickstart/

Copy link
Contributor Author

@difin difin Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added that because the existing Hive docker-compose setup contains a README file:
https://github.com/apache/hive/blob/master/packaging/src/docker/README.md

So, just wanted to confirm: should we have these README files here for consistency, or only to add to the hive-site?

Copy link
Contributor Author

@difin difin Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @deniskuzZ,
I created a PR for adding the quickstarts to hive-site:
apache/hive-site#68

Can you please review?


This package contains a docker-compose-based setup integrating Apache Hive, Gravitino Iceberg REST server, and Keycloak for OAuth2 authentication. It allows Hive to use an Iceberg REST catalog secured via Keycloak.

## Table of Contents
- Architecture Overview
- Prerequisites
- Quickstart
- Configuration
- Keycloak
- Gravitino
- Hive
- Networking Notes

## Architecture Overview
This diagram illustrates the key docker-compose components and their interactions in this setup:

```
oAuth2 (REST API)
+-------------------------------------------------------------------+
| |
| v
+--------+----------+ +-------------------+ +-----------------+
| | RESTCatalog | | oauth2 | |
| Hive | (REST API) | Gravitino | (REST API) | Keycloak |
| (HiveServer2) +-------------->| Iceberg REST +----------->| OAuth2 Auth |
| | | Server | | Server |
+--------+----------+ +---------+---------+ +-----------------+
| |
data | metadata files |
files +------------------------------------+
|
v
+-------------------+ +-------------------+
| | creates dir | |
| /warehouse |<--------------+ init |
| (Docker volume) | sets | container |
| | permissions | |
+-------------------+ +-------------------+
```

- Hive:
- Runs HiveServer2, connects to Gravitino via Iceberg REST catalog.
- Write Iceberg data files to the shared warehouse volume.
- Gravitino:
- Exposes REST API for Iceberg catalog.
- Writes Iceberg metadata files to shared warehouse volume (.metadata.json).
- Doesn't supports serving as oauth2 provider, so this example uses an external OAuth2 provider (Keyclock).
- Keycloak:
- OAuth2 server providing authentication and token issuance for Hive/Gravitino.
- /warehouse:
- Shared Docker volume for Iceberg table data and metadata.
- Init container:
- Creates shared /warehouse folder and sets filesystem permissions as a one time initialization step.

## Prerequisites
- Docker & Docker Compose
- Java (for local Hive beeline client)
- ```$HIVE_HOME``` environment variable pointing to Hive installation (for connecting to Beeline)

## Quickstart

### STEP 1: Export the Hive version
```shell
export HIVE_VERSION=4.2.0
```

### STEP 2: Start services
```shell
docker-compose up -d
```

### STEP 3: Connect to beeline
```shell
"${HIVE_HOME}/bin/beeline" -u "jdbc:hive2://localhost:10001/default" -n hive -p hive
```

### STEP 4: Stop services:
```shell
docker-compose down -v
```

### Configuration

#### Keycloak

- Realm: hive
- Client: iceberg-client
- Secret: iceberg-client-secret
- Protocol: OpenID Connect
- Audience: hive-iceberg
- Imported via `realm-export.json` in Keycloak container.
- Port: 8080

#### Gravitino

- HTTP port: 9001
- Catalog backend: JDBC H2 (/tmp/gravitino_h2_db)
- Warehouse: /warehouse (shared with Hive)
- Iceberg REST Catalog Backend config:
```
# Backend type for the catalog. Here we use JDBC (H2 database) as the metadata store.
gravitino.iceberg-rest.catalog-backend = jdbc

# JDBC connection URI for the H2 database storing catalog metadata.
gravitino.iceberg-rest.uri = jdbc:h2:file:/tmp/gravitino_h2_db;AUTO_SERVER=TRUE

# JDBC driver class used to connect to the metadata database.
gravitino.iceberg-rest.jdbc-driver = org.h2.Driver

# Database username for connecting to the metadata store.
gravitino.iceberg-rest.jdbc-user = sa

# Database password for connecting to the metadata store (empty here).
gravitino.iceberg-rest.jdbc-password = ""

# Whether to initialize the catalog schema on startup.
gravitino.iceberg-rest.jdbc-initialize = true

# --- Warehouse Location (shared folder) ---

# Path to the Iceberg warehouse directory shared with Hive.
gravitino.iceberg-rest.warehouse = file:///warehouse
```
- OAuth2 config pointing to Keycloak:
```
# Enables OAuth2 as the authentication mechanism for Gravitino.
gravitino.authenticators = oauth

# URL of the Keycloak realm to request tokens from.
gravitino.authenticator.oauth.serverUri = http://keycloak:8080/realms/hive

# Path to the OAuth2 token endpoint on Keycloak.
gravitino.authenticator.oauth.tokenPath = /protocol/openid-connect/token

# OAuth2 scopes requested when obtaining a token. Includes "openid" and the custom "catalog" scope.
gravitino.authenticator.oauth.scope = openid catalog

# OAuth2 client ID registered in Keycloak.
gravitino.authenticator.oauth.clientId = iceberg-client

# OAuth2 client secret associated with the client ID.
gravitino.authenticator.oauth.clientSecret = iceberg-client-secret

# Java class used to validate incoming JWT tokens using the JWKS endpoint.
gravitino.authenticator.oauth.tokenValidatorClass = org.apache.gravitino.server.authentication.JwksTokenValidator

# URL to fetch JSON Web Key Set (JWKS) for verifying token signatures.
gravitino.authenticator.oauth.jwksUri = http://keycloak:8080/realms/hive/protocol/openid-connect/certs

# Identifier for the OAuth2 provider configuration in Gravitino.
gravitino.authenticator.oauth.provider = default

# JWT claim field(s) to extract as the principal/username (here, 'sub' claim).
gravitino.authenticator.oauth.principalFields = sub

# Acceptable clock skew (in seconds) when validating token expiration times.
gravitino.authenticator.oauth.allowSkewSecs = 60

# Expected audience claim in the token to ensure it is intended for this service.
gravitino.authenticator.oauth.serviceAudience = hive-iceberg
```

#### Hive

- Uses ```HiveRESTCatalogClient``` for connecting to Iceberg REST catalog (Gravitino).
- Catalog configuration in ```hive-site.xml```:
```
<property>
<name>metastore.catalog.default</name>
<value>ice01</value>
<description>Sets the default Iceberg catalog for Hive. Here, "ice01" is used.</description>
</property>

<property>
<name>metastore.client.impl</name>
<value>org.apache.iceberg.hive.client.HiveRESTCatalogClient</value>
<description>Specifies the client implementation to use for accessing Iceberg via REST.</description>
</property>

<property>
<name>iceberg.catalog.ice01.uri</name>
<value>http://gravitino:9001/iceberg</value>
<description>URI of the Iceberg REST server (Gravitino). Hive will send catalog requests here.</description>
</property>

<property>
<name>iceberg.catalog.ice01.type</name>
<value>rest</value>
<description>Defines the catalog type as "rest", indicating it uses a REST API backend.</description>
</property>

<!-- Iceberg REST Catalog: OAuth2 authentication -->

<property>
<name>iceberg.catalog.ice01.rest.auth.type</name>
<value>oauth2</value>
<description>Configures Hive to use OAuth2 for authenticating requests to the REST catalog.</description>
</property>

<property>
<name>iceberg.catalog.ice01.oauth2-server-uri</name>
<value>http://keycloak:8080/realms/hive/protocol/openid-connect/token</value>
<description>URL of the Keycloak OAuth2 token endpoint used to request access tokens.</description>
</property>

<property>
<name>iceberg.catalog.ice01.credential</name>
<value>iceberg-client:iceberg-client-secret</value>
<description>Client credentials (ID and secret) used to authenticate with Keycloak.</description>
</property>
```
- HiveServer2 port: 10000 (mapped to 10001 in Docker Compose)

## Networking Notes

- All containers share a custom bridge network ```hive-net```.
- Services communicate via container names: hive, gravitino, keycloak.
- Ports mapped for host access:
- Keycloak → 8080
- Gravitino → 9001
- HiveServer2 → 10001

30 changes: 30 additions & 0 deletions packaging/src/docker/thirdparties/gravitino/common/init.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#!/bin/sh -x

#
# 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.
#

apk add --no-cache acl

mkdir -p /tmp/hive/jars
mkdir -p $WAREHOUSE
chmod 777 $WAREHOUSE

# Give the hive user id full rwx access to all existing files and directories under $WAREHOUSE
setfacl -R -m u:$HIVE_USER_ID:rwx $WAREHOUSE

# Ensure all new files/directories created inside $WAREHOUSE automatically grant rwx access to hive user id
setfacl -d -m u:$HIVE_USER_ID:rwx $WAREHOUSE
103 changes: 103 additions & 0 deletions packaging/src/docker/thirdparties/gravitino/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# 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.

version: "3.9"
Copy link
Member

@deniskuzZ deniskuzZ Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this version?

Copy link
Contributor Author

@difin difin Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version: '3.9'
at the top of a docker-compose.yml file refers to the Compose file format version, not the Docker or Docker Compose tool version itself.

🧩 What it actually means
It tells Docker which syntax and features are supported in this Compose file.

3.9 is the latest version of the v3 schema, which is compatible with modern Docker Engine (19.03+).

The existing Hive docker-compose file also has it.


name: hive-gravitino-rest-catalog-integration

services:
keycloak:
image: quay.io/keycloak/keycloak:25.0.1
container_name: keycloak
environment:
KEYCLOAK_ADMIN: admin
KEYCLOAK_ADMIN_PASSWORD: admin
volumes:
- ./keycloak/realm-export.json:/opt/keycloak/data/import/realm-export.json
ports:
- "8080:8080"
networks:
- hive-net
command: [
"start-dev",
"--import-realm",
"--health-enabled=true"
]
healthcheck:
test: "exec 3<>/dev/tcp/localhost/9000 && \
echo -e 'GET /health/ready HTTP/1.1\\r\\nHost: localhost\\r\\nConnection: close\\r\\n\\r\\n' >&3 && \
cat <&3 | grep -q '200 OK'"
interval: 5s
timeout: 2s
retries: 15

gravitino:
image: apache/gravitino-iceberg-rest:1.0.0
container_name: gravitino
environment:
JAVA_OPTS: "-Dlog4j2.formatMsgNoLookups=true"
volumes:
- ./gravitino:/tmp/gravitino
- warehouse:/warehouse
ports:
- "9001:9001"
networks:
- hive-net
entrypoint: /bin/bash /tmp/gravitino/init.sh
healthcheck:
test: [ "CMD", "/tmp/gravitino/healthcheck.sh" ]
interval: 5s
timeout: 60s
retries: 5
start_period: 20s

hive:
image: apache/hive:${HIVE_VERSION}
container_name: hive
depends_on:
keycloak:
condition: service_healthy
gravitino:
condition: service_healthy
environment:
SERVICE_NAME: hiveserver2
volumes:
- ./hive/hive-site.xml:/opt/hive/conf/hive-site.xml
- warehouse:/warehouse
ports:
- "10001:10000"
networks:
- hive-net
entrypoint: '/bin/sh -c "/opt/hive/bin/schematool -dbType derby -initOrUpgradeSchema && /entrypoint.sh"'

init:
image: alpine/curl
container_name: init
user: "0:0" # run as root
environment:
- WAREHOUSE=/warehouse
- HIVE_USER_ID=1000
volumes:
- ./common/:/common
- warehouse:/warehouse
entrypoint: '/bin/sh -c /common/init.sh'

networks:
hive-net:
driver: bridge

volumes:
warehouse:
Loading