Module: Karafka::Admin::Configs
- Defined in:
- lib/karafka/admin/configs.rb,
lib/karafka/admin/configs/config.rb,
lib/karafka/admin/configs/resource.rb
Overview
Namespace for admin operations related to configuration management
At the moment Karafka supports configuration management for brokers and topics
You can describe configuration as well as alter it.
Altering is done in the incremental way.
Defined Under Namespace
Class Method Summary collapse
-
.alter(*resources) ⇒ Object
Alters given resources based on the alteration operations accumulated in the provided resources.
-
.describe(*resources) ⇒ Array<Resource>
Fetches given resources configurations from Kafka.
Class Method Details
.alter(*resources) ⇒ Object
This operation is not transactional and can work only partially if some config options are not valid. Always make sure, your alterations are correct.
We call it #alter
despite using the Kafka incremental alter API because the regular alter is deprecated.
Alters given resources based on the alteration operations accumulated in the provided resources
58 59 60 61 62 63 |
# File 'lib/karafka/admin/configs.rb', line 58 def alter(*resources) operate_on_resources( :incremental_alter_configs, resources ) end |
.describe(*resources) ⇒ Array<Resource>
Even if you request one resource, result will always be an array with resources
Fetches given resources configurations from Kafka
35 36 37 38 39 40 |
# File 'lib/karafka/admin/configs.rb', line 35 def describe(*resources) operate_on_resources( :describe_configs, resources ) end |