1 of 4

Manage Kafka

ACLs

This page describes to commands to manage Kafka ACLs in Lenses via the CLI.

View all ACLs

lenses-cli acls

Update ACLs

lenses-cli acl set \
    --resource-type="Topic" \
    --resource-name="transactions" \
    --principal="principalType:principalName" \
    --permission-type="Allow" \
    --acl-host="*" \
    --operation="Read" \
    --pattern-type="literal"

ACLs can also be created from a file:

lenses-cli acl create ./file.yaml

Example file:

resourceType: Topic
resourceName: transactions
principal: principalType:principalName
permissionType: Allow
host: "*"
operation: Read
patternType: literal

Delete ACLs

lenses-cli acl delete \
    --resource-type="Topic" \
    --resource-name="transactions" \
    --principal="principalType:principalName" \
    --permission-type="Allow" \
    --acl-host="*" \
    --operation="Read" \
    --pattern-type="literal"

ACLs can also be deleted from a file:

lenses-cli acl delete ./file.yaml

Consumers

This page describes the commands for managing Kafka consumers in Lenses via the CLI.

Commands for updating consumer groups offsets.

Flags --group and --topic are mandatory and specify the consumer group ID and topic name respectively.

To affect all topics use the —all-topics flag.

Flag

Description

update-single-partition accepts only one --topic flag while update-multiple-partitions may accept multiple.

Update a single topic’s partition offset to the specified value

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-offset <offset_id>

Update to the earliest offset available

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-earliest

Update to the latest offset available

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-latest

Update given topics for all their partition offsets to the specified date time

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-datetime <datetime>

Reset given topics for all their partition offsets to the earliest offset possible

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-earliest

Reset given topics for all their partition offsets to the latest offset possible

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-latest

Reset offsets for all topics of this consumer group

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --all-topics \
    --to-latest

Quotas

This page describes the commands for mamaging Kafka quotas in Lenses via the CLI.

View quotas

lenses-cli quotas [--output json/table/yaml]

Create and update quotas for users

lenses-cli quota users set [--quota-user="user"] [--quota-client=""] \
    --quota-config="{\"producer_byte_rate\": \"100000\",\"consumer_byte_rate\": \"200000\",\"request_percentage\": \"75\"}"

From a file.

lenses-cli quota users set ./quota.yaml

File example:

user: user
clientID: "*"
config:
  ProducerByteRate: "100000"
  ConsumerByteRate: "200000"
  RequestPercentage: "75"

Create and update quotas for clients

lenses-cli quota clients set [--quota-client=""] \
    --quota-config="{\"producer_byte_rate\": \"100000\",\"consumer_byte_rate\": \"200000\",\"request_percentage\": \"75\""

From a file.

lenses-cli quota clients set ./quota-clients.yaml

Example file.

clientID: "*"
config:
  ProducerByteRate: "100000"
  ConsumerByteRate: "200000"
  RequestPercentage: "75"

Remove user quota config’s specific properties

lenses-cli quota users delete [--quota-client=""] [--quota-user=""] \
    producer_byte_rate consumer_byte_rate request_percentage

Delete the default user quota

lenses-cli quota users delete

Delete for a specific user quota

lenses-cli quota users delete \
    --quota-user="user"

Delete for a specific user and client

lenses-cli quota users delete \
    --quota-user="user" \
    --quota-client="clientID"

lenses-cli quota users delete \
    --quota-user="user" \
    request_percentage

Remove client quota config’s specific properties

If empty then all properties will be passed on automatically and the client quota will be removed entirely.

lenses-cli quota clients delete [--quota-client=""] \
    producer_byte_rate consumer_byte_rate request_percentage

Delete the default client quota

lenses-cli quota clients delete

Delete for a specific client quota

lenses-cli quota clients delete \
    --quota-client="clientID"

Delete for a specific client quota’s property

lenses-cli quota clients delete \
    --quota-client="clientID" \
    request_percentage

Quotas

This page describes the commands for mamaging Kafka quotas in Lenses via the CLI.

View quotas

lenses-cli quotas [--output json/table/yaml]

Create and update quotas for users

lenses-cli quota users set [--quota-user="user"] [--quota-client=""] \
    --quota-config="{\"producer_byte_rate\": \"100000\",\"consumer_byte_rate\": \"200000\",\"request_percentage\": \"75\"}"

From a file.

lenses-cli quota users set ./quota.yaml

File example:

user: user
clientID: "*"
config:
  ProducerByteRate: "100000"
  ConsumerByteRate: "200000"
  RequestPercentage: "75"

Create and update quotas for clients

lenses-cli quota clients set [--quota-client=""] \
    --quota-config="{\"producer_byte_rate\": \"100000\",\"consumer_byte_rate\": \"200000\",\"request_percentage\": \"75\""

From a file.

lenses-cli quota clients set ./quota-clients.yaml

Example file.

clientID: "*"
config:
  ProducerByteRate: "100000"
  ConsumerByteRate: "200000"
  RequestPercentage: "75"

Remove user quota config’s specific properties

lenses-cli quota users delete [--quota-client=""] [--quota-user=""] \
    producer_byte_rate consumer_byte_rate request_percentage

Delete the default user quota

lenses-cli quota users delete

Delete for a specific user quota

lenses-cli quota users delete \
    --quota-user="user"

Delete for a specific user and client

lenses-cli quota users delete \
    --quota-user="user" \
    --quota-client="clientID"

lenses-cli quota users delete \
    --quota-user="user" \
    request_percentage

Remove client quota config’s specific properties

If empty then all properties will be passed on automatically and the client quota will be removed entirely.

lenses-cli quota clients delete [--quota-client=""] \
    producer_byte_rate consumer_byte_rate request_percentage

Delete the default client quota

lenses-cli quota clients delete

Delete for a specific client quota

lenses-cli quota clients delete \
    --quota-client="clientID"

Delete for a specific client quota’s property

lenses-cli quota clients delete \
    --quota-client="clientID" \
    request_percentage

Consumers

This page describes the commands for managing Kafka consumers in Lenses via the CLI.

Commands for updating consumer groups offsets.

Flags --group and --topic are mandatory and specify the consumer group ID and topic name respectively.

To affect all topics use the —all-topics flag.

Flag

Description

update-single-partition accepts only one --topic flag while update-multiple-partitions may accept multiple.

Update a single topic’s partition offset to the specified value

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-offset <offset_id>

Update to the earliest offset available

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-earliest

Update to the latest offset available

lenses-cli consumers \
    offsets \
    update-single-partition \
    --group <group_name> \
    --topic <topic_name> \
    --partition <partition_id> \
    --to-latest

Update given topics for all their partition offsets to the specified date time

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-datetime <datetime>

Reset given topics for all their partition offsets to the earliest offset possible

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-earliest

Reset given topics for all their partition offsets to the latest offset possible

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --topic <topic_name> \
    --to-latest

Reset offsets for all topics of this consumer group

lenses-cli consumers \
    offsets \
    update-multiple-partitions \
    --group <group_name> \
    --all-topics \
    --to-latest