Skip to content
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.

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

INC-675 Add warning not to modify properties managed by Redpanda programs #979

Merged
merged 4 commits into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions modules/develop/pages/config-topics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ The cleanup policy determines how to clean up the partition log files when they

Unlike compacted topics, which keep only the most recent message for a given key, topics configured with a `delete` cleanup policy provide a running history of all changes for those topics.

include::develop:partial$topic-properties-warning.adoc[]

For example, to change a topic's policy to `compact`, run:

[,bash]
Expand Down
1 change: 1 addition & 0 deletions modules/develop/partials/topic-properties-warning.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
WARNING: Modifying the properties of topics that are created and managed by Redpanda applications can cause unexpected errors. This may lead to connector and cluster failures.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Compaction policy may be applied to a cluster or to an individual topic. If both
* `compact`: This triggers only cleanup of records with multiple versions. A record that represents the only version for a given key is not deleted.
* `compact,delete`: This combines both policies, deleting records exceeding the retention period while compacting multiple versions of records.

include::develop:partial$topic-properties-warning.adoc[]

== Tombstone record removal

Compaction also enables deletion of existing records through tombstones. For example, as data is deleted from a source system, clients produce a tombstone record to the log. A tombstone contains a key and the value `null`. Tombstones signal to brokers and consumers that records with the same key prior to it in the log should be deleted.
Expand Down
2 changes: 2 additions & 0 deletions modules/manage/pages/kubernetes/k-manage-topics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ The cleanup policy determines how to manage the partition log files when they re

If the cleanup policy is `delete` or `compact,delete` you can <<Delete records from a topic>>.

include::develop:partial$topic-properties-warning.adoc[]

=== Configure Iceberg topics

Iceberg topics allow you to create a seamless integration with Apache Iceberg by writing records in Redpanda topics to object storage in Iceberg format.
Expand Down
4 changes: 4 additions & 0 deletions modules/reference/pages/properties/topic-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ The cleanup policy to apply for log segments of a topic.

When `cleanup.policy` is set, it overrides the cluster property xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic.

include::develop:partial$topic-properties-warning.adoc[]

**Default**: `[delete]`

**Values**:
Expand All @@ -179,6 +181,8 @@ When `cleanup.policy` is set, it overrides the cluster property xref:cluster-pro
- `[compact]` - Deletes data according to a key-based retention policy, discarding all but the latest value for each key.
- `[compact,delete]` - The latest values are kept for each key, while the remaining data is deleted according to retention limits.



**Related topics**:

- xref:manage:cluster-maintenance/disk-utilization.adoc#configure-segment-size[Configure segment size]
Expand Down