This is an automated email from the ASF dual-hosted git repository.
yzheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new a88d2a10d (feat) Add example for rustfs integration (#3482)
a88d2a10d is described below
commit a88d2a10dd1a4c58d20fd24f853b01bc9aacd18e
Author: Yong Zheng <[email protected]>
AuthorDate: Wed Jan 21 10:37:22 2026 -0600
(feat) Add example for rustfs integration (#3482)
* Add example for rustfs
* Make it podman compatible and used fixed version for images
* Add disclaimer for mc and set polaris tag to be latest
---
getting-started/rustfs/README.md | 98 ++++++++++++++++++++++++++
getting-started/rustfs/docker-compose.yml | 111 ++++++++++++++++++++++++++++++
2 files changed, 209 insertions(+)
diff --git a/getting-started/rustfs/README.md b/getting-started/rustfs/README.md
new file mode 100644
index 000000000..54f9fbe30
--- /dev/null
+++ b/getting-started/rustfs/README.md
@@ -0,0 +1,98 @@
+<!--
+ 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.
+-->
+
+# Getting Started with Apache Polaris and RustFS
+
+> [!WARNING]
+> Disclaimer: This getting-started example uses mc from MinIO OSS for local
testing only. MinIO OSS is in maintenance mode, and MinIO container images may
no longer receive updates or security fixes. For production setups,
[rc](https://github.com/rustfs/cli) should be used.
+
+## Overview
+
+This example uses [RustFS](https://rustfs.com/) as a storage provider with
Polaris.
+
+Spark is used as a query engine. This example assumes a local Spark
installation.
+See the [Spark Notebooks Example](../spark/README.md) for a more advanced
Spark setup.
+
+## Starting the Example
+
+1. Build the Polaris server image if it's not already present locally:
+
+ ```shell
+ ./gradlew \
+ :polaris-server:assemble \
+ :polaris-server:quarkusAppPartsBuild --rerun \
+ -Dquarkus.container-image.build=true
+ ```
+
+2. Start the docker compose group by running the following command from the
root of the repository:
+
+ ```shell
+ docker compose -f getting-started/rustfs/docker-compose.yml up
+ ```
+
+## Connecting From Spark
+
+```shell
+bin/spark-sql \
+ --packages
org.apache.iceberg:iceberg-spark-runtime-3.5_2.12:1.9.0,org.apache.iceberg:iceberg-aws-bundle:1.9.0
\
+ --conf
spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions
\
+ --conf spark.sql.catalog.polaris=org.apache.iceberg.spark.SparkCatalog \
+ --conf spark.sql.catalog.polaris.type=rest \
+ --conf spark.sql.catalog.polaris.uri=http://localhost:8181/api/catalog \
+ --conf spark.sql.catalog.polaris.token-refresh-enabled=false \
+ --conf spark.sql.catalog.polaris.warehouse=quickstart_catalog \
+ --conf spark.sql.catalog.polaris.scope=PRINCIPAL_ROLE:ALL \
+ --conf
spark.sql.catalog.polaris.header.X-Iceberg-Access-Delegation=vended-credentials
\
+ --conf spark.sql.catalog.polaris.credential=root:s3cr3t \
+ --conf spark.sql.catalog.polaris.client.region=us-west-2 \
+ --conf spark.sql.catalog.polaris.s3.endpoint=http://rustfs:9000
+```
+
+Note: `s3cr3t` is defined as the password for the `root` user in the
`docker-compose.yml` file.
+
+Note: The `client.region` configuration is required for the AWS S3 client to
work, but it is not used in this example
+since RustFS does not require a specific region.
+
+## Running Queries
+
+Run inside the Spark SQL shell:
+
+```
+spark-sql (default)> use polaris;
+Time taken: 0.837 seconds
+
+spark-sql ()> create namespace ns;
+Time taken: 0.374 seconds
+
+spark-sql ()> create table ns.t1 as select 'abc';
+Time taken: 2.192 seconds
+
+spark-sql ()> select * from ns.t1;
+abc
+Time taken: 0.579 seconds, Fetched 1 row(s)
+```
+
+## RustFS Endpoints
+
+Note that the catalog configuration defined in the `docker-compose.yml`
contains
+different endpoints for the Polaris Server and the client (Spark).
Specifically,
+the client endpoint is `http://localhost:9000`, but `endpointInternal` is
`http://rustfs:9000`.
+
+This is necessary because clients running on `localhost` do not normally see
service
+names (such as `rustfs`) that are internal to the docker compose environment.
diff --git a/getting-started/rustfs/docker-compose.yml
b/getting-started/rustfs/docker-compose.yml
new file mode 100644
index 000000000..31d02aee1
--- /dev/null
+++ b/getting-started/rustfs/docker-compose.yml
@@ -0,0 +1,111 @@
+#
+# 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.
+#
+
+services:
+
+ rustfs:
+ image: rustfs/rustfs:1.0.0-alpha.80
+ ports:
+ - "9000:9000" # S3 API port
+ - "9001:9001" # Console port
+ environment:
+ RUSTFS_ACCESS_KEY: rustfsadmin
+ RUSTFS_SECRET_KEY: rustfsadmin
+ RUSTFS_VOLUMES: /data
+ RUSTFS_ADDRESS: ":9000"
+ RUSTFS_CONSOLE_ENABLE: "true"
+ RUSTFS_CONSOLE_ADDRESS: ":9001"
+ healthcheck:
+ test: ["CMD-SHELL", "curl -f http://127.0.0.1:9000/health && curl -f
http://127.0.0.1:9001/rustfs/console/health";]
+ interval: 30s
+ timeout: 10s
+ retries: 3
+ start_period: 40s
+
+ polaris:
+ image: apache/polaris:latest
+ ports:
+ # API port
+ - "8181:8181"
+ # Optional, allows attaching a debugger to the Polaris JVM
+ - "5005:5005"
+ depends_on:
+ rustfs:
+ condition: service_healthy
+ environment:
+ JAVA_DEBUG: true
+ JAVA_DEBUG_PORT: "*:5005"
+ AWS_REGION: us-west-2
+ AWS_ACCESS_KEY_ID: rustfsadmin
+ AWS_SECRET_ACCESS_KEY: rustfsadmin
+ POLARIS_BOOTSTRAP_CREDENTIALS: POLARIS,root,s3cr3t
+ polaris.realm-context.realms: POLARIS
+ quarkus.otel.sdk.disabled: "true"
+ healthcheck:
+ test: ["CMD-SHELL", "curl -f http://localhost:8182/q/health";]
+ interval: 2s
+ timeout: 10s
+ retries: 10
+ start_period: 10s
+
+ setup_bucket:
+ image: quay.io/minio/mc:RELEASE.2025-08-13T08-35-41Z
+ depends_on:
+ rustfs:
+ condition: service_healthy
+ entrypoint: "/bin/sh"
+ command:
+ - "-c"
+ - >-
+ echo Creating RustFS bucket...;
+ mc alias set pol http://rustfs:9000 rustfsadmin rustfsadmin;
+ mc mb pol/bucket123;
+ mc ls pol;
+ echo Bucket setup complete.;
+
+ polaris-setup:
+ image: alpine/curl:8.17.0
+ depends_on:
+ polaris:
+ condition: service_healthy
+ environment:
+ - CLIENT_ID=root
+ - CLIENT_SECRET=s3cr3t
+ volumes:
+ - ../assets/polaris/:/polaris
+ entrypoint: "/bin/sh"
+ command:
+ - "-c"
+ - >-
+ chmod +x /polaris/create-catalog.sh;
+ chmod +x /polaris/obtain-token.sh;
+ source /polaris/obtain-token.sh;
+ echo Creating catalog...;
+ export STORAGE_CONFIG_INFO='{"storageType":"S3",
+ "endpoint":"http://localhost:9000";,
+ "endpointInternal":"http://rustfs:9000";,
+ "pathStyleAccess":true}';
+ export STORAGE_LOCATION='s3://bucket123';
+ /polaris/create-catalog.sh POLARIS $$TOKEN;
+ echo Extra grants...;
+ curl -H "Authorization: Bearer $$TOKEN" -H 'Content-Type:
application/json' \
+ -X PUT \
+
http://polaris:8181/api/management/v1/catalogs/quickstart_catalog/catalog-roles/catalog_admin/grants
\
+ -d '{"type":"catalog", "privilege":"CATALOG_MANAGE_CONTENT"}';
+ echo Done.;
