This is a cache of https://docs.okd.io/4.6/rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1alpha1.html. It is a snapshot of the page at 2024-11-29T03:22:52.779+0000.
PriorityLevelConfiguration [flowcontrol.<strong>api</strong>server.k8s.io/v1alpha1] - Schedule and quota <strong>api</strong>s | <strong>api</strong> reference | OKD 4.6
  1. Documentation
×

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

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 meta/v1

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 meta/v1

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/v1alpha1/prioritylevelconfigurations

    • DELETE: delete collection of PriorityLevelConfiguration

    • GET: list or watch objects of kind PriorityLevelConfiguration

    • POST: create a PriorityLevelConfiguration

  • /apis/flowcontrol.apiserver.k8s.io/v1alpha1/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/v1alpha1/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/v1alpha1/prioritylevelconfigurations

Table 1. Global guery 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 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

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Table 3. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind PriorityLevelConfiguration

Table 5. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

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.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfigurationList flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty
HTTP method

POST

Description

create a PriorityLevelConfiguration

Table 7. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 8. Body parameters
Parameter Type Description

body

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1
Table 9. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

201 - Created

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

202 - Accepted

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty

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

Table 10. Global path parameters
Parameter Type Description

name

string

name of the PriorityLevelConfiguration
Table 11. Global guery parameters
Parameter Type Description

pretty

string

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

DELETE

Description

delete a PriorityLevelConfiguration

Table 12. 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

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 13. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

202 - Accepted

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified PriorityLevelConfiguration

Table 15. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18.

export

boolean

Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified PriorityLevelConfiguration

Table 17. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
Table 18. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 19. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified PriorityLevelConfiguration

Table 20. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 21. Body parameters
Parameter Type Description

body

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1
Table 22. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

201 - Created

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty

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

Table 23. Global path parameters
Parameter Type Description

name

string

name of the PriorityLevelConfiguration
Table 24. Global guery parameters
Parameter Type Description

pretty

string

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

GET

Description

read status of the specified PriorityLevelConfiguration

Table 25. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified PriorityLevelConfiguration

Table 26. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
Table 27. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 28. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified PriorityLevelConfiguration

Table 29. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 30. Body parameters
Parameter Type Description

body

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1
Table 31. HTTP responses
HTTP code Reponse body

200 - OK

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

201 - Created

PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1alpha1

401 - Unauthorized

Empty