Documentation ¶
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type FlowDistinguisherMethod
- type FlowSchema
- type FlowSchemaCondition
- type FlowSchemaList
- type FlowSchemaSpec
- type FlowSchemaStatus
- type GroupSubject
- type LimitResponse
- type LimitedPriorityLevelConfiguration
- type NonResourcePolicyRule
- type PolicyRulesWithSubjects
- type PriorityLevelConfiguration
- type PriorityLevelConfigurationCondition
- type PriorityLevelConfigurationList
- type PriorityLevelConfigurationReference
- type PriorityLevelConfigurationSpec
- type PriorityLevelConfigurationStatus
- type QueuingConfiguration
- type ResourcePolicyRule
- type ServiceAccountSubject
- type Subject
- type UserSubject
Constants ¶
const GroupName = "flowcontrol.apiserver.k8s.io"
GroupName is the group name use in this package
Variables ¶
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta2"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type FlowDistinguisherMethod ¶
type FlowDistinguisherMethod struct { // `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. // Required: true Type *string `json:"type"` }
FlowDistinguisherMethod FlowDistinguisherMethod specifies the method of a flow distinguisher.
swagger:model FlowDistinguisherMethod
type FlowSchema ¶
type FlowSchema struct { // 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 APIVersion string `json:"apiVersion,omitempty"` // 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 Kind string `json:"kind,omitempty"` // `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"` // `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-status Spec *FlowSchemaSpec `json:"spec,omitempty"` // `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Status *FlowSchemaStatus `json:"status,omitempty"` }
FlowSchema 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".
swagger:model FlowSchema
func (*FlowSchema) GroupVersionKind ¶
func (v *FlowSchema) GroupVersionKind() schema.GroupVersionKind
type FlowSchemaCondition ¶
type FlowSchemaCondition struct { // `lastTransitionTime` is the last time the condition transitioned from one status to another. LastTransitionTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastTransitionTime,omitempty"` // `message` is a human-readable message indicating details about last transition. Message string `json:"message,omitempty"` // `reason` is a unique, one-word, CamelCase reason for the condition's last transition. Reason string `json:"reason,omitempty"` // `status` is the status of the condition. Can be True, False, Unknown. Required. Status string `json:"status,omitempty"` // `type` is the type of the condition. Required. Type string `json:"type,omitempty"` }
FlowSchemaCondition FlowSchemaCondition describes conditions for a FlowSchema.
swagger:model FlowSchemaCondition
type FlowSchemaList ¶
type FlowSchemaList struct { // 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 APIVersion string `json:"apiVersion,omitempty"` // `items` is a list of FlowSchemas. // Required: true Items []*FlowSchema `json:"items"` // 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 Kind string `json:"kind,omitempty"` // `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"` }
FlowSchemaList FlowSchemaList is a list of FlowSchema objects.
swagger:model FlowSchemaList
func (*FlowSchemaList) GroupVersionKind ¶
func (v *FlowSchemaList) GroupVersionKind() schema.GroupVersionKind
type FlowSchemaSpec ¶
type FlowSchemaSpec struct { // `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. DistinguisherMethod *FlowDistinguisherMethod `json:"distinguisherMethod,omitempty"` // `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. MatchingPrecedence int32 `json:"matchingPrecedence,omitempty"` // `priorityLevelConfiguration` 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. // Required: true PriorityLevelConfiguration *PriorityLevelConfigurationReference `json:"priorityLevelConfiguration"` // `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. Rules []*PolicyRulesWithSubjects `json:"rules,omitempty"` }
FlowSchemaSpec FlowSchemaSpec describes how the FlowSchema's specification looks like.
swagger:model FlowSchemaSpec
type FlowSchemaStatus ¶
type FlowSchemaStatus struct { // `conditions` is a list of the current states of FlowSchema. Conditions []*FlowSchemaCondition `json:"conditions,omitempty"` }
FlowSchemaStatus FlowSchemaStatus represents the current state of a FlowSchema.
swagger:model FlowSchemaStatus
type GroupSubject ¶
type GroupSubject struct { // 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. // Required: true Name *string `json:"name"` }
GroupSubject GroupSubject holds detailed information for group-kind subject.
swagger:model GroupSubject
type LimitResponse ¶
type LimitResponse struct { // `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. Queuing *QueuingConfiguration `json:"queuing,omitempty"` // `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. // Required: true Type *string `json:"type"` }
LimitResponse LimitResponse defines how to handle requests that can not be executed right now.
swagger:model LimitResponse
type LimitedPriorityLevelConfiguration ¶
type LimitedPriorityLevelConfiguration struct { // // 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. AssuredConcurrencyShares int32 `json:"assuredConcurrencyShares,omitempty"` // `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. BorrowingLimitPercent int32 `json:"borrowingLimitPercent,omitempty"` // `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 ) LendablePercent int32 `json:"lendablePercent,omitempty"` // `limitResponse` indicates what to do with requests that can not be executed right now LimitResponse *LimitResponse `json:"limitResponse,omitempty"` }
LimitedPriorityLevelConfiguration 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?
swagger:model LimitedPriorityLevelConfiguration
type NonResourcePolicyRule ¶
type NonResourcePolicyRule struct { // `nonResourceURLs` 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. // Required: true NonResourceURLs []string `json:"nonResourceURLs"` // `verbs` 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. // Required: true Verbs []string `json:"verbs"` }
NonResourcePolicyRule 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.
swagger:model NonResourcePolicyRule
type PolicyRulesWithSubjects ¶
type PolicyRulesWithSubjects struct { // `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. NonResourceRules []*NonResourcePolicyRule `json:"nonResourceRules,omitempty"` // `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. ResourceRules []*ResourcePolicyRule `json:"resourceRules,omitempty"` // 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. // Required: true Subjects []*Subject `json:"subjects"` }
PolicyRulesWithSubjects 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.
swagger:model PolicyRulesWithSubjects
type PriorityLevelConfiguration ¶
type PriorityLevelConfiguration struct { // 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 APIVersion string `json:"apiVersion,omitempty"` // 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 Kind string `json:"kind,omitempty"` // `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"` // `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *PriorityLevelConfigurationSpec `json:"spec,omitempty"` // `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Status *PriorityLevelConfigurationStatus `json:"status,omitempty"` }
PriorityLevelConfiguration PriorityLevelConfiguration represents the configuration of a priority level.
swagger:model PriorityLevelConfiguration
func (*PriorityLevelConfiguration) GroupVersionKind ¶
func (v *PriorityLevelConfiguration) GroupVersionKind() schema.GroupVersionKind
type PriorityLevelConfigurationCondition ¶
type PriorityLevelConfigurationCondition struct { // `lastTransitionTime` is the last time the condition transitioned from one status to another. LastTransitionTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastTransitionTime,omitempty"` // `message` is a human-readable message indicating details about last transition. Message string `json:"message,omitempty"` // `reason` is a unique, one-word, CamelCase reason for the condition's last transition. Reason string `json:"reason,omitempty"` // `status` is the status of the condition. Can be True, False, Unknown. Required. Status string `json:"status,omitempty"` // `type` is the type of the condition. Required. Type string `json:"type,omitempty"` }
PriorityLevelConfigurationCondition PriorityLevelConfigurationCondition defines the condition of priority level.
swagger:model PriorityLevelConfigurationCondition
type PriorityLevelConfigurationList ¶
type PriorityLevelConfigurationList struct { // 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 APIVersion string `json:"apiVersion,omitempty"` // `items` is a list of request-priorities. // Required: true Items []*PriorityLevelConfiguration `json:"items"` // 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 Kind string `json:"kind,omitempty"` // `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"` }
PriorityLevelConfigurationList PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.
swagger:model PriorityLevelConfigurationList
func (*PriorityLevelConfigurationList) GroupVersionKind ¶
func (v *PriorityLevelConfigurationList) GroupVersionKind() schema.GroupVersionKind
type PriorityLevelConfigurationReference ¶
type PriorityLevelConfigurationReference struct { // `name` is the name of the priority level configuration being referenced Required. // Required: true Name *string `json:"name"` }
PriorityLevelConfigurationReference PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.
swagger:model PriorityLevelConfigurationReference
type PriorityLevelConfigurationSpec ¶
type PriorityLevelConfigurationSpec struct { // `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. Limited *LimitedPriorityLevelConfiguration `json:"limited,omitempty"` // `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. // Required: true Type *string `json:"type"` }
PriorityLevelConfigurationSpec PriorityLevelConfigurationSpec specifies the configuration of a priority level.
swagger:model PriorityLevelConfigurationSpec
type PriorityLevelConfigurationStatus ¶
type PriorityLevelConfigurationStatus struct { // `conditions` is the current state of "request-priority". Conditions []*PriorityLevelConfigurationCondition `json:"conditions,omitempty"` }
PriorityLevelConfigurationStatus PriorityLevelConfigurationStatus represents the current state of a "request-priority".
swagger:model PriorityLevelConfigurationStatus
type QueuingConfiguration ¶
type QueuingConfiguration struct { // `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. HandSize int32 `json:"handSize,omitempty"` // `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. QueueLengthLimit int32 `json:"queueLengthLimit,omitempty"` // `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. Queues int32 `json:"queues,omitempty"` }
QueuingConfiguration QueuingConfiguration holds the configuration parameters for queuing
swagger:model QueuingConfiguration
type ResourcePolicyRule ¶
type ResourcePolicyRule struct { // `apiGroups` 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. // Required: true APIGroups []string `json:"apiGroups"` // `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. ClusterScope bool `json:"clusterScope,omitempty"` // `namespaces` 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. Namespaces []string `json:"namespaces,omitempty"` // `resources` 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. // Required: true Resources []string `json:"resources"` // `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. // Required: true Verbs []string `json:"verbs"` }
ResourcePolicyRule 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.
swagger:model ResourcePolicyRule
type ServiceAccountSubject ¶
type ServiceAccountSubject struct { // `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required. // Required: true Name *string `json:"name"` // `namespace` is the namespace of matching ServiceAccount objects. Required. // Required: true Namespace *string `json:"namespace"` }
ServiceAccountSubject ServiceAccountSubject holds detailed information for service-account-kind subject.
swagger:model ServiceAccountSubject
type Subject ¶
type Subject struct { // `group` matches based on user group name. Group *GroupSubject `json:"group,omitempty"` // `kind` indicates which one of the other fields is non-empty. Required // Required: true Kind *string `json:"kind"` // `serviceAccount` matches ServiceAccounts. ServiceAccount *ServiceAccountSubject `json:"serviceAccount,omitempty"` // `user` matches based on username. User *UserSubject `json:"user,omitempty"` }
Subject 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.
swagger:model Subject
type UserSubject ¶
type UserSubject struct { // `name` is the username that matches, or "*" to match all usernames. Required. // Required: true Name *string `json:"name"` }
UserSubject UserSubject holds detailed information for user-kind subject.
swagger:model UserSubject
Source Files ¶
- flow_distinguisher_method.go
- flow_schema.go
- flow_schema_condition.go
- flow_schema_gvk.go
- flow_schema_list.go
- flow_schema_list_gvk.go
- flow_schema_spec.go
- flow_schema_status.go
- group_info.go
- group_subject.go
- limit_response.go
- limited_priority_level_configuration.go
- non_resource_policy_rule.go
- policy_rules_with_subjects.go
- priority_level_configuration.go
- priority_level_configuration_condition.go
- priority_level_configuration_gvk.go
- priority_level_configuration_list.go
- priority_level_configuration_list_gvk.go
- priority_level_configuration_reference.go
- priority_level_configuration_spec.go
- priority_level_configuration_status.go
- queuing_configuration.go
- resource_policy_rule.go
- service_account_subject.go
- subject.go
- user_subject.go