apiserver: k8s.io/apiserver/pkg/util/flowcontrol Index | Files | Directories

package flowcontrol

import "k8s.io/apiserver/pkg/util/flowcontrol"

Index

Package Files

apf_controller.go apf_controller_debug.go apf_filter.go formatting.go rule.go

type Interface Uses

type Interface interface {
    // Handle takes care of queuing and dispatching a request
    // characterized by the given digest.  The given `noteFn` will be
    // invoked with the results of request classification.  If Handle
    // decides that the request should be executed then `execute()`
    // will be invoked once to execute the request; otherwise
    // `execute()` will not be invoked.
    Handle(ctx context.Context,
        requestDigest RequestDigest,
        noteFn func(fs *fctypesv1a1.FlowSchema, pl *fctypesv1a1.PriorityLevelConfiguration),
        queueNoteFn fq.QueueNoteFn,
        execFn func(),
    )

    // Run monitors config objects from the main apiservers and causes
    // any needed changes to local behavior.  This method ceases
    // activity and returns after the given channel is closed.
    Run(stopCh <-chan struct{}) error

    // Install installs debugging endpoints to the web-server.
    Install(c *mux.PathRecorderMux)
}

Interface defines how the API Priority and Fairness filter interacts with the underlying system.

func New Uses

func New(
    informerFactory kubeinformers.SharedInformerFactory,
    flowcontrolClient fcclientv1a1.FlowcontrolV1alpha1Interface,
    serverConcurrencyLimit int,
    requestWaitLimit time.Duration,
) Interface

New creates a new instance to implement API priority and fairness

func NewTestable Uses

func NewTestable(
    informerFactory kubeinformers.SharedInformerFactory,
    flowcontrolClient fcclientv1a1.FlowcontrolV1alpha1Interface,
    serverConcurrencyLimit int,
    requestWaitLimit time.Duration,
    obsPairGenerator metrics.TimedObserverPairGenerator,
    queueSetFactory fq.QueueSetFactory,
) Interface

NewTestable is extra flexible to facilitate testing

type RequestDigest Uses

type RequestDigest struct {
    RequestInfo *request.RequestInfo
    User        user.Info
}

RequestDigest holds necessary info from request for flow-control

func (RequestDigest) GoString Uses

func (rd RequestDigest) GoString() string

GoString produces a golang source expression of the value.

type StartFunction Uses

type StartFunction func(ctx context.Context, hashValue uint64) (execute bool, afterExecution func())

StartFunction begins the process of handlig a request. If the request gets queued then this function uses the given hashValue as the source of entropy as it shuffle-shards the request into a queue. The descr1 and descr2 values play no role in the logic but appear in log messages. This method does not return until the queuing, if any, for this request is done. If `execute` is false then `afterExecution` is irrelevant and the request should be rejected. Otherwise the request should be executed and `afterExecution` must be called exactly once.

Directories

PathSynopsis
counter
debug
fairqueuing
fairqueuing/promise
fairqueuing/promise/lockingpromise
fairqueuing/queuesetPackage queueset implements a technique called "fair queuing for server requests".
fairqueuing/testing
fairqueuing/testing/clock
format
metrics

Package flowcontrol imports 42 packages (graph) and is imported by 11 packages. Updated 2020-08-05. Refresh now. Tools for package owners.