# FlowSchema

FlowSchemaFlowSchema defines the schema of a group of flows.apiVersion: flowcontrol.apiserver.k8s.io/v1import "k8s.io/api/flowcontrol/v1"FlowSchemaFlowSchema 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".apiVersion: flowcontrol.apiserver.k8s.io/v1kind: FlowSchemametadata (ObjectMeta)metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (FlowSchemaSpec)spec is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-statusstatus (FlowSchemaStatus)status is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-statusFlowSchemaSpecFlowSchemaSpec describes how the FlowSchema's specification looks like.distinguisherMethod (FlowDistinguisherMethod)distinguisherMethod defines how to compute the flow distinguisher for requests that match this schema. nil specifies that the distinguisher is disabled and thus will always be the empty string.FlowDistinguisherMethod specifies the method of a flow distinguisher.distinguisherMethod.type (string), requiredtype is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.matchingPrecedence (int32)matchingPrecedence is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.priorityLevelConfiguration (PriorityLevelConfigurationReference), requiredpriorityLevelConfiguration should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required.PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.priorityLevelConfiguration.name (string), requiredname is the name of the priority level configuration being referenced Required.rules ([]PolicyRulesWithSubjects)Atomic: will be replaced during a mergerules 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.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.rules.subjects ([]Subject), requiredAtomic: will be replaced during a mergesubjects 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.rules.subjects.kind (string), requiredkind indicates which one of the other fields is non-empty. Requiredrules.subjects.group (GroupSubject)group matches based on user group name.GroupSubject holds detailed information for group-kind subject.rules.subjects.group.name (string), requiredname 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.rules.subjects.serviceAccount (ServiceAccountSubject)serviceAccount matches ServiceAccounts.ServiceAccountSubject holds detailed information for service-account-kind subject.rules.subjects.serviceAccount.name (string), requiredname is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.rules.subjects.serviceAccount.namespace (string), requirednamespace is the namespace of matching ServiceAccount objects. Required.rules.subjects.user (UserSubject)user matches based on username.UserSubject holds detailed information for user-kind subject.rules.subjects.user.name (string), requiredname is the username that matches, or "*" to match all usernames. Required.rules.nonResourceRules ([]NonResourcePolicyRule)Atomic: will be replaced during a mergenonResourceRules is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.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.rules.nonResourceRules.nonResourceURLs ([]string), requiredSet: unique values will be kept during a mergenonResourceURLs is a set of url prefixes that a user should have access to and may not be empty. For example:"/healthz" is legal"/hea*" is illegal"/hea" is legal but matches nothing"/hea/*" also matches nothing"/healthz/" matches all per-component health checks. "" matches all non-resource urls. if it is present, it must be the only entry. Required.rules.nonResourceRules.verbs ([]string), requiredSet: unique values will be kept during a mergeverbs is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.rules.resourceRules ([]ResourcePolicyRule)Atomic: will be replaced during a mergeresourceRules 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.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) either (d1) the request does not specify a namespace (i.e., Namespace=="") and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace.rules.resourceRules.apiGroups ([]string), requiredSet: unique values will be kept during a mergeapiGroups is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.rules.resourceRules.resources ([]string), requiredSet: unique values will be kept during a mergeresources is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.rules.resourceRules.verbs ([]string), requiredSet: unique values will be kept during a mergeverbs is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.rules.resourceRules.clusterScope (boolean)clusterScope indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the namespaces field must contain a non-empty list.rules.resourceRules.namespaces ([]string)Set: unique values will be kept during a mergenamespaces is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "". Note that "" matches any specified namespace but does not match a request that does not specify a namespace (see the clusterScope field for that). This list may be empty, but only if clusterScope is true.FlowSchemaStatusFlowSchemaStatus represents the current state of a FlowSchema.conditions ([]FlowSchemaCondition)Patch strategy: merge on key typeMap: unique values on key type will be kept during a mergeconditions is a list of the current states of FlowSchema.FlowSchemaCondition describes conditions for a FlowSchema.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.FlowSchemaListFlowSchemaList is a list of FlowSchema objects.apiVersion: flowcontrol.apiserver.k8s.io/v1kind: FlowSchemaListmetadata (ListMeta)metadata is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]FlowSchema), requireditems is a list of FlowSchemas.Operationsget read the specified FlowSchemaHTTP RequestGET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}Parametersname (in path): string, requiredname of the FlowSchemapretty (in query): stringprettyResponse200 (FlowSchema): OK401: Unauthorizedget read status of the specified FlowSchemaHTTP RequestGET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/statusParametersname (in path): string, requiredname of the FlowSchemapretty (in query): stringprettyResponse200 (FlowSchema): OK401: Unauthorizedlist list or watch objects of kind FlowSchemaHTTP RequestGET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemasParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (FlowSchemaList): OK401: Unauthorizedcreate create a FlowSchemaHTTP RequestPOST /apis/flowcontrol.apiserver.k8s.io/v1/flowschemasParametersbody: FlowSchema, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (FlowSchema): OK201 (FlowSchema): Created202 (FlowSchema): Accepted401: Unauthorizedupdate replace the specified FlowSchemaHTTP RequestPUT /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}Parametersname (in path): string, requiredname of the FlowSchemabody: FlowSchema, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (FlowSchema): OK201 (FlowSchema): Created401: Unauthorizedupdate replace status of the specified FlowSchemaHTTP RequestPUT /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/statusParametersname (in path): string, requiredname of the FlowSchemabody: FlowSchema, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (FlowSchema): OK201 (FlowSchema): Created401: Unauthorizedpatch partially update the specified FlowSchemaHTTP RequestPATCH /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}Parametersname (in path): string, requiredname of the FlowSchemabody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (FlowSchema): OK201 (FlowSchema): Created401: Unauthorizedpatch partially update status of the specified FlowSchemaHTTP RequestPATCH /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/statusParametersname (in path): string, requiredname of the FlowSchemabody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (FlowSchema): OK201 (FlowSchema): Created401: Unauthorizeddelete delete a FlowSchemaHTTP RequestDELETE /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}Parametersname (in path): string, requiredname of the FlowSchemabody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of FlowSchemaHTTP RequestDELETE /apis/flowcontrol.apiserver.k8s.io/v1/flowschemasParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.