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

Update README to refer to --kafka-conf instead of --config #173

Merged
merged 1 commit into from
Sep 9, 2024
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
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
Loading