Skip to content

Commit 5101d27

Browse files
committed
DOC-1437 Recommend oauth2
1 parent 4127575 commit 5101d27

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ To connect to a REST catalog, set the following cluster configuration properties
6060
* config_ref:iceberg_catalog_type,true,properties/cluster-properties[`iceberg_catalog_type`]: `rest`
6161
* 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.
6262
* 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).
63+
ifdef::env-cloud[]
64+
+
65+
Redpanda recommends using `oauth2`.
66+
67+
endif::[]
6368
** For `oauth2`, also configure the following properties:
6469
+
6570
--
@@ -111,6 +116,11 @@ Run the following `rpk` command:
111116
----
112117
rpk security secret create --name <secret-name> --value <secret-value> --scopes redpanda_cluster
113118
----
119+
120+
Replace the placeholders with your own values:
121+
122+
- `<secret-name>`: The name of the secret you want to add. The secret name is also its ID. Use only the following characters: `^[A-Z][A-Z0-9_]*$`.
123+
- `<secret-value>`: The value of the secret.
114124
--
115125
116126
Cloud API::

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2068,6 +2068,10 @@ endif::[]
20682068

20692069
The authentication mode for client requests made to the Iceberg catalog. Choose from: `none`, `bearer`, and `oauth2`. In `bearer` mode, the token specified in `iceberg_rest_catalog_token` is used unconditionally, and no attempts are made to refresh the token. In `oauth2` mode, the credentials specified in `iceberg_rest_catalog_client_id` and `iceberg_rest_catalog_client_secret` are used to obtain a bearer token from the URI defined by `iceberg_rest_catalog_oauth2_server_uri.`.
20702070

2071+
ifdef::env-cloud[]
2072+
Redpanda recommends using `oauth2`.
2073+
endif::[]
2074+
20712075
*Requires restart:* Yes
20722076

20732077
*Visibility:* `user`

0 commit comments

Comments
 (0)