PriorityLevelConfiguration (v1alpha1)

PriorityLevelConfiguration (v1alpha1)

PriorityLevelConfiguration

flowcontrol.v1alpha1.PriorityLevelConfiguration

PriorityLevelConfiguration represents the configuration of a priority level.

PriorityLevelConfigurationSpec

flowcontrol.v1alpha1.PriorityLevelConfigurationSpec

PriorityLevelConfigurationSpec specifies the configuration of a priority level.

  • type (string)
    type indicates whether this priority level is subject to limitation on request execution. A value of "Exempt" means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of "Limited" means that (a) requests of this priority level are subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required.

  • limited (LimitedPriorityLevelConfiguration)
    limited specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if type is "Limited".

    • limited.assuredConcurrencyShares (integer)
      assuredConcurrencyShares (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) — the number of requests that may be executing at a time — for each such priority level:

              ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) )
      

      bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30.

    • limited.limitResponse (LimitResponse)
      limitResponse indicates what to do with requests that can not be executed right now

    • limited.limitResponse.queuing (QueuingConfiguration)
      queuing holds the configuration parameters for queuing. This field may be non-empty only if type is "Queue".

    • limited.limitResponse.queuing.handSize (integer)
      handSize is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. handSize must be no larger than queues, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.

    • limited.limitResponse.queuing.queueLengthLimit (integer)
      queueLengthLimit is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.

    • limited.limitResponse.queuing.queues (integer)
      queues is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.

    • limited.limitResponse.type (string)
      type is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.

PriorityLevelConfigurationStatus

flowcontrol.v1alpha1.PriorityLevelConfigurationStatus

PriorityLevelConfigurationStatus represents the current state of a "request-priority".

  • conditions ([]PriorityLevelConfigurationCondition)
    conditions is the current state of "request-priority".

    • conditions.lastTransitionTime (Time)
      lastTransitionTime is the last time the condition transitioned from one status to another.

    • conditions.message (string)
      message is a human-readable message indicating details about last transition.

    • conditions.reason (string)
      reason is a unique, one-word, CamelCase reason for the condition's last transition.

    • conditions.status (string)
      status is the status of the condition. Can be True, False, Unknown. Required.

    • conditions.type (string)
      type is the type of the condition. Required.

PriorityLevelConfigurationList

flowcontrol.v1alpha1.PriorityLevelConfigurationList

PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.