Skip to content

Commit f12c6c8

Browse files
kbatuigasmicheleRP
andauthored
Additional guidance for Iceberg cluster configs for Glue catalog (#1336)
Co-authored-by: Michele Cyran <michele@redpanda.com>
1 parent c7615c9 commit f12c6c8

3 files changed

Lines changed: 45 additions & 13 deletions

File tree

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

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,35 @@ endif::[]
4040
=== Nested partition spec support
4141

4242
AWS Glue does not support partitioning on nested fields. If Redpanda detects that
43-
the default partitioning `(hour(redpanda.timestamp))` is in use, it will instead apply an empty partition spec `()`, which means the table will not be partitioned.
43+
the default partitioning `(hour(redpanda.timestamp))` based on the record metadata is in use, it will instead apply an empty partition spec `()`, which means the table will not be partitioned.
4444

45-
If you want to use partitioning, you must specify a custom partition specification using your own partition columns (columns that are not nested).
45+
To use partitioning, you must implement custom partitioning using your own partition columns (that is, columns that are not nested).
4646

47-
== Authorize access to AWS Glue
47+
[NOTE]
48+
====
49+
In Redpanda versions 25.2.1 and earlier, an empty partition spec `()` can cause a known issue that prevents certain engines like Amazon Redshift from successfully querying the table. To resolve this issue, specify custom partitioning, or upgrade Redpanda to versions 25.2.2 or later.
50+
====
4851

49-
ifndef::env-cloud[]
50-
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.
52+
=== Manual deletion of Iceberg tables
5153

52-
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. It is recommended to add all AWS Glue API actions in the policy (`"glue:*"`) on the following resources:
53-
endif::[]
54+
The AWS Glue catalog integration does not support automatic deletion of Iceberg tables from Redpanda. To manually delete Iceberg tables in AWS Glue, you must either:
5455

56+
* Set the cluster property config_ref:iceberg_delete,true,properties/cluster-properties[`iceberg_delete`] to `false` when you configure the catalog integration.
57+
ifndef::env-cloud[]
58+
* Override the cluster property `iceberg_delete` by setting the topic property xref:reference:properties/topic-properties.adoc#redpanda-iceberg-delete[`redpanda.iceberg.delete`] to `false` for the topic you want to delete.
59+
endif::[]
5560
ifdef::env-cloud[]
56-
You must allow Redpanda access to AWS Glue services in your AWS account. It is recommended to create a new IAM policy or role that manages access to AWS Glue, allowing all AWS Glue API actions (`"glue:*"`) on the following resources:
61+
* Override the cluster property `iceberg_delete` by setting the topic property `redpanda.iceberg.delete` to `false` for the topic you want to delete.
5762
endif::[]
5863

64+
When `iceberg_delete` or the topic override `redpanda.iceberg.delete` is set to `false`, you can delete the Redpanda topic, and then delete the table in AWS Glue and the Iceberg data and metadata files in the S3 bucket. If you plan to re-create the topic after deleting it, you must delete the table data entirely before re-creating the topic.
65+
66+
== Authorize access to AWS Glue
67+
68+
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.
69+
70+
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:
71+
5972
- Root catalog (`catalog`)
6073
- All databases (`database/*`)
6174
- All tables (`table/\*/*`)
@@ -100,6 +113,7 @@ endif::[]
100113
ifdef::env-cloud[]
101114
You must configure credentials for the AWS Glue Data Catalog integration using the following properties:
102115

116+
* config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`] set to `config_file`
103117
* config_ref:iceberg_rest_catalog_aws_access_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_access_key`]
104118
* 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)
105119
* config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`]
@@ -116,13 +130,15 @@ Run `rpk cluster config edit` to update these properties:
116130
+
117131
[,bash]
118132
----
119-
iceberg_enabled: true
133+
iceberg_enabled: true
134+
# Glue requires Redpanda Iceberg tables to be manually deleted
135+
iceberg_delete: false
120136
iceberg_catalog_type: rest
121137
iceberg_rest_catalog_endpoint: https://glue.<glue-region>.amazonaws.com/iceberg
122138
iceberg_rest_catalog_authentication_mode: aws_sigv4
123139
iceberg_rest_catalog_base_location: s3://<bucket-name>/<warehouse-path>
124140
# Use the iceberg_rest_catalog_aws_* properties if you want to
125-
# use separate AWS credentials for the catalog, or delete to reuse S3
141+
# use separate AWS credentials for the catalog, or omit these lines to reuse S3
126142
# (cloud_storage_*) credentials.
127143
# For access using access keys only, use iceberg_rest_catalog_aws_access_key
128144
# and iceberg_rest_catalog_aws_secret_key. For access with an IAM role, use
@@ -155,6 +171,9 @@ rpk cluster config set \
155171
iceberg_rest_catalog_endpoint=https://glue.<glue-region>.amazonaws.com/iceberg \
156172
iceberg_rest_catalog_authentication_mode=aws_sigv4 \
157173
iceberg_rest_catalog_base_location=s3://<bucket-name>/<warehouse-path> \
174+
# Set credentials source to config_file if using
175+
# iceberg_rest_catalog_aws_access_key and iceberg_rest_catalog_aws_secret_key
176+
iceberg_rest_catalog_credentials_source=config_file
158177
iceberg_rest_catalog_aws_region=<glue-region> \
159178
iceberg_rest_catalog_aws_access_key=<glue-access-key> \
160179
iceberg_rest_catalog_aws_secret_key='${secrets.<glue-secret-key-name>}'
@@ -218,7 +237,7 @@ To query the table in Amazon Athena:
218237
+
219238
[,sql]
220239
----
221-
SELECT * FROM "AwsDataCatalog"."redpanda"."<table-name>" limit 1;
240+
SELECT * FROM "AwsDataCatalog"."redpanda"."<table-name>" limit 10;
222241
----
223242
+
224243
Your query results should look like the following:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following shows the current status of Iceberg catalog integrations. Check th
6666
|===
6767
endif::[]
6868

69-
Other REST catalogs such as Dremio Nessie, Apache Polaris, and the Apache reference implementation have been tested but are not regularly verified. For more information, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
69+
Other REST catalogs, such as Apache Polaris, Dremio Nessie (to be link:https://www.dremio.com/newsroom/polaris-catalog-to-be-merged-with-nessie-now-available-on-github/[merged with Polaris]), and the Apache reference implementation, have been tested but are not regularly verified. For more information, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
7070

7171
=== Set cluster properties
7272

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2260,7 +2260,13 @@ AWS access key for Iceberg REST catalog SigV4 authentication. If not set, falls
22602260

22612261
=== iceberg_rest_catalog_credentials_source
22622262

2263+
ifndef::env-cloud[]
22632264
Source of AWS credentials for Iceberg REST catalog SigV4 authentication. If not set, falls back to xref:reference:properties/object-storage-properties.adoc#cloud_storage_credentials_source[`cloud_storage_credentials_source`] when using aws_sigv4 authentication mode.
2265+
endif::[]
2266+
2267+
ifdef::env-cloud[]
2268+
Source of AWS credentials for Iceberg REST catalog SigV4 authentication. If providing explicit credentials using `iceberg_rest_catalog_aws_access_key` and `iceberg_rest_catalog_aws_secret_key` for Glue catalog authentication, you must set this property to `config_file`.
2269+
endif::[]
22642270

22652271
*Accepted values*: `aws_instance_metadata`, `azure_aks_oidc_federation`, `azure_vm_instance_metadata`, `config_file`, `gcp_instance_metadata`, `sts`.
22662272

@@ -5679,7 +5685,14 @@ Always normalize schemas. If set, this overrides the `normalize` parameter in re
56795685
=== schema_registry_enable_authorization
56805686

56815687
Enables ACL-based authorization for Schema Registry requests. When `true`, Schema Registry
5682-
uses ACL-based authorization instead of the default `public/user/superuser` authorization model. Requires authentication to be enabled using the xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[`authentication_method`] property in the `schema_registry_api` broker configuration.
5688+
uses ACL-based authorization instead of the default `public/user/superuser` authorization model.
5689+
5690+
ifndef::env-cloud[]
5691+
Requires authentication to be enabled using the xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[`authentication_method`] property in the `schema_registry_api` broker configuration.
5692+
endif::[]
5693+
ifdef::env-cloud[]
5694+
Requires authentication to be enabled using the `authentication_method` property in the `schema_registry_api` broker configuration.
5695+
endif::[]
56835696

56845697
*Requires restart:* No
56855698

0 commit comments

Comments
 (0)