Skip to content

DOC-1287 hide defaults in cloud cluster properties #1107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged

DOC-1287 hide defaults in cloud cluster properties #1107

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1cd0bc
DOC-1287 hide defaults in cloud cluster properties
micheleRP May 6, 2025
8402f3c
incorporate feedback from doc review
micheleRP May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions modules/reference/pages/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,11 @@ Enables or disables audit logging. When you set this to true, Redpanda checks fo

*Type:* boolean

ifndef::env-cloud[]
*Enterprise license required*: `true`
Copy link
Contributor

@asimms41 asimms41 May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't this line be excluded for Cloud as well?

Copy link
Contributor Author

@micheleRP micheleRP May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed, thank you!


*Default:* `false`
endif::[]

---

Expand Down Expand Up @@ -188,7 +190,9 @@ List of user principals to exclude from auditing.

*Type:* array

ifndef::env-cloud[]
*Default:* `null`
endif::[]

---

Expand All @@ -206,7 +210,9 @@ List of topics to exclude from auditing.

*Type:* array

ifndef::env-cloud[]
*Default:* `null`
endif::[]

---

Expand All @@ -226,7 +232,9 @@ Defines the number of partitions used by a newly-created audit topic. This confi

*Accepted values:* [`-2147483648`, `2147483647`]

ifndef::env-cloud[]
*Default:* `12`
endif::[]

---

Expand Down Expand Up @@ -704,7 +712,9 @@ Enables WebAssembly-powered data transforms directly in the broker. When `data_t

*Type:* boolean

ifndef::env-cloud[]
*Default:* `false`
endif::[]

---

Expand Down Expand Up @@ -758,7 +768,9 @@ Transform log lines truncate to this length. Truncation occurs after any charact

*Type:* integer

ifndef::env-cloud[]
*Default:* `1024`
endif::[]

---

Expand All @@ -774,7 +786,9 @@ The amount of memory to reserve per core for data transform (Wasm) virtual machi

*Type:* integer

ifndef::env-cloud[]
*Default:* `20971520`
endif::[]

---

Expand Down Expand Up @@ -1814,7 +1828,9 @@ Iceberg catalog type that Redpanda will use to commit table metadata updates. Su

*Accepted values:* `rest`, `object_storage`

ifndef::env-cloud[]
*Default:* `object_storage`
endif::[]

**Related topics**:

Expand All @@ -1841,13 +1857,15 @@ endif::[]

*Type:* string

ifndef::env-cloud[]
*Default:* `(hour(redpanda.timestamp))`

Partitions the topic by extracting the hour from `redpanda.timestamp`, grouping records by hour to optimize queries.
endif::[]

**Related topics**:

Copy link
Contributor

@asimms41 asimms41 May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should link on line below be Enable Iceberg Integration to match the page heading?

- xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Enable Iceberg]
- xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Enable Iceberg integration]

---

Expand All @@ -1864,7 +1882,9 @@ Default value for the `redpanda.iceberg.delete` topic property that determines i

*Type:* boolean

ifndef::env-cloud[]
*Default:* `true`
endif::[]

**Related topics**:

Expand Down Expand Up @@ -1923,7 +1943,9 @@ endif::[]

*Type:* boolean

ifndef::env-cloud[]
*Default:* `false`
endif::[]

**Related topics**:

Expand All @@ -1948,7 +1970,9 @@ endif::[]

*Visibility:* `user`

ifndef::env-cloud[]
*Default:* `dlq_table`
endif::[]

**Related topics**:

Expand All @@ -1967,7 +1991,9 @@ The authentication mode for client requests made to the Iceberg catalog. Choose

*Visibility:* `user`

ifndef::env-cloud[]
*Default:* `none`
endif::[]

**Related topics**:

Expand All @@ -1988,7 +2014,9 @@ The client ID used to query the REST catalog API for the OAuth token. Required i

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2009,7 +2037,9 @@ Secret used with the client ID to query the OAuth token endpoint for Iceberg RES

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2030,7 +2060,9 @@ The contents of a certificate revocation list for `iceberg_rest_catalog_trust`.

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

---

Expand Down Expand Up @@ -2065,7 +2097,9 @@ URL of Iceberg REST catalog endpoint.

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2086,7 +2120,9 @@ The OAuth URI used to retrieve access tokens for Iceberg REST catalog authentica

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2107,7 +2143,9 @@ The OAuth scope used to retrieve access tokens for Iceberg catalog authenticatio

*Type:* string

ifndef::env-cloud[]
*Default:* `principal_role:all`
endif::[]

**Related topics**:

Expand All @@ -2128,7 +2166,9 @@ Prefix part of the Iceberg REST catalog URL. Prefix is appended to the catalog p

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2153,7 +2193,9 @@ Maximum length of time that Redpanda waits for a response from the REST catalog

*Accepted values:* [`-17592186044416`, `17592186044415`]

ifndef::env-cloud[]
*Default:* `10000`
endif::[]

**Related topics**:

Expand All @@ -2176,7 +2218,9 @@ Required if <<iceberg_rest_catalog_authentication_mode, `iceberg_rest_catalog_au

*Type:* string

ifndef::env-cloud[]
*Default:* `null`
endif::[]

**Related topics**:

Expand All @@ -2189,9 +2233,9 @@ Required if <<iceberg_rest_catalog_authentication_mode, `iceberg_rest_catalog_au
// tag::iceberg_rest_catalog_trust[]
=== iceberg_rest_catalog_trust

The contents of a certificate chain to trust for the REST Iceberg catalog.
The contents of a certificate chain to trust for the REST Iceberg catalog.

ifndef::end-cloud[]
ifndef::env-cloud[]
Takes precedence over <<iceberg_rest_catalog_trust_file, `iceberg_rest_catalog_trust_file`>>.
endif::[]

Expand All @@ -2201,7 +2245,9 @@ endif::[]

*Type:* string

ifndef::env-cloud[]
Copy link
Contributor

@asimms41 asimms41 May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anchor link above <<iceberg_rest_catalog_trust_file, iceberg_rest_catalog_trust_file>> is not working.

Copy link
Contributor Author

@micheleRP micheleRP May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

*Default:* `null`
endif::[]

---

Expand Down Expand Up @@ -2268,7 +2314,9 @@ endif::[]

*Accepted values:* [`-17592186044416`, `17592186044415`]

ifndef::env-cloud[]
*Default:* `60000`
endif::[]

**Related topics**:

Expand Down