Skip to content

Commit 64d89a3

Browse files
kbatuigasmicheleRP
authored andcommitted
Iceberg: Emphasize setting REST catalog type and endpoint properties together (#1183)
Co-authored-by: Michele Cyran <michele@redpanda.com>
1 parent 59a00f0 commit 64d89a3

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

modules/manage/partials/iceberg/use-iceberg-catalogs.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,14 @@ endif::[]
5858
To connect to a REST catalog, set the following cluster configuration properties:
5959

6060
* config_ref:iceberg_catalog_type,true,properties/cluster-properties[`iceberg_catalog_type`]: `rest`
61-
* 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.
61+
* 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.
62+
63+
NOTE: You must set `iceberg_rest_catalog_endpoint` at the same time that you set `iceberg_catalog_type` to `rest`.
64+
65+
==== Configure authentication
66+
67+
To authenticate with the REST catalog, set the following cluster properties:
68+
6269
* 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).
6370
ifdef::env-cloud[]
6471
+

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1898,6 +1898,8 @@ The frequency at which the Iceberg coordinator commits topic files to the catalo
18981898

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

1901+
NOTE: You must set <<iceberg_rest_catalog_endpoint,`iceberg_rest_catalog_endpoint`>> at the same time that you set `iceberg_catalog_type` to `rest`.
1902+
19011903
*Requires restart:* Yes
19021904

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

21772179
URL of Iceberg REST catalog endpoint.
21782180

2181+
NOTE: If you set <<iceberg_catalog_type,`iceberg_catalog_type`>> to `rest`, you must also set this property at the same time.
2182+
21792183
*Requires restart:* Yes
21802184

21812185
*Visibility:* `user`

0 commit comments

Comments
 (0)