Skip to content

Commit

Permalink
Update README to refer to --kafka-conf instead of --config (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmancill authored Sep 9, 2024
1 parent 26a7052 commit b9d46dc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@ each argument can do.
-b, --brokers <BOOTSTRAP_BROKERS>
Initial Kafka Brokers to connect to (format: 'HOST:PORT,...').
Equivalent to '--config=bootstrap.servers:host:port,...'.
Equivalent to '--kafka-conf bootstrap.servers:host:port,...'.
--client-id <CLIENT_ID>
Client identifier used by the internal Kafka (Admin) Client.
Equivalent to '--config=client.id:my-client-id'.
Equivalent to '--kafka-conf client.id:my-client-id'.
[default: kommitted]
Expand Down Expand Up @@ -192,16 +192,16 @@ each argument can do.
```shell
$ kommitted \
--brokers {{ BOOTSTRAP_BROKERS or BROKER_ENDPOINT }} \
--config security.protocol:SASL_SSL \
--config sasl.mechanisms=PLAIN \
--config sasl.username:{{ USERNAME or API_KEY }} \
--config sasl.password:{{ PASSWORD or API_SECRET }} \
--kafka-conf security.protocol:SASL_SSL \
--kafka-conf sasl.mechanisms=PLAIN \
--kafka-conf sasl.username:{{ USERNAME or API_KEY }} \
--kafka-conf sasl.password:{{ PASSWORD or API_SECRET }} \
...
```
### Log verbosity
Kommitted follows the long tradition of `-v/-q` to control the verbosity of it's logging:
Kommitted follows the long tradition of `-v/-q` to control the verbosity of its logging:
| Arguments | Log verbosity level | Default |
|----------:|:--------------------|:-------:|
Expand Down
4 changes: 2 additions & 2 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ pub struct Cli {
// ------------------------------------------------------------------ Admin Client configuration
/// Initial Kafka Brokers to connect to (format: 'HOST:PORT,...').
///
/// Equivalent to '--config=bootstrap.servers:host:port,...'.
/// Equivalent to '--kafka-conf bootstrap.servers:host:port,...'.
#[arg(short, long = "brokers", value_name = "BOOTSTRAP_BROKERS")]
pub bootstrap_brokers: String,

/// Client identifier used by the internal Kafka (Admin) Client.
///
/// Equivalent to '--config=client.id:my-client-id'.
/// Equivalent to '--kafka-conf client.id:my-client-id'.
#[arg(long = "client-id", value_name = "CLIENT_ID", default_value = env!("CARGO_PKG_NAME"))]
pub client_id: String,

Expand Down

0 comments on commit b9d46dc

Please sign in to comment.