Skip to content

Commit 596800c

Browse files
committed
add iceberg properties
1 parent 0cf4b28 commit 596800c

File tree

1 file changed

+136
-0
lines changed

1 file changed

+136
-0
lines changed

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

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1520,6 +1520,52 @@ A list of supported HTTP authentication mechanisms.
15201520

15211521
---
15221522

1523+
=== iceberg_catalog_base_location
1524+
1525+
Base path for the cloud object storage-backed Iceberg catalog. After Iceberg is enabled, do not change this value.
1526+
1527+
*Requires restart:* Yes
1528+
1529+
*Visibility:* `user`
1530+
1531+
*Type:* string
1532+
1533+
*Default:* `redpanda-iceberg-catalog`
1534+
1535+
---
1536+
1537+
=== iceberg_catalog_commit_interval_ms
1538+
1539+
The frequency at which the Iceberg coordinator commits topic files to the catalog. This is the interval between commit transactions across all topics monitored by the coordinator, not the interval between individual commits.
1540+
1541+
*Unit:* milliseconds
1542+
1543+
*Requires restart:* No
1544+
1545+
*Visibility:* `tunable`
1546+
1547+
*Type:* integer
1548+
1549+
*Accepted values:* [`-17592186044416`, `17592186044415`]
1550+
1551+
*Default:* `60000`
1552+
1553+
---
1554+
1555+
=== iceberg_catalog_type
1556+
1557+
Iceberg catalog type that Redpanda will use to commit table metadata updates.
1558+
1559+
*Requires restart:* Yes
1560+
1561+
*Visibility:* `user`
1562+
1563+
*Accepted Values:* `rest`, `filesystem`
1564+
1565+
*Default:* `filesystem`
1566+
1567+
---
1568+
15231569
=== iceberg_enabled
15241570

15251571
Enables the translation of topic data into Iceberg tables. Setting `iceberg_enabled` to `true` activates the feature at the cluster level, but each topic must also set the `redpanda.iceberg.enabled` topic-level property to `true` to use it. If `iceberg_enabled` is set to `false`, then the feature is disabled for all topics in the cluster, overriding any topic-level settings.
@@ -1534,6 +1580,96 @@ Enables the translation of topic data into Iceberg tables. Setting `iceberg_enab
15341580

15351581
---
15361582

1583+
=== iceberg_rest_catalog_endpoint
1584+
1585+
URL of Iceberg REST catalog endpoint.
1586+
1587+
*Requires restart:* Yes
1588+
1589+
*Visibility:* `user`
1590+
1591+
*Type:* string
1592+
1593+
*Default:* `null`
1594+
1595+
---
1596+
1597+
=== iceberg_rest_catalog_request_timeout_ms
1598+
1599+
Maximum length of time that Redpanda waits for a response from the REST catalog before aborting the request.
1600+
1601+
*Unit:* milliseconds
1602+
1603+
*Requires restart:* No
1604+
1605+
*Visibility:* `tunable`
1606+
1607+
*Type:* integer
1608+
1609+
*Accepted values:* [`-17592186044416`, `17592186044415`]
1610+
1611+
*Default:* `10000`
1612+
1613+
---
1614+
1615+
=== iceberg_rest_catalog_secret
1616+
1617+
Secret to authenticate against Iceberg REST catalog. Required if catalog type is set to `rest`.
1618+
1619+
*Requires restart:* Yes
1620+
1621+
*Visibility:* `user`
1622+
1623+
*Type:* string
1624+
1625+
*Default:* `null`
1626+
1627+
---
1628+
1629+
=== iceberg_rest_catalog_token
1630+
1631+
Token used to access the REST Iceberg catalog. If the token is present, Redpanda ignores credentials stored in the properties <<iceberg_rest_catalog_user_id,`iceberg_rest_catalog_user_id`>> and <<iceberg_rest_catalog_secret,`iceberg_rest_catalog_secret`>>.
1632+
1633+
*Requires restart:* Yes
1634+
1635+
*Visibility:* `user`
1636+
1637+
*Type:* string
1638+
1639+
*Default:* `null`
1640+
1641+
---
1642+
1643+
=== iceberg_rest_catalog_user_id
1644+
1645+
Iceberg REST catalog user ID. This ID is used to query the catalog API for the OAuth token. Required if catalog type is set to `rest`.
1646+
1647+
*Requires restart:* Yes
1648+
1649+
*Visibility:* `user`
1650+
1651+
*Type:* string
1652+
1653+
*Default:* `null`
1654+
1655+
---
1656+
1657+
=== iceberg_translation_interval_ms_default
1658+
1659+
How often an Iceberg enabled topic is checked for new data to translate. You can override this value at topic level using `redpanda.iceberg.translation.interval.ms`.
1660+
1661+
*Requires restart:* No
1662+
1663+
*Visibility:* `tunable`
1664+
1665+
*Type:* integer
1666+
1667+
*Accepted values:* [`-17592186044416`, `17592186044415`]
1668+
1669+
*Default:* `60000`
1670+
1671+
---
1672+
15371673
=== id_allocator_batch_size
15381674

15391675
The ID allocator allocates messages in batches (each batch is a one log record) and then serves requests from memory without touching the log until the batch is exhausted.

0 commit comments

Comments
 (0)