FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]
FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a “flow distinguisher”.
Type
.spec
Description
FlowSchemaSpec describes how the FlowSchema’s specification looks like.
Type
object
Required
priorityLevelConfiguration
Property | Type | Description |
---|---|---|
|
| FlowDistinguisherMethod specifies the method of a flow distinguisher. |
|
|
|
|
| PriorityLevelConfigurationReference contains information that points to the “request-priority” being used. |
|
|
|
|
| PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. |
.spec.distinguisherMethod
Description
FlowDistinguisherMethod specifies the method of a flow distinguisher.
Type
object
Required
type
Property | Type | Description |
---|---|---|
|
|
|
.spec.priorityLevelConfiguration
Description
PriorityLevelConfigurationReference contains information that points to the “request-priority” being used.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
|
|
.spec.rules
Description
rules
describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.
Type
array
.spec.rules[]
Description
PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.
Type
object
Required
subjects
Property | Type | Description |
---|---|---|
|
|
|
|
| NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. |
|
|
|
|
| ResourcePolicyRule is a predicate that matches some resource requests, testing the request’s verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request. |
|
| subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. |
|
| Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account. |
.spec.rules[].nonResourceRules
Description
nonResourceRules
is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
Type
array
.spec.rules[].nonResourceRules[]
Description
NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.
Type
object
Required
verbs
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
.spec.rules[].resourceRules
Description
resourceRules
is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of resourceRules
and nonResourceRules
has to be non-empty.
Type
array
.spec.rules[].resourceRules[]
Description
ResourcePolicyRule is a predicate that matches some resource requests, testing the request’s verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.
Type
object
Required
verbs
apiGroups
resources
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
| is a list of matching verbs and may not be empty. “*” matches all verbs and, if present, must be the only entry. Required. |
.spec.rules[].subjects
Description
subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.
Type
array
.spec.rules[].subjects[]
Description
Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.
Type
object
Required
kind
Property | Type | Description |
---|---|---|
|
| |
|
| Required |
|
| ServiceAccountSubject holds detailed information for service-account-kind subject. |
|
| UserSubject holds detailed information for user-kind subject. |
.spec.rules[].subjects[].group
Description
GroupSubject holds detailed information for group-kind subject.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
| name is the user group that matches, or “*” to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. |
.spec.rules[].subjects[].serviceAccount
Description
ServiceAccountSubject holds detailed information for service-account-kind subject.
Type
object
Required
namespace
name
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
.spec.rules[].subjects[].user
Description
UserSubject holds detailed information for user-kind subject.
Type
object
Required
name
Property | Type | Description |
---|---|---|
|
|
|
.status
Description
FlowSchemaStatus represents the current state of a FlowSchema.
Type
object
Property | Type | Description |
---|---|---|
|
|
|
|
| FlowSchemaCondition describes conditions for a FlowSchema. |
.status.conditions
Description
conditions
is a list of the current states of FlowSchema.
Type
array
.status.conditions[]
Description
FlowSchemaCondition describes conditions for a FlowSchema.
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
API endpoints
The following API endpoints are available:
/apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas
DELETE
: delete collection of FlowSchemaPOST
: create a FlowSchema
/apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}
DELETE
: delete a FlowSchemaGET
: read the specified FlowSchemaPATCH
: partially update the specified FlowSchemaPUT
: replace the specified FlowSchema
/apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status
GET
: read status of the specified FlowSchemaPATCH
: partially update status of the specified FlowSchemaPUT
: replace status of the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of FlowSchema
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
GET
Description
list or watch objects of kind FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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. |
| 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. | |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 sets a constraint on what resource versions a request may be served from. See for details. Defaults to unset |
|
| 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
POST
Description
create a FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
Parameter | Type | Description |
---|---|---|
|
| name of the FlowSchema |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| 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. |
|
| 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. |
|
| 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
GET
Description
read the specified FlowSchema
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
PATCH
Description
partially update the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
PUT
Description
replace the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
Parameter | Type | Description |
---|---|---|
|
| name of the FlowSchema |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read status of the specified FlowSchema
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
PATCH
Description
partially update status of the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
HTTP method
PUT
Description
replace status of the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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 . |
Parameter | Type | Description |
---|---|---|
|