Skip to content

Iceberg: Emphasize setting REST catalog type and endpoint properties together #1183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kbatuigas merged 3 commits into from
Jun 27, 2025
Merged

Iceberg: Emphasize setting REST catalog type and endpoint properties together #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f5e94c
Emphasize setting rest catalog type and endpoint properties together
kbatuigas Jun 27, 2025
b0afa20
Add note to property reference
kbatuigas Jun 27, 2025
d7016b3
Apply suggestions from code review
kbatuigas Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion modules/manage/partials/iceberg/use-iceberg-catalogs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,14 @@ endif::[]
To connect to a REST catalog, set the following cluster configuration properties:

* config_ref:iceberg_catalog_type,true,properties/cluster-properties[`iceberg_catalog_type`]: `rest`
* config_ref:iceberg_rest_catalog_endpoint,true,properties/cluster-properties[`iceberg_rest_catalog_endpoint`]: The endpoint URL for your Iceberg catalog, which you either manage directly, or is managed by an external catalog service.
* config_ref:iceberg_rest_catalog_endpoint,true,properties/cluster-properties[`iceberg_rest_catalog_endpoint`]: The endpoint URL for your Iceberg catalog. You either manage this directly, or you have this managed by an external catalog service.

NOTE: You must set `iceberg_rest_catalog_endpoint` at the same time that you set `iceberg_catalog_type` to `rest`.

==== Configure authentication

To authenticate with the REST catalog, set the following cluster properties:

* config_ref:iceberg_rest_catalog_authentication_mode,true,properties/cluster-properties[`iceberg_rest_catalog_authentication_mode`]: The authentication mode to use for the REST catalog. Choose from `oauth2`, `bearer`, or `none` (default).
ifdef::env-cloud[]
+
Expand Down
4 changes: 4 additions & 0 deletions modules/reference/pages/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1898,6 +1898,8 @@ The frequency at which the Iceberg coordinator commits topic files to the catalo

Iceberg catalog type that Redpanda will use to commit table metadata updates. Supported types: `rest`, `object_storage`.

NOTE: You must set <<iceberg_rest_catalog_endpoint,`iceberg_rest_catalog_endpoint`>> at the same time that you set `iceberg_catalog_type` to `rest`.

*Requires restart:* Yes

*Visibility:* `user`
Expand Down Expand Up @@ -2176,6 +2178,8 @@ Path to certificate revocation list for `iceberg_rest_catalog_trust_file`.

URL of Iceberg REST catalog endpoint.

NOTE: If you set <<iceberg_catalog_type,`iceberg_catalog_type`>> to `rest`, you must also set this property at the same time.

*Requires restart:* Yes

*Visibility:* `user`
Expand Down