quota

Documentation

Overview

Package quota provides a LUCI Quota Library implementation.

Index

• Variables
• func NewModule(opts *ModuleOptions) module.Module
• func NewModuleFromFlags() module.Module
• func NewQuotaAdminServer(readerGroup, writerGroup string) pb.QuotaAdminServer
• func UpdateQuota(ctx context.Context, updates map[string]int64, opts *Options) error
• func Use(ctx context.Context, cfg quotaconfig.Interface) context.Context
• type ModuleOptions
  • func (o *ModuleOptions) Register(f *flag.FlagSet)
• type Options

Variables

var ErrInsufficientQuota = errors.New("insufficient quota")

ErrInsufficientQuota is returned by UpdateQuota when the updates were not applied due to insufficient quota.

var ModuleName = module.RegisterName("go.chromium.org/luci/server/quota")

ModuleName is the globally-unique name for this module. Useful for registering this module as a dependency of other modules.

Functions

func NewModule

func NewModule(opts *ModuleOptions) module.Module

NewModule returns a module.Module for the quota library initialized from the given *ModuleOptions.

func NewModuleFromFlags

func NewModuleFromFlags() module.Module

NewModuleFromFlags returns a module.Module for the quota library which can be initialized from command line flags.

func NewQuotaAdminServer

func NewQuotaAdminServer(readerGroup, writerGroup string) pb.QuotaAdminServer

NewQuotaAdminServer returns a pb.QuotaAdminServer with ACLs limited to the given groups. Readers have access to Get. TODO(crbug/1280055): Add more admin methods, detail access here.

func UpdateQuota

func UpdateQuota(ctx context.Context, updates map[string]int64, opts *Options) error

UpdateQuota atomically adjusts the given quota entries using the given map of policy names to numeric update amounts as well as the given *Options. Returns ErrInsufficientQuota when the adjustments were not made due to insufficient quota.

Panics if quotaconfig.Interface is not available in the given context.Context (see WithConfig).

func Use

func Use(ctx context.Context, cfg quotaconfig.Interface) context.Context

Use returns a context.Context directing this package to use the given quotaconfig.Interface.

Types

type ModuleOptions

type ModuleOptions struct {
	// AdminServerReaders is a Chrome Infra Auth group authorized to use read-only
	// methods of the quota admin pRPC service. If unspecified, the service will
	// not be exposed.
	AdminServiceReaders string

	// AdminServerWriters is a Chrome Infra Auth group authorized to use all
	// methods of the quota admin pRPC service. If unspecified, the service will
	// not be exposed.
	AdminServiceWriters string

	// ConfigRefreshCronHandlerID is the ID for this module's config refresh
	// handler. If specified, the module ensures Refresh is called on the
	// quotaconfig.Interface in the server context. The handler will be installed
	// at <serving-prefix>/<ID>. The serving prefix is controlled by server/cron.
	// If unspecified, module users should refresh policy configs periodically by
	// manually calling Refresh.
	ConfigRefreshCronHandlerID string
}

ModuleOptions is a set of configuration options for the quota module.

func (*ModuleOptions) Register

func (o *ModuleOptions) Register(f *flag.FlagSet)

Register adds command line flags for these module options to the given *flag.FlagSet. Mutates module options by initializing defaults.

type Options

type Options struct {
	// RequestID is a string to use for deduplication of successful quota
	// adjustments, valid for one hour. Only successful updates are deduplicated,
	// mainly for the case where time has passed and quota has replenished
	// enough for a previously failed adjustment to succeed.
	//
	// Callers should ensure the same Options and function parameters are provided
	// each time a request ID is reused, since any reuse within a one hour period
	// is subject to deduplication regardless of other Options and parameters.
	RequestID string
	// User is a value to substitute for ${user} in policy names.
	// Policy defaults are sourced from the unsubstituted name.
	User string
}