Apache Kafka

Learn about actions >

• get-admin-credentials

  Get administrator authentication credentials for client commands The returned client_properties can be used for Kafka bin commands using --bootstrap-server and --command-config for admin level administration This action must be called on the leader unit.

• get-listeners

  Get all active listeners and their port allocations

• pre-upgrade-check

  Run necessary pre-upgrade checks before executing a charm upgrade.

• rebalance

  Trigger a rebalance of cluster partitions based on configured goals

  Params

  • brokerid integer

    Broker ID newly added to the cluster or to be removed. The broker ID is the unit number, e.g. kafka/0 is broker 0.

  • dryrun boolean

    Only generate the partition rebalance proposals and estimated result, without executing

  • mode string

    The operation to issue to the balancer. This action must be called on the leader unit. 'full' - runs a full rebalance of all partitions across the whole cluster 'add' - evenly distributes replicas to new and available brokers 'remove' - moves under-replicated partition replicas assigned to decommissioned brokers, to available ones

  Required

  mode

• set-password

  Change an internal system user's password. It is for internal charm users and SHOULD NOT be used by applications. This action must be called on the leader unit.

  Params

  • password string

    The password will be auto-generated if this option is not specified.

  • username string

    The internal username to set password for.

  Required

  username

• set-tls-private-key

  Sets the private key identifying the target unit, which will be used for certificate signing requests (CSR). When updated, certificates will be reissued to the unit. Run for each unit separately. Requires a valid relation to an application providing the certificates relation interface.

  Params

  • internal-key string

    The content of private key for internal communications with clients. Content will be auto-generated if this option is not specified. Can be raw-string, or base64 encoded.