Skip to content

Commit 7d06160

Browse files
kbatuigasFeediver1
andauthored
Iceberg Cloud docs: BYOVPC, IAM auth (#1633)
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
1 parent c4f9842 commit 7d06160

7 files changed

Lines changed: 109 additions & 62 deletions

File tree

modules/manage/pages/iceberg/about-iceberg-topics.adoc

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ When you enable the Iceberg integration for a Redpanda topic, Redpanda brokers s
4545
To enable Iceberg for Redpanda topics, you must have the following:
4646

4747
ifdef::env-cloud[]
48-
* A running xref:get-started:cluster-types/byoc/index.adoc[BYOC] cluster on Redpanda version 25.1 or later. The Iceberg integration is supported only for BYOC, and the cluster properties to configure Iceberg are available with v25.1.
48+
* A running xref:get-started:cluster-types/byoc/index.adoc[BYOC] or BYOVPC cluster on Redpanda version 25.1 or later. The Iceberg integration is supported only for BYOC and BYOVPC, and the cluster properties to configure Iceberg are available with v25.1.
4949
* rpk: See xref:get-started:rpk-install.adoc[].
5050
* Familiarity with the Redpanda Cloud API. You must link:/api/doc/cloud-controlplane/authentication[authenticate] to the Cloud API and use the Control Plane API to update your cluster configuration.
5151
endif::[]
@@ -189,26 +189,9 @@ ifdef::env-cloud[]
189189

190190
=== Access Iceberg data
191191

192-
To query the Iceberg table, you need access to the object storage bucket or container where the Iceberg data is stored. For BYOC clusters, the bucket name and table location are as follows:
192+
To query the Iceberg table, you need access to the object storage bucket or container where the Iceberg data is stored.
193193

194-
|===
195-
| Cloud provider | Bucket or container name | Iceberg table location
196-
197-
| AWS
198-
| `redpanda-cloud-storage-<cluster-id>`
199-
.3+a| `redpanda-iceberg-catalog/redpanda/<topic-name>`
200-
201-
| Azure
202-
a| `<cluster-id>`
203-
204-
The Redpanda cluster ID is also used as the container name (ID) and the storage account ID.
205-
206-
207-
| GCP
208-
| `redpanda-cloud-storage-<cluster-id>`
209-
210-
211-
|===
194+
include::manage:partial$iceberg-access-table.adoc[]
212195

213196
For Azure clusters, you must add the public IP addresses or ranges from the REST catalog service, or other clients requiring access to the Iceberg data, to your cluster's allow list. Alternatively, add subnet IDs to the allow list if the requests originate from the same Azure region.
214197

modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc

Lines changed: 79 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ This guide walks you through querying Redpanda topics as Iceberg tables stored i
2323

2424
== Prerequisites
2525

26+
* An AWS account with access to https://docs.aws.amazon.com/glue/latest/dg/what-is-glue.html[AWS Glue Data Catalog^].
27+
ifdef::env-cloud[]
28+
** AWS Glue Data Catalog must be in the same AWS account and region as the cluster.
29+
endif::[]
2630
* Redpanda version {rp_version} or later.
2731
* xref:{rpk_install_doc}[`rpk`] installed or updated to the latest version.
2832
ifdef::env-cloud[]
@@ -69,6 +73,13 @@ When `iceberg_delete` or the topic override `redpanda.iceberg.delete` is set to
6973

7074
== Authorize access to AWS Glue
7175

76+
ifdef::env-cloud[]
77+
For BYOC clusters created in March 2026 or later, the required AWS Glue IAM policy is automatically provisioned and attached to the cluster's IAM role when Iceberg is enabled. You don't need to manually create IAM policies or roles for Glue access.
78+
79+
For clusters created before March 2026, you must re-run `rpk byoc apply` to provision the Glue IAM policy before enabling Iceberg. This is a one-time operation that updates the cluster's IAM role with the necessary Glue permissions.
80+
endif::[]
81+
82+
ifndef::env-cloud[]
7283
You must allow Redpanda access to AWS Glue services in your AWS account. You can use the same access credentials that you configured for S3 (IAM role, access keys, and KMS key), as long as you have also added read and write access to AWS Glue Data Catalog.
7384

7485
For example, you could create a separate IAM policy that manages access to AWS Glue and attach it to the IAM role that Redpanda also uses to access S3. Add all AWS Glue API actions in the policy (`"glue:*"`) on the following resources:
@@ -100,27 +111,38 @@ Your IAM policy should include a statement similar to the following:
100111
----
101112

102113
For more information on configuring IAM permissions, see the https://docs.aws.amazon.com/glue/latest/dg/configure-iam-for-glue.html[AWS Glue documentation^].
114+
endif::[]
103115

104116
== Configure authentication and credentials
105117

106118
ifndef::env-cloud[]
107119
You must configure credentials for the AWS Glue Data Catalog integration in either of the following ways:
108120

109-
* Allow Redpanda to use the same `cloud_storage_*` credential properties configured for S3. If you do not configure the overrides listed below, Redpanda uses the same credentials for both S3 and AWS Glue. This is the recommended approach.
121+
* Allow Redpanda to use the same `cloud_storage_*` credential properties configured for S3. This is the recommended approach.
110122
* If you want to configure authentication to AWS Glue separately from authentication to S3, there are equivalent credential configuration properties named `iceberg_rest_catalog_aws_*` that override the object storage credentials. These properties only apply to REST catalog authentication, and never to S3 authentication:
123+
** config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`] overrides config_ref:cloud_storage_credentials_source,true,properties/cluster-properties[`cloud_storage_credentials_source`]
111124
** config_ref:iceberg_rest_catalog_aws_access_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_access_key`] overrides config_ref:cloud_storage_access_key,true,properties/cluster-properties[`cloud_storage_access_key`]
112125
** config_ref:iceberg_rest_catalog_aws_secret_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_secret_key`] overrides config_ref:cloud_storage_secret_key,true,properties/cluster-properties[`cloud_storage_secret_key`]
113126
** config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] overrides config_ref:cloud_storage_region,true,properties/cluster-properties[`cloud_storage_region`]
114-
** config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`] overrides config_ref:cloud_storage_credentials_source,true,properties/cluster-properties[`cloud_storage_credentials_source`]
115127
endif::[]
116128

117129
ifdef::env-cloud[]
118-
You must configure credentials for the AWS Glue Data Catalog integration using the following properties:
130+
You can configure credentials for the AWS Glue Data Catalog integration in either of the following ways:
131+
132+
* Allow Redpanda to use the same object storage credential properties already configured for S3. This is the recommended approach, especially in BYOC deployments where the cluster's existing AWS credentials already include the necessary Glue permissions.
133+
+
134+
For an example cluster configuration that uses the same IAM credentials for both S3 and AWS Glue, see the *Use cluster's IAM credentials* tab in the <<update-cluster-configuration,next section>>.
135+
* If you want to configure authentication to AWS Glue separately from authentication to S3, there are equivalent credential configuration properties named `iceberg_rest_catalog_aws_*` that override the object storage credentials. These properties only apply to REST catalog authentication, and never to S3 authentication:
136+
+
137+
--
138+
** config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`]. To use the cluster's IAM role, set the property to `aws_instance_metadata`. To use static credentials, set to `config_file`.
139+
** config_ref:iceberg_rest_catalog_aws_access_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_access_key`] (static credentials only)
140+
** config_ref:iceberg_rest_catalog_aws_secret_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_secret_key`] (static credentials only), added as a secret value (see the <<update-cluster-configuration,next section>> for details)
141+
** config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`]
142+
--
143+
+
144+
For an example cluster configuration that uses separate access keys for AWS Glue, see the *Use static credentials (override IAM)* tab in the <<update-cluster-configuration,next section>>.
119145

120-
* config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`] set to `config_file`
121-
* config_ref:iceberg_rest_catalog_aws_access_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_access_key`]
122-
* config_ref:iceberg_rest_catalog_aws_secret_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_secret_key`], added as a secret value (see the <<update-cluster-configuration,next section>> for details)
123-
* config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`]
124146
endif::[]
125147

126148
== Update cluster configuration
@@ -144,8 +166,8 @@ iceberg_delete: false
144166
iceberg_catalog_type: rest
145167
iceberg_rest_catalog_endpoint: https://glue.<glue-region>.amazonaws.com/iceberg
146168
iceberg_rest_catalog_authentication_mode: aws_sigv4
147-
# Because Tiered Storage does not support the use of distinct buckets for Iceberg,
148-
# always place iceberg_rest_catalog_base_location in the same S3 bucket as cloud_storage_bucket
169+
# Because Redpanda does not support the use of distinct buckets for Iceberg,
170+
# always place iceberg_rest_catalog_base_location in the same S3 bucket as cloud_storage_bucket
149171
iceberg_rest_catalog_base_location: s3://<bucket-name>/<warehouse-path>
150172
# Use the iceberg_rest_catalog_aws_* properties if you want to
151173
# use separate AWS credentials for the catalog, or omit these lines to reuse S3
@@ -162,42 +184,77 @@ iceberg_rest_catalog_base_location: s3://<bucket-name>/<warehouse-path>
162184
Use your own values for the following placeholders:
163185
+
164186
--
165-
- `<glue-region>`: The AWS region where your Data Catalog is located. The region in the AWS Glue endpoint must match the region specified in either your config_ref:cloud_storage_region,true,properties/cluster-properties[`cloud_storage_region`] or config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] property.
166-
- `<bucket-name>` and `<warehouse-path>`: AWS Glue requires you to specify the base location where Redpanda stores Iceberg data and metadata files. You must use an S3 URI; for example, `s3://<bucket-name>/iceberg`. As a security best practice, Redpanda Data recommends specifying a subfolder (using prefixes) rather than the root of the bucket.
187+
* `<glue-region>`: The AWS region where your Data Catalog is located. The region in the AWS Glue endpoint must match the region specified in either your config_ref:cloud_storage_region,true,properties/cluster-properties[`cloud_storage_region`] or config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] property.
188+
* `<bucket-name>` and `<warehouse-path>`: AWS Glue requires you to specify the base location where Redpanda stores Iceberg data and metadata files. You must use an S3 URI; for example, `s3://<bucket-name>/iceberg`. This must be the same bucket used for object storage (your `cloud_storage_bucket`). You cannot specify a different bucket for Iceberg data.
189+
+
190+
`<warehouse-path>` is a name you choose (such as `iceberg`) as the logical name for the warehouse represented by all Redpanda Iceberg topic data in the cluster.
191+
+
192+
As a security best practice, do not use the bucket root for the base location. Always specify a subfolder to avoid interfering with your cluster's data in object storage.
167193
--
168194
endif::[]
169195
ifdef::env-cloud[]
170-
Use `rpk` like in the following example, or use the Cloud API to xref:manage:cluster-maintenance/config-cluster.adoc#set-cluster-configuration-properties[update these cluster properties]. The update might take several minutes to complete.
196+
Use `rpk` as shown in the following examples, or xref:manage:cluster-maintenance/config-cluster.adoc#set-cluster-configuration-properties[use the Cloud API] to update these cluster properties. The update might take several minutes to complete.
197+
+
198+
[tabs]
199+
======
200+
Use cluster's IAM credentials::
171201
+
202+
--
172203
[,bash]
173204
----
205+
# Glue requires Redpanda Iceberg tables to be manually deleted
206+
# so iceberg_delete is set to false.
174207
rpk cloud login
175208
176209
rpk profile create --from-cloud <cluster-id>
177210
178211
rpk cluster config set \
179212
iceberg_enabled=true \
213+
iceberg_delete=false \
214+
iceberg_catalog_type=rest \
215+
iceberg_rest_catalog_endpoint=https://glue.<glue-region>.amazonaws.com/iceberg \
216+
iceberg_rest_catalog_authentication_mode=aws_sigv4 \
217+
iceberg_rest_catalog_credentials_source=aws_instance_metadata \
218+
iceberg_rest_catalog_aws_region=<glue-region> \
219+
iceberg_rest_catalog_base_location=s3://<cluster-storage-bucket-name>/<warehouse-path>
220+
----
221+
--
222+
223+
Use static credentials (override IAM)::
224+
+
225+
--
226+
[,bash]
227+
----
228+
# Glue requires Redpanda Iceberg tables to be manually deleted
229+
# so iceberg_delete is set to false.
230+
rpk cluster config set \
231+
iceberg_enabled=true \
232+
iceberg_delete=false \
180233
iceberg_catalog_type=rest \
181234
iceberg_rest_catalog_endpoint=https://glue.<glue-region>.amazonaws.com/iceberg \
182235
iceberg_rest_catalog_authentication_mode=aws_sigv4 \
183-
# Because Tiered Storage does not support the use of distinct buckets for Iceberg,
184-
# always place iceberg_rest_catalog_base_location in the same S3 bucket as cloud_storage_bucket
185-
iceberg_rest_catalog_base_location=s3://<bucket-name>/<warehouse-path> \
186-
# Set credentials source to config_file if using
187-
# iceberg_rest_catalog_aws_access_key and iceberg_rest_catalog_aws_secret_key
188236
iceberg_rest_catalog_credentials_source=config_file \
189237
iceberg_rest_catalog_aws_region=<glue-region> \
190238
iceberg_rest_catalog_aws_access_key=<glue-access-key> \
191-
iceberg_rest_catalog_aws_secret_key='${secrets.<glue-secret-key-name>}'
239+
iceberg_rest_catalog_aws_secret_key='${secrets.<glue-secret-key-name>}' \
240+
iceberg_rest_catalog_base_location=s3://<cluster-storage-bucket-name>/<warehouse-path>
192241
----
242+
--
243+
======
193244
+
194245
Use your own values for the following placeholders:
195246
+
196247
--
197-
- `<glue-region>`: The AWS region where your Data Catalog is located. The region in the AWS Glue endpoint must match the region specified in your config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] property.
198-
- `<bucket-name>` and `<warehouse-path>`: AWS Glue requires you to specify the base location where Redpanda stores Iceberg data and metadata files. You must use an S3 URI; for example, `s3://<bucket-name>/iceberg`. As a security best practice, Redpanda Data recommends specifying a subfolder (using prefixes) rather than the root of the bucket.
199-
- `<glue-access-key>`: The AWS access key ID for your Glue service account.
200-
- `<glue-secret-key-name>`: The name of the secret that stores the AWS secret access key for your Glue service account. To reference a secret in a cluster property, for example `iceberg_rest_catalog_aws_secret_key`, you must first xref:manage:iceberg/use-iceberg-catalogs.adoc#store-a-secret-for-rest-catalog-authentication[store the secret value].
248+
* `<glue-region>`: The AWS region where your Data Catalog is located. The region in the AWS Glue endpoint must match the region specified in your config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] property.
249+
* `<cluster-storage-bucket-name>` and `<warehouse-path>`: AWS Glue requires you to specify the base location where Redpanda stores Iceberg data and metadata files. You must use an S3 URI; for example, `s3://<cluster-storage-bucket-name>/iceberg`.
250+
** Bucket name: For BYOC clusters, the bucket name is `redpanda-cloud-storage-<cluster-id>`. For BYOVPC clusters, use the name of the object storage bucket you created as a xref:get-started:cluster-types/byoc/aws/vpc-byo-aws.adoc#configure-the-redpanda-network-and-cluster[customer-managed resource].
251+
+
252+
This must be the same bucket used for your cluster's object storage. You cannot specify a different bucket for Iceberg data.
253+
** Warehouse: This is a name you choose as the logical name (such as `iceberg`) for the warehouse represented by all Redpanda Iceberg topic data in the cluster.
254+
+
255+
As a security best practice, do not use the bucket root for the base location. Always specify a subfolder to avoid interfering with the rest of your cluster's data in object storage.
256+
* `<glue-access-key>` (static credentials only): The AWS access key ID for your Glue service account.
257+
* `<glue-secret-key-name>` (static credentials only): The name of the secret that stores the AWS secret access key for your Glue service account. To reference a secret in a cluster property, for example `iceberg_rest_catalog_aws_secret_key`, you must first xref:manage:iceberg/use-iceberg-catalogs.adoc#store-a-secret-for-rest-catalog-authentication[store the secret value].
201258
--
202259
endif::[]
203260
+

modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Follow the steps in the https://docs.databricks.com/aws/en/connect/unity-catalog
7373
The external location stores the Unity Catalog-managed Iceberg metadata, and the Iceberg data written by Redpanda. You must use the same bucket configured for glossterm:Tiered Storage[] for your Redpanda cluster.
7474

7575
ifdef::env-cloud[]
76-
For BYOC clusters, the bucket name is `redpanda-cloud-storage-<cluster-id>`, where `<cluster-id>` is the ID of your Redpanda cluster.
76+
For BYOC clusters, the bucket name is `redpanda-cloud-storage-<cluster-id>`, where `<cluster-id>` is the ID of your Redpanda cluster. For BYOVPC clusters, the bucket name is the name you chose when you created the object storage bucket as a customer-managed resource.
7777
endif::[]
7878

7979
Follow the steps in the https://docs.databricks.com/aws/en/connect/unity-catalog/cloud-storage/external-locations[Databricks documentation] to *manually* create an external location. You can create the external location in the Catalog Explorer or with SQL. You must create the external location manually because the location needs to be associated with the existing Tiered Storage bucket URL, `s3://<bucket-name>`.

modules/manage/pages/iceberg/query-iceberg-topics.adoc

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,7 @@ endif::[]
2727
ifdef::env-cloud[]
2828
Redpanda generates an Iceberg table with the same name as the topic. Depending on the processing engine and your Iceberg catalog implementation, you may also need to define the table (for example using `CREATE TABLE`) to point the data lakehouse to its location in the catalog.
2929

30-
For BYOC clusters, the bucket name and table location are as follows:
31-
32-
|===
33-
| Cloud provider | Bucket or container name | Iceberg table location
34-
35-
| AWS
36-
| `redpanda-cloud-storage-<cluster-id>`
37-
.3+a| `redpanda-iceberg-catalog/redpanda/<topic-name>`
38-
39-
| Azure
40-
a| `<cluster-id>`
41-
42-
The Redpanda cluster ID is also used as the container name (ID) and the storage account ID.
43-
44-
| GCP
45-
| `redpanda-cloud-storage-<cluster-id>`
46-
47-
|===
30+
include::manage:partial$iceberg-access-table.adoc[]
4831

4932
For Azure clusters, you must add the public IP addresses or ranges from the REST catalog service, or other clients requiring access to the Iceberg data, to your cluster's allow list. Alternatively, add subnet IDs to the allow list if the requests originate from the same Azure region.
5033

0 commit comments

Comments
 (0)