PriorityLevelConfiguration v1beta3

    apiVersion: flowcontrol.apiserver.k8s.io/v1beta3

    import "k8s.io/api/flowcontrol/v1beta3"

    PriorityLevelConfiguration represents the configuration of a priority level.

    PriorityLevelConfigurationSpec specifies the configuration of a priority level.

    • type (string), required

      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)

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

      *LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues:

      • How are requests for this priority level limited?

      • What should be done with requests that exceed the limit?*

      • limited.borrowingLimitPercent (int32)

        borrowingLimitPercent, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level’s BorrowingConcurrencyLimit (BorrowingCL) and is a limit on the total number of seats that this level may borrow at any one time. This field holds the ratio of that limit to the level’s nominal concurrency limit. When this field is non-nil, it must hold a non-negative integer and the limit is calculated as follows.

        BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 )

        The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left nil, the limit is effectively infinite.

      • limited.lendablePercent (int32)

        lendablePercent prescribes the fraction of the level’s NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level’s LendableConcurrencyLimit (LendableCL), is defined as follows.

        LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )

      • limited.limitResponse (LimitResponse)

        limitResponse indicates what to do with requests that can not be executed right now

        LimitResponse defines how to handle requests that can not be executed right now.

        • limited.limitResponse.type (string), required

          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.

        • limited.limitResponse.queuing (QueuingConfiguration)

          queuing holds the configuration parameters for queuing. This field may be non-empty only if type is "Queue".

          QueuingConfiguration holds the configuration parameters for queuing

          • limited.limitResponse.queuing.handSize (int32)

            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 (int32)

            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 (int32)

            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.nominalConcurrencyShares (int32)

        nominalConcurrencyShares (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats available at this priority level. This is used both for requests dispatched from this priority level as well as requests dispatched from other priority levels borrowing seats from this level. The server’s concurrency limit (ServerCL) is divided among the Limited priority levels in proportion to their NCS values:

        NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[limited priority level k] NCS(k)

        Bigger numbers mean a larger nominal concurrency limit, at the expense of every other Limited priority level. This field has a default value of 30.

    PriorityLevelConfigurationStatus represents the current state of a “request-priority”.

    • conditions ([]PriorityLevelConfigurationCondition)

      Patch strategy: merge on key type

      Map: unique values on key type will be kept during a merge

      is the current state of “request-priority”.

      PriorityLevelConfigurationCondition defines the condition of priority level.

      • conditions.lastTransitionTime (Time)

        lastTransitionTime is the last time the condition transitioned from one status to another.

        Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

      • 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 is a list of PriorityLevelConfiguration objects.

    • apiVersion: flowcontrol.apiserver.k8s.io/v1beta3

    • kind: PriorityLevelConfigurationList

    • metadata (ListMeta)

      metadata is the standard object’s metadata. More info:

    • items ([]PriorityLevelConfiguration), required

      items is a list of request-priorities.

    HTTP Request

    GET /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • pretty (in query): string

    Response

    200 (): OK

    get read status of the specified PriorityLevelConfiguration

    HTTP Request

    GET /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • pretty (in query): string

    Response

    200 (): OK

    401: Unauthorized

    list list or watch objects of kind PriorityLevelConfiguration

    HTTP Request

    GET /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations

    Parameters

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

      continue

    • fieldSelector (in query): string

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • timeoutSeconds (in query): integer

    • watch (in query): boolean

      watch

    Response

    200 (PriorityLevelConfigurationList): OK

    401: Unauthorized

    HTTP Request

    POST /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations

    Parameters

    Response

    200 (): OK

    201 (PriorityLevelConfiguration): Created

    202 (): Accepted

    401: Unauthorized

    update replace the specified PriorityLevelConfiguration

    HTTP Request

    PUT /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (PriorityLevelConfiguration): Created

    401: Unauthorized

    update replace status of the specified PriorityLevelConfiguration

    HTTP Request

    PUT /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • body: PriorityLevelConfiguration, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (PriorityLevelConfiguration): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (PriorityLevelConfiguration): OK

    201 (): Created

    401: Unauthorized

    patch partially update status of the specified PriorityLevelConfiguration

    HTTP Request

    PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (PriorityLevelConfiguration): OK

    201 (): Created

    401: Unauthorized

    delete delete a PriorityLevelConfiguration

    HTTP Request

    DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the PriorityLevelConfiguration

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    HTTP Request

    DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations

    Parameters

    • body: DeleteOptions

    • continue (in query): string

    • dryRun (in query): string

      dryRun

    • fieldSelector (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    • resourceVersion (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    Response

    200 (Status): OK

    401: Unauthorized