You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Status

Current state: Draft

Discussion thread: TBD


JIRA: TBD

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Currently the DescribeACLs and DescribeClientQuotas APIs only allow to retrieve ACLs/quotas for a single user at a time. Tooling managing users often have to update several users at a time, this requires making multiple calls to the Admin API which result in multiple requests to the cluster. Being able to retrieve data from multiple users at a time would simplify client code and reduce the amount of requests necessary to make ACL and quota changes.

Public Interfaces

1) Update DescribeACLs Request/Response

With version 4, we are adding the Filters field to DescribeAclsRequest.

{
  "apiKey": 29,
  "type": "request",
  "listeners": ["zkBroker", "broker", "controller"],
  "name": "DescribeAclsRequest",
  // Version 1 adds resource pattern type.
  // Version 2 enables flexible versions.
  // Version 3 adds user resource type.
  // Version 4 adds support for batching
  "validVersions": "0-4",
  "flexibleVersions": "2+",
  "fields": [
    ...
    <existing fields>
    ...
    { "name": "Filters",
      "type": "[]DescribeAclsFilter",
      "versions": "4+",
      "about": "The filters to use when describing ACLs.",
      "fields": [
        { "name": "ResourceTypeFilter", "type": "int8", "versions": "4+",
          "about": "The resource type." },
        { "name": "ResourceNameFilter", "type": "string", "versions": "4+", "nullableVersions": "4+",
          "about": "The resource name." },
        { "name": "PatternTypeFilter", "type": "int8", "versions": "4+", "default": "3", "ignorable": false,
          "about": "The pattern type." },
        { "name": "PrincipalFilter", "type": "string", "versions": "4+", "nullableVersions": "4+",
          "about": "The principal filter, or null to accept all principals." },
        { "name": "HostFilter", "type": "string", "versions": "4+", "nullableVersions": "4+",
          "about": "The host filter, or null to accept all hosts." },
        { "name": "Operation", "type": "int8", "versions": "4+",
          "about": "The ACL operation." },
        { "name": "PermissionType", "type": "int8", "versions": "4+",
          "about": "The permission type." }
      ]
    }
  ]
}

With version 4, we are adding the FilterResults field to DescribeAclsResponse. We also have to rename the type of the existing Resources and Acls fields to avoid them conflicting with the new fields.

{
  "apiKey": 29,
  "type": "response",
  "name": "DescribeAclsResponse",
  // Version 1 adds PatternType.
  // Starting in version 1, on quota violation, brokers send out responses before throttling.
  // Version 2 enables flexible versions.
  // Version 3 adds user resource type.
  // Version 4 adds support for batching.
  "validVersions": "0-4",
  "flexibleVersions": "2+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "ErrorCode", "type": "int16", "versions": "0-3",
      "about": "The error code, or 0 if there was no error." },
    { "name": "ErrorMessage", "type": "string", "versions": "0-3", "nullableVersions": "0-3",
      "about": "The error message, or null if there was no error." },
    { "name": "Resources", "type": "[]OldDescribeAclsResource", "versions": "0-3",
      "about": "Each Resource that is referenced in an ACL.", "fields": [
      { "name": "ResourceType", "type": "int8", "versions": "0-3",
        "about": "The resource type." },
      { "name": "ResourceName", "type": "string", "versions": "0-3",
        "about": "The resource name." },
      { "name": "PatternType", "type": "int8", "versions": "1-3", "default": "3", "ignorable": false,
        "about": "The resource pattern type." },
      { "name": "Acls", "type": "[]OldAclDescription", "versions": "0-3",
        "about": "The ACLs.", "fields": [
        { "name": "Principal", "type": "string", "versions": "0-3",
          "about": "The ACL principal." },
        { "name": "Host", "type": "string", "versions": "0-3",
          "about": "The ACL host." },
        { "name": "Operation", "type": "int8", "versions": "0-3",
          "about": "The ACL operation." },
        { "name": "PermissionType", "type": "int8", "versions": "0-3",
          "about": "The ACL permission type." }
      ]}
    ]},
    {
      "name": "FilterResults",
      "type": "[]DescribeAclsFilterResult",
      "versions": "4+",
      "about": "The results for each filter.",
      "fields": [
        { "name": "ErrorCode", "type": "int16", "versions": "4+",
          "about": "The error code, or 0 if there was no error." },
        { "name": "ErrorMessage", "type": "string", "versions": "4+", "nullableVersions": "4+",
          "about": "The error message, or null if there was no error." },
        { "name": "Resources", "type": "[]DescribeAclsResource", "versions": "4+",
          "about": "Each Resource that is referenced in an ACL.", "fields": [
          { "name": "ResourceType", "type": "int8", "versions": "4+",
            "about": "The resource type." },
          { "name": "ResourceName", "type": "string", "versions": "4+",
            "about": "The resource name." },
          { "name": "PatternType", "type": "int8", "versions": "4+", "default": "3", "ignorable": false,
            "about": "The resource pattern type." },
          { "name": "Acls", "type": "[]AclDescription", "versions": "4+",
            "about": "The ACLs.", "fields": [
            { "name": "Principal", "type": "string", "versions": "4+",
              "about": "The ACL principal." },
            { "name": "Host", "type": "string", "versions": "4+",
              "about": "The ACL host." },
            { "name": "Operation", "type": "int8", "versions": "4+",
              "about": "The ACL operation." },
            { "name": "PermissionType", "type": "int8", "versions": "4+",
              "about": "The ACL permission type." }
          ]}
        ]}
      ]
    }
  ]
}

2) Update DescribeClientQuotas Request/Response
With version 2 we are adding the Filters field to DescribeClientQuotasRequest. We also have to rename the type of the existing Components fields to avoid them conflicting with the new fields.

{
  "apiKey": 48,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "DescribeClientQuotasRequest",
  // Version 1 enables flexible versions.
  // Version 2 adds support for batching.
  "validVersions": "0-2",
  "flexibleVersions": "1+",
  "fields": [
    { "name": "Components", "type": "[]OldComponentData", "versions": "0-1",
      "about": "Filter components to apply to quota entities.", "fields": [
      { "name": "EntityType", "type": "string", "versions": "0-1",
        "about": "The entity type that the filter component applies to." },
      { "name": "MatchType", "type": "int8", "versions": "0-1",
        "about": "How to match the entity {0 = exact name, 1 = default name, 2 = any specified name}." },
      { "name": "Match", "type": "string", "versions": "0-1", "nullableVersions": "0-1",
        "about": "The string to match against, or null if unused for the match type." }
    ]},
    { "name": "Strict", "type": "bool", "versions": "0+",
      "about": "Whether the match is strict, i.e. should exclude entities with unspecified entity types." },
    {
      "name": "Filters",
      "type": "[]DescribeClientQuotasFilter",
      "versions": "2+",
      "about": "The filters to use when describing client quotas.",
      "fields": [
        { "name": "Components", "type": "[]ComponentData", "versions": "2+",
          "about": "Filter components to apply to quota entities.", "fields": [
          { "name": "EntityType", "type": "string", "versions": "2+",
            "about": "The entity type that the filter component applies to." },
          { "name": "MatchType", "type": "int8", "versions": "2+",
            "about": "How to match the entity {0 = exact name, 1 = default name, 2 = any specified name}." },
          { "name": "Match", "type": "string", "versions": "2+", "nullableVersions": "2+",
            "about": "The string to match against, or null if unused for the match type." }
        ]}
      ]
    }
  ]
}

With version 2 we are adding the Filters field to DescribeClientQuotasResponse. We also have to rename the type of the existing Entries, Entities and Values fields to avoid them conflicting with the new fields.

{
  "apiKey": 48,
  "type": "response",
  "name": "DescribeClientQuotasResponse",
  // Version 1 enables flexible versions.
  // Version 2 adds support for batching.
  "validVersions": "0-2",
  "flexibleVersions": "1+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "ErrorCode", "type": "int16", "versions": "0-1",
      "about": "The error code, or `0` if the quota description succeeded." },
    { "name": "ErrorMessage", "type": "string", "versions": "0-1", "nullableVersions": "0-1",
      "about": "The error message, or `null` if the quota description succeeded." },
    { "name": "Entries", "type": "[]OldEntryData", "versions": "0-1", "nullableVersions": "0-1",
      "about": "A result entry.", "fields": [
      { "name": "Entity", "type": "[]OldEntityData", "versions": "0-1",
        "about": "The quota entity description.", "fields": [
        { "name": "EntityType", "type": "string", "versions": "0-1",
          "about": "The entity type." },
        { "name": "EntityName", "type": "string", "versions": "0-1", "nullableVersions": "0-1",
          "about": "The entity name, or null if the default." }
      ]},
      { "name": "Values", "type": "[]OldValueData", "versions": "0-1",
	"about": "The quota values for the entity.", "fields": [
        { "name": "Key", "type": "string", "versions": "0-1",
          "about": "The quota configuration key." },
        { "name": "Value", "type": "float64", "versions": "0-1",
          "about": "The quota configuration value." }
      ]}
    ]},
    {
      "name": "FilterResults",
      "type": "[]DescribeClientQuotasFilterResult",
      "versions": "2+",
      "about": "The results for each filter.",
      "fields": [
        { "name": "ErrorCode", "type": "int16", "versions": "2+",
          "about": "The error code, or `0` if the quota description succeeded." },
        { "name": "ErrorMessage", "type": "string", "versions": "2+", "nullableVersions": "2+",
          "about": "The error message, or `null` if the quota description succeeded." },
        { "name": "Entries", "type": "[]EntryData", "versions": "2+", "nullableVersions": "2+",
          "about": "A result entry.", "fields": [
          { "name": "Entity", "type": "[]EntityData", "versions": "2+",
            "about": "The quota entity description.", "fields": [
            { "name": "EntityType", "type": "string", "versions": "2+",
              "about": "The entity type." },
            { "name": "EntityName", "type": "string", "versions": "2+", "nullableVersions": "2+",
              "about": "The entity name, or null if the default." }
          ]},
          { "name": "Values", "type": "[]ValueData", "versions": "2+",
            "about": "The quota values for the entity.", "fields": [
            { "name": "Key", "type": "string", "versions": "2+",
              "about": "The quota configuration key." },
            { "name": "Value", "type": "float64", "versions": "2+",
              "about": "The quota configuration value." }
          ]}
        ]}
      ]
    }
  ]
}


3) New Admin APIs
Four new methods will be added to the Admin interface:

    /**
     * This is a convenience method for {@link #describeAcls(Collection<AclBindingFilter>, DescribeAclsOptions)} with
     * default options. See the overload for more details.
     * <p>
     *
     * This operation is supported by brokers with version 3.5 or higher.      
     * @param filters The filter to use.
     * @return The DescribeAclsResult.
     */
    default DescribeAclsResult describeAcls(Collection<AclBindingFilter> filters) {
        return describeAcls(filters, new DescribeAclsOptions());
    }

    /**
     * Lists access control lists (ACLs) according to the supplied filters.
     * <p>
     * Note: it may take some time for changes made by {@code createAcls} or {@code deleteAcls} to be reflected
     * in the output of {@code describeAcls}.
     * <p>
     *
     * This operation is supported by brokers with version 3.5 or higher.         
     * @param filters  The filters to use.
     * @param options The options to use when listing the ACLs.
     * @return The DescribeAclsResult.
     */
    DescribeAclsResult describeAcls(Collection<AclBindingFilter> filters, DescribeAclsOptions options);

    /**
     * Describes all entities matching the provided filters that have at least one client quota configuration
     * value defined.
     * <p>
     * This is a convenience method for {@link #describeClientQuotas(Collection<ClientQuotaFilter>, DescribeClientQuotasOptions)}
     * with default options. See the overload for more details.
     * <p>
     * This operation is supported by brokers with version 3.5 or higher.
     *
     * @param filters the filters to apply to match entities
     * @return the DescribeClientQuotasResult containing the result
     */
    default DescribeClientQuotasResult describeClientQuotas(Collection<ClientQuotaFilter> filters) {
        return describeClientQuotas(filters, new DescribeClientQuotasOptions());
    }

    /**
     * Describes all entities matching the provided filters that have at least one client quota configuration
     * value defined.
     * <p>
     * The following exceptions can be anticipated when calling {@code get()} on the future from the
     * returned {@link DescribeClientQuotasResult}:
     * <ul>
     *   <li>{@link org.apache.kafka.common.errors.ClusterAuthorizationException}
     *   If the authenticated user didn't have describe access to the cluster.</li>
     *   <li>{@link org.apache.kafka.common.errors.InvalidRequestException}
     *   If the request details are invalid. e.g., an invalid entity type was specified.</li>
     *   <li>{@link org.apache.kafka.common.errors.TimeoutException}
     *   If the request timed out before the describe could finish.</li>
     * </ul>
     * <p>
     * This operation is supported by brokers with version 3.5 or higher.
     *
     * @param filters the filters to apply to match entities
     * @param options the options to use
     * @return the DescribeClientQuotasResult containing the result
     */
    DescribeClientQuotasResult describeClientQuotas(Collection<ClientQuotaFilter> filters, DescribeClientQuotasOptions options);

Proposed Changes

Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.

Compatibility, Deprecation, and Migration Plan

  • What impact (if any) will there be on existing users?
  • If we are changing behavior how will we phase out the older behavior?
  • If we need special migration tools, describe them here.
  • When will we remove the existing behavior?

Test Plan


Rejected Alternatives

If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.

  • No labels