Usage
Topics
Prerequisites
- You have setup the correct access control permissions in Kpow to allow
TOPIC_CREATE
,TOPIC_EDIT
andTOPIC_TRUNCATE
- You have setup the correct ACLs if you have enabled ACLs in your Kafka Cluster
Topic Create
Topic create can be found in the navigation menu under the Topic menu item.
By default, the form will use the cluster's default replication factor and number of partitions. You can specify your own values for both.
Configuration
You can add configuration options to your topic by using the Add configuration dropdown and selecting the custom configuration you would like to add to your topic.
Clicking the Show description link will open up the documentation accordion for the configuration item.
The contents of the description include the configuration item's documentation, its type, default and common values. Common values are the top-5 most common values set on your cluster. Clicking on one of these values will pre-fill the configuration form for the item.
Copy configuration
Within the UI you can also copy the configuration of other topics within a cluster. For example if you select . into the form.
kafka-topics.sh export
If you do not wish to grant Kpow the ability to mutate your cluster's topics, you can still use the Topic Create form to build out your request. On the right-hand side of the form is the Kafka Script equivalent, which can be piped into kafka-topics.sh
. This will reactively update as you fill out the form.
Topic Edit
To edit topic configuration, navigate to Configuration within the Topic menu item of Kpow's main navigation menu.
Filtering
You can use the Topic Configuration filters on the top-most menu to filter down the configuration table.
The top-level filters allow you to filter by topic or config item. If you click the slider icon (advanced filters), you can filter config by source, importance and whether the config item is read only.
Topic actions
Topic actions are visible by hovering over the actions icon, the last column of a row in the topic configuration UI. Available actions include viewing documentation and editing config
Editing config
Clicking the Edit Config item inside a topic config item's action menu will bring up the edit config modal. This modal looks similar to the Topic Create UI, and will allow you to edit the config item.
Topic Truncation
Topic truncation allows you to delete records from a topic partition. Topic truncation will remove all records before the specififed offset.
Topic truncation works on all Kafka topics except for compacted topics (where cleanup.policy=compact
).
For deletion of individual records, see tombstoning.
Usage
Navigate to Kpow's "Topic Details" page and select the topic (or topic partition) from the topics table. From there, click on the actions button and select "Truncate topic".
If you have selected a topic, the topic truncation slide will pop up with all topic partitions pre-selected with their last-observed end offset as the value for each partition. You can use Kpow's user interface to add or remove partitions from the topic truncate request.
Kpow also allows you to truncate by group offset. This will truncate all records a consumer group has already consumed (based on their last commit offset to the topic).