Skip to content

Commit

Permalink
document plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
d-rk committed Mar 15, 2024
1 parent d7f78e0 commit 6974c19
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,15 @@ contexts:
enabled: true
username: admin
password: admin
# optional configure sasl mechanism as plaintext, scram-sha256, scram-sha512 (defaults to plaintext)
mechanism: scram-sha512
# optional configure sasl mechanism as plaintext, scram-sha256, scram-sha512, oauth (defaults to plaintext)
mechanism: oauth
# optional tokenProvider configuration (only used for 'sasl.mechanism=oauth')
tokenprovider:
# plugin to use as token provider implementation (see plugin section)
plugin: azure
# optional: additional options passed to the plugin
options:
key: value
# optional: access clusters running kubernetes
kubernetes:
Expand Down Expand Up @@ -185,6 +192,7 @@ The config file location is resolved by
. as default the config file is looked up from one of the following locations:
** `$HOME/.config/kafkactl/config.yml`
** `$HOME/.kafkactl/config.yml`
** `$APPDATA/kafkactl/config.yml`
** `$SNAP_REAL_HOME/.kafkactl/config.yml`
** `$SNAP_DATA/kafkactl/config.yml`
** `/etc/kafkactl/config.yml`
Expand Down Expand Up @@ -359,6 +367,19 @@ If environment variables for the `default` context should be set, the prefix `CO
So, instead of `CONTEXTS_DEFAULT_TLS_CERTKEY` one can also set `TLS_CERTKEY`.
See *root_test.go* for more examples.

== Plugins

_kafkactl_ supports plugins to cope with specifics when using Kafka-compatible clusters available from cloud providers such as Azure or AWS.

At the moment, plugins can only be used to implement a `tokenProvider` for _oauth_ authentication.
In the future, plugins might implement additional commands to query data or configuration which is not part of the Kafka-API. One example would be Eventhub consumer groups/offsets for Azure.

See the plugin documentation for additional documentation and usage examples.

Available plugins:

* https://github.com/deviceinsight/kafkactl-plugins/blob/main/azure/README.adoc[azure plugin]

== Examples

=== Consuming messages
Expand Down

0 comments on commit 6974c19

Please sign in to comment.