This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new cc039f855e [MINOR] docs(iceberg): add REST catalog backend for IRC
document (#9884)
cc039f855e is described below
commit cc039f855e9ad4215e16eebe62409d143084510c
Author: FANNG <[email protected]>
AuthorDate: Mon Feb 9 12:25:28 2026 +0900
[MINOR] docs(iceberg): add REST catalog backend for IRC document (#9884)
### What changes were proposed in this pull request?
add REST catalog backend for IRC document
### Why are the changes needed?
Fix: #
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
test IRC2 with local fs and s3 storage
---
docs/iceberg-rest-service.md | 33 ++++++++++++++++++++++++++++++++-
1 file changed, 32 insertions(+), 1 deletion(-)
diff --git a/docs/iceberg-rest-service.md b/docs/iceberg-rest-service.md
index bde969c04f..2d2427cee6 100644
--- a/docs/iceberg-rest-service.md
+++ b/docs/iceberg-rest-service.md
@@ -92,7 +92,7 @@ You can also specify filter parameters by setting
configuration entries in the s
### Catalog backend configuration
:::info
-The Gravitino Iceberg REST catalog service uses the memory catalog backend by
default. You can specify a Hive or JDBC catalog backend for production
environment.
+The Gravitino Iceberg REST catalog service uses the memory catalog backend by
default. You can specify a Hive, JDBC or REST catalog backend for production
environment.
:::
#### Hive backend configuration
@@ -124,6 +124,37 @@ You must download the corresponding JDBC driver to the
`iceberg-rest-server/libs
If you are using multiple JDBC catalog backends, setting `jdbc-initialize` to
true may not take effect for RDBMS like `Mysql`, you should create Iceberg meta
tables explicitly.
:::
+#### REST backend configuration
+
+Use the REST backend to proxy another Iceberg REST catalog server (IRC2). The
Gravitino Iceberg REST service acts as IRC1 and forwards catalog operations to
IRC2.
+
+| Configuration item | Description
| Default value | Required | Since Version |
+|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
+| `gravitino.iceberg-rest.catalog-backend` | The Catalog backend of the
Gravitino Iceberg REST catalog service. Use the value **`rest`** for the REST
catalog backend. | `memory` | Yes | 0.2.0 |
+| `gravitino.iceberg-rest.uri` | The Iceberg REST catalog URI
(IRC2), such as `http://127.0.0.1:9001/iceberg`.
| (none) | Yes | 0.2.0 |
+| `gravitino.iceberg-rest.warehouse` | The catalog name in the Iceberg
REST spec. Set to a specific catalog name, or leave empty to use the default
catalog on IRC2. | (none) | No | 0.2.0 |
+
+IRC1 configuration example if IRC2 using HDFS storage:
+
+```text
+gravitino.iceberg-rest.catalog-backend = rest
+gravitino.iceberg-rest.uri = http://127.0.0.1:9001/iceberg
+```
+
+IRC1 configuration example if IRC2 using S3 storage:
+
+```text
+gravitino.iceberg-rest.catalog-backend = rest
+gravitino.iceberg-rest.uri = http://127.0.0.1:9001/iceberg
+gravitino.iceberg-rest.s3-access-key-id = xx
+gravitino.iceberg-rest.s3-secret-access-key = xx
+gravitino.iceberg-rest.s3-region = xx
+gravitino.iceberg-rest.credential-providers = s3-secret-key
+gravitino.iceberg-rest.header.X-Iceberg-Access-Delegation = vended-credentials
+```
+
+IRC1 must also configure S3 configurations if the client side requests
credential vending.
+
#### Custom backend configuration
| Configuration item | Description
| Default value | Required | Since Version |
