×

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

PriorityLevelConfigurationSpec specifies the configuration of a priority level.

status

object

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

.spec

Description

PriorityLevelConfigurationSpec specifies the configuration of a priority level.

Type

object

Required
  • type

Property Type Description

limited

object

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?

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.

.spec.limited

Description

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?

Type

object

Property Type Description

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.

limitResponse

object

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

.spec.limited.limitResponse

Description

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

Type

object

Required
  • type

Property Type Description

queuing

object

QueuingConfiguration holds the configuration parameters for queuing

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.

.spec.limited.limitResponse.queuing

Description

QueuingConfiguration holds the configuration parameters for queuing

Type

object

Property Type Description

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.

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.

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.

.status

Description

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

Type

object

Property Type Description

conditions

array

conditions is the current state of "request-priority".

conditions[]

object

PriorityLevelConfigurationCondition defines the condition of priority level.

.status.conditions

Description

conditions is the current state of "request-priority".

Type

array

.status.conditions[]

Description

PriorityLevelConfigurationCondition defines the condition of priority level.

Type

object

Property Type Description

lastTransitionTime

Time

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

message

string

message is a human-readable message indicating details about last transition.

reason

string

reason is a unique, one-word, CamelCase reason for the condition’s last transition.

status

string

status is the status of the condition. Can be True, False, Unknown. Required.

type

string

type is the type of the condition. Required.

API endpoints

The following API endpoints are available:

  • /apis/flowcontrol.apiserver.k8s.io/v1beta2/prioritylevelconfigurations

    • DELETE: delete collection of PriorityLevelConfiguration

    • GET: list or watch objects of kind PriorityLevelConfiguration

    • POST: create a PriorityLevelConfiguration

  • /apis/flowcontrol.apiserver.k8s.io/v1beta2/watch/prioritylevelconfigurations

    • GET: watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/flowcontrol.apiserver.k8s.io/v1beta2/prioritylevelconfigurations/{name}

    • DELETE: delete a PriorityLevelConfiguration

    • GET: read the specified PriorityLevelConfiguration

    • PATCH: partially update the specified PriorityLevelConfiguration

    • PUT: replace the specified PriorityLevelConfiguration

  • /apis/flowcontrol.apiserver.k8s.io/v1beta2/watch/prioritylevelconfigurations/{name}

    • GET: watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

  • /apis/flowcontrol.apiserver.k8s.io/v1beta2/prioritylevelconfigurations/{name}/status

    • GET: read status of the specified PriorityLevelConfiguration

    • PATCH: partially update status of the specified PriorityLevelConfiguration

    • PUT: replace status of the specified PriorityLevelConfiguration

/apis/flowcontrol.apiserver.k8s.io/v1beta2/prioritylevelconfigurations

Table 1. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of PriorityLevelConfiguration

Table 2. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

dryRun

string

When present, indicates that modifications should not be