Skip to content

Commit 136a7be

Browse files
committed
adjust the position of the auth configuration in the docs
1 parent 086aef5 commit 136a7be

1 file changed

Lines changed: 23 additions & 22 deletions

File tree

mkdocs/docs/configuration.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -339,21 +339,15 @@ catalog:
339339
340340
| Key | Example | Description |
341341
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
342-
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
342+
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343343
| 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 |
346344
| scope | openid offline corpds:ds:profile | Desired scope of the requested security token (default : catalog) |
347345
| resource | rest_catalog.iceberg.com | URI for the target resource or service |
348346
| audience | rest_catalog | Logical name of target resource or service |
349-
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
350-
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
351-
| 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. |
347+
| 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. |
348+
| 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. |
349+
| `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`) |
355350

356-
<!-- markdown-link-check-enable-->
357351

358352
#### Headers in RESTCatalog
359353

@@ -368,21 +362,28 @@ catalog:
368362
header.content-type: application/vnd.api+json
369363
```
370364

371-
Specific headers defined by the RESTCatalog spec include:
372-
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. 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. |
376365

377366
#### Authentication Options
378367
- **SigV4**: For AWS services that require SigV4 signing.
379-
- **Token**: Use the `token` property to pass a bearer token for services that accept token-based authentication.
380-
- **Credential**: Use the `credential` property with format `client_id:client_secret` for authentication.
381-
- **OAuth2**: Use the `oauth2-server-uri` property to specify a custom OAuth2 endpoint for client credentials authentication.
368+
- **OAuth2**: For services that require OAuth2 authentication.
369+
- **Bearer Token**: Use the `token` property to pass a bearer token directly for services that accept token-based authentication.
370+
- **Client Credentials**: Use the `credential` property with the format `client_id:client_secret` to perform the OAuth2 client credentials flow. Optionally, use the `oauth2-server-uri` property to specify a custom OAuth2 endpoint for client credentials authentication.
371+
372+
| Key | Example | Description |
373+
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
374+
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
375+
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
376+
| rest.signing-name | execute-api | The service signing name to use when SigV4 signing a request |
377+
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
378+
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
379+
| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog |
380+
381+
<!-- markdown-link-check-enable-->
382+
382383

383384
#### Common Integrations & Examples
384385

385-
##### Glue (AWS)
386+
##### AWS Glue
386387
```yaml
387388
catalog:
388389
s3_tables_catalog:
@@ -394,7 +395,7 @@ catalog:
394395
rest.signing-region: <region>
395396
```
396397

397-
##### Unity Catalog (Databricks)
398+
##### Unity Catalog
398399
```yaml
399400
catalog:
400401
unity_catalog:
@@ -404,7 +405,7 @@ catalog:
404405
token: <databricks-pat-token>
405406
```
406407

407-
##### R2 Data Catalog (Cloudflare)
408+
##### R2 Data Catalog
408409
```yaml
409410
catalog:
410411
r2_catalog:
@@ -426,7 +427,7 @@ catalog:
426427
scope: lakekeeper
427428
```
428429

429-
##### Polaris (Snowflake)
430+
##### Apache Polaris
430431
```yaml
431432
catalog:
432433
polaris_catalog:

0 commit comments

Comments
 (0)