PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]

Description

PriorityLevelConfiguration represents the configuration of a priority level.

Type

`object`

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
exempt	object	ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the spec.
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.exempt

Description

ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the spec.

Type

`object`

Property	Type	Description
lendablePercent	integer	lendablePercent prescribes the fraction of the level’s NominalCL that can be borrowed by other priority levels. This 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 )
nominalConcurrencyShares	integer	nominalConcurrencyShares (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority level. This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism. The server’s concurrency limit (ServerCL) is divided among all the priority levels in proportion to their NCS values: NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero.

.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
borrowingLimitPercent	integer	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.
lendablePercent	integer	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 )
limitResponse	object	LimitResponse defines how to handle requests that can not be executed right now.
nominalConcurrencyShares	integer	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[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. If not specified, this field defaults to a value of 30. Setting this field to zero supports the construction of a "jail" for this priority level that is used to hold some request(s)

.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/v1/prioritylevelconfigurations
  • DELETE: delete collection of PriorityLevelConfiguration
  • GET: list or watch objects of kind PriorityLevelConfiguration
  • POST: create a PriorityLevelConfiguration
• /apis/flowcontrol.apiserver.k8s.io/v1/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/v1/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/v1/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/v1/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/v1/prioritylevelconfigurations

HTTP method

`DELETE`

Description

delete collection of PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list or watch objects of kind PriorityLevelConfiguration

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfigurationList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	PriorityLevelConfiguration schema

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
201 - Created	PriorityLevelConfiguration schema
202 - Accepted	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

/apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations

HTTP method

`GET`

Description

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

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

/apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the PriorityLevelConfiguration

HTTP method

`DELETE`

Description

delete a PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified PriorityLevelConfiguration

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
201 - Created	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	PriorityLevelConfiguration schema

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
201 - Created	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the PriorityLevelConfiguration

HTTP method

`GET`

Description

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.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the PriorityLevelConfiguration

HTTP method

`GET`

Description

read status of the specified PriorityLevelConfiguration

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
201 - Created	PriorityLevelConfiguration schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified PriorityLevelConfiguration

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	PriorityLevelConfiguration schema

HTTP responses

HTTP code	Reponse body
200 - OK	PriorityLevelConfiguration schema
201 - Created	PriorityLevelConfiguration schema
401 - Unauthorized	Empty