Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: A few more updates

...

Code Block
languagejs
titleListConfigs Response
ListConfigs Response (Version: 0) => [entities]   
  entities => entity_type entity_name error_code [configs]
    entity_type => INT8
    entity_name => STRING
    error_code => INT16
    configs =>
      config_name => STRING
      config_value => STRING
      read_only => BOOLEAN
      is_default => BOOLEAN
      is_sensitive => BOOLEAN

For each config, If is_sensitive is true, config_value will always be null to ensure that we don't leak sensitive information like passwords.

Alter Configs

Code Block
languagejs
titleAlterConfigs Request
AlterConfigs Request (Version: 0) => [entities] validate_only
  validate_only => BOOLEAN
  entities => entity_type entity_name error_code [configs]
    entity_type => INT8
    entity_name => STRING
    error_code => INT16
    configs =>
      config_keyname => STRING
      config_value => STRING

Request Semantics

  1. Can be sent to any broker
  2. If there are multiple instructions for the same entity in one request, an InvalidRequestException will be logged on the broker and a single error code for that topic will be returned to the client
    • This is because the list of entities is modeled server side as a map with entity as the key
  3. Entity types are "Topic", "Client", and "Broker".
  4. Below are the authorization requirements for each type:
    1. The principal must be authorized to the "Create" Operation on the "Cluster" resource to create topics. 
    • Unauthorized requests will receive a ClusterAuthorizationException
  5. If an Alter operation is attempted on a read-only config, an UnsupportedOperation error will be returned for the relevant entity.
  6. The request is not transactional. 
    1. If an error occurs for an entity, others could still be updated.
    2. Errors are reported independently per entity.
    TODO
Code Block
languagejs
titleAlterConfigs Response
AlterConfigs Response (Version: 0) => [responses]   
  responses => entity_type entity_name error_code error_message
    entity_type => INT8
    entity_name => STRING
    error_code => INT16
    error_message => STRING


Proposed Changes

TBD

Compatibility, Deprecation, and Migration Plan

...