Skip to content

Commit e33cf5a

Browse files
Improve Docs for IRC Catalog Connection (#2175)
<!-- Thanks for opening a pull request! --> <!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. --> <!-- Closes #${GITHUB_ISSUE_ID} --> # Rationale for this change Closes #2096 Included examples and detailed configuration guidance to enhance clarity. # Are these changes tested? # Are there any user-facing changes? <!-- In the case of user-facing changes, please add the changelog label. --> --------- Co-authored-by: Kevin Liu <[email protected]> Co-authored-by: Kevin Liu <[email protected]>
1 parent a626bc2 commit e33cf5a

File tree

1 file changed

+89
-18
lines changed

1 file changed

+89
-18
lines changed

mkdocs/docs/configuration.md

Lines changed: 89 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -339,40 +339,111 @@ catalog:
339339
340340
| Key | Example | Description |
341341
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
342-
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343-
| ugi | t-1234:secret | Hadoop UGI for Hive client. |
344-
| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog |
345-
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
342+
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343+
| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. |
344+
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
345+
| `header.X-Iceberg-Access-Delegation` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. When using `vended-credentials`, the server provides temporary credentials to the client. When using `remote-signing`, the server signs requests on behalf of the client. (default: `vended-credentials`) |
346+
347+
#### Headers in REST Catalog
348+
349+
To configure custom headers in REST Catalog, include them in the catalog properties with `header.<Header-Name>`. This
350+
ensures that all HTTP requests to the REST service include the specified headers.
351+
352+
```yaml
353+
catalog:
354+
default:
355+
uri: http://rest-catalog/ws/
356+
credential: t-1234:secret
357+
header.content-type: application/vnd.api+json
358+
```
359+
360+
#### Authentication Options
361+
362+
##### OAuth2
363+
364+
| Key | Example | Description |
365+
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
366+
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
367+
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
368+
| credential | client_id:client_secret | Credential to use for OAuth2 credential flow when initializing the catalog |
346369
| scope | openid offline corpds:ds:profile | Desired scope of the requested security token (default : catalog) |
347370
| resource | rest_catalog.iceberg.com | URI for the target resource or service |
348371
| audience | rest_catalog | Logical name of target resource or service |
372+
373+
##### SigV4
374+
375+
| Key | Example | Description |
376+
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
349377
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
350378
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
351379
| rest.signing-name | execute-api | The service signing name to use when SigV4 signing a request |
352-
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
353-
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
354-
| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. |
355380

356381
<!-- markdown-link-check-enable-->
357382

358-
#### Headers in RESTCatalog
383+
#### Common Integrations & Examples
359384

360-
To configure custom headers in RESTCatalog, include them in the catalog properties with the prefix `header.`. This
361-
ensures that all HTTP requests to the REST service include the specified headers.
385+
##### AWS Glue
362386

363387
```yaml
364388
catalog:
365-
default:
366-
uri: http://rest-catalog/ws/
367-
credential: t-1234:secret
368-
header.content-type: application/vnd.api+json
389+
s3_tables_catalog:
390+
type: rest
391+
uri: https://glue.<region>.amazonaws.com/iceberg
392+
warehouse: <account-id>:s3tablescatalog/<table-bucket-name>
393+
rest.sigv4-enabled: true
394+
rest.signing-name: glue
395+
rest.signing-region: <region>
369396
```
370397

371-
Specific headers defined by the RESTCatalog spec include:
398+
##### Unity Catalog
372399

373-
| Key | Options | Default | Description |
374-
| ------------------------------------ | ------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
375-
| `header.X-Iceberg-Access-Delegation` | `{vended-credentials,remote-signing}` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms |
400+
```yaml
401+
catalog:
402+
unity_catalog:
403+
type: rest
404+
uri: https://<workspace-url>/api/2.1/unity-catalog/iceberg-rest
405+
warehouse: <uc-catalog-name>
406+
token: <databricks-pat-token>
407+
```
408+
409+
##### R2 Data Catalog
410+
411+
```yaml
412+
catalog:
413+
r2_catalog:
414+
type: rest
415+
uri: <r2-catalog-uri>
416+
warehouse: <r2-warehouse-name>
417+
token: <r2-token>
418+
```
419+
420+
##### Lakekeeper
421+
422+
```yaml
423+
catalog:
424+
lakekeeper_catalog:
425+
type: rest
426+
uri: <lakekeeper-catalog-uri>
427+
warehouse: <lakekeeper-warehouse-name>
428+
credential: <client-id>:<client-secret>
429+
oauth2-server-uri: http://localhost:30080/realms/<keycloak-realm-name>/protocol/openid-connect/token
430+
scope: lakekeeper
431+
```
432+
433+
##### Apache Polaris
434+
435+
```yaml
436+
catalog:
437+
polaris_catalog:
438+
type: rest
439+
uri: https://<account>.snowflakecomputing.com/polaris/api/catalog
440+
warehouse: <polaris-catalog-name>
441+
credential: <client-id>:<client-secret>
442+
header.X-Iceberg-Access-Delegation: vended-credentials
443+
scope: PRINCIPAL_ROLE:ALL
444+
token-refresh-enabled: true
445+
py-io-impl: pyiceberg.io.fsspec.FsspecFileIO
446+
```
376447

377448
### SQL Catalog
378449

0 commit comments

Comments
 (0)