Skip to content

Commit cc039f8

Browse files
authored
[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
1 parent 40007c8 commit cc039f8

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

docs/iceberg-rest-service.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ You can also specify filter parameters by setting configuration entries in the s
9292
### Catalog backend configuration
9393

9494
:::info
95-
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.
95+
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.
9696
:::
9797

9898
#### Hive backend configuration
@@ -124,6 +124,37 @@ You must download the corresponding JDBC driver to the `iceberg-rest-server/libs
124124
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.
125125
:::
126126

127+
#### REST backend configuration
128+
129+
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.
130+
131+
| Configuration item | Description | Default value | Required | Since Version |
132+
|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
133+
| `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 |
134+
| `gravitino.iceberg-rest.uri` | The Iceberg REST catalog URI (IRC2), such as `http://127.0.0.1:9001/iceberg`. | (none) | Yes | 0.2.0 |
135+
| `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 |
136+
137+
IRC1 configuration example if IRC2 using HDFS storage:
138+
139+
```text
140+
gravitino.iceberg-rest.catalog-backend = rest
141+
gravitino.iceberg-rest.uri = http://127.0.0.1:9001/iceberg
142+
```
143+
144+
IRC1 configuration example if IRC2 using S3 storage:
145+
146+
```text
147+
gravitino.iceberg-rest.catalog-backend = rest
148+
gravitino.iceberg-rest.uri = http://127.0.0.1:9001/iceberg
149+
gravitino.iceberg-rest.s3-access-key-id = xx
150+
gravitino.iceberg-rest.s3-secret-access-key = xx
151+
gravitino.iceberg-rest.s3-region = xx
152+
gravitino.iceberg-rest.credential-providers = s3-secret-key
153+
gravitino.iceberg-rest.header.X-Iceberg-Access-Delegation = vended-credentials
154+
```
155+
156+
IRC1 must also configure S3 configurations if the client side requests credential vending.
157+
127158
#### Custom backend configuration
128159

129160
| Configuration item | Description | Default value | Required | Since Version |

0 commit comments

Comments
 (0)