api

type JSONListStream ¶

type JSONListStream[T any] struct {
	OuterFieldName string
	Request        *http.Request
	ResponseWriter http.ResponseWriter
	// contains filtered or unexported fields
}

JSONListStream writes a JSON response containing a single array in the form

{ "things": [ thing1, thing2, ..., thingN ] }

without needing to hold the entire list of things in memory at once. This is especially necessary for large project reports because the JSON can grow to several 100 MiB for large domains and high detail settings, which would lead to OOM on the API process in a cgroup-controlled deployment if we try to hold it all in memory.

We delay the opening `{"things":[` until we receive the first item, so that errors can be logged as a 5xx response if necessary. Upon getting the first report, we commit to the response being 200 and print reports as they come in. If we get to the end, we just need to write the trailing `]}` to complete the response.

func NewJSONListStream[T any](w http.ResponseWriter, r *http.Request, outerFieldName string) *JSONListStream[T]

func (s *JSONListStream[T]) FinalizeDocument(err error)

func (s *JSONListStream[T]) WriteItem(item T) error

type MissingProjectReportError ¶

type MissingProjectReportError struct {
	ServiceType  limes.ServiceType
	ResourceName limesresources.ResourceName
}

MissingProjectReportError is returned by QuotaUpdater.ValidateInput() when a project report is incomplete. This usually happens when a user tries to PUT a quota on a new project that has not been scraped yet.

func (e MissingProjectReportError) Error() string

type QuotaRequest ¶

type QuotaRequest struct {
	OldValue        uint64
	NewValue        uint64
	Unit            limes.Unit
	ValidationError *core.QuotaValidationError
}

QuotaRequest describes a single quota value that a PUT request wants to change. It appears in type QuotaUpdater.

type QuotaUpdater ¶

type QuotaUpdater struct {
	// scope
	Cluster *core.Cluster
	Domain  *db.Domain  // always set (for project quota updates, contains the project's domain)
	Project *db.Project // nil for domain quota updates

	// context
	DB  *gorp.DbMap
	Now time.Time

	// AuthZ info
	CanRaise   func(serviceType limes.ServiceType, resourceName limesresources.ResourceName) bool
	CanRaiseLP func(serviceType limes.ServiceType, resourceName limesresources.ResourceName) bool // low-privilege raise
	CanLower   func(serviceType limes.ServiceType, resourceName limesresources.ResourceName) bool
	CanLowerLP func(serviceType limes.ServiceType, resourceName limesresources.ResourceName) bool

	// Filled by ValidateInput() with the keys being the service type and the resource name.
	Requests map[limes.ServiceType]map[limesresources.ResourceName]QuotaRequest
}

QuotaUpdater contains the shared code for domain and project PUT requests. See func PutDomain and func PutProject for how it's used.

func (u QuotaUpdater) CommitAuditTrail(token *gopherpolicy.Token, r *http.Request, requestTime time.Time)

func (u QuotaUpdater) IsValid() bool

func (u QuotaUpdater) QuotaConstraints() core.QuotaConstraints

func (u QuotaUpdater) ScopeName() string

func (u QuotaUpdater) ScopeType() string

func (u *QuotaUpdater) ValidateInput(input limesresources.QuotaRequest, dbi db.Interface) error

func (u QuotaUpdater) WritePutErrorResponse(w http.ResponseWriter)

func (u QuotaUpdater) WriteSimulationReport(w http.ResponseWriter)

type RateLimitRequest ¶

type RateLimitRequest struct {
	Unit            limes.Unit
	OldLimit        uint64
	NewLimit        uint64
	OldWindow       limesrates.Window
	NewWindow       limesrates.Window
	ValidationError *core.QuotaValidationError
}

RateLimitRequest describes a single rate limit that a PUT requests wants to change. It appears in type QuotaUpdater.

type RateLimitUpdater ¶

type RateLimitUpdater struct {
	// scope (all fields are always set since rate limits can only be updated on
	// the project level)
	Cluster *core.Cluster
	Domain  *db.Domain
	Project *db.Project

	// AuthZ info
	CanSetRateLimit func(limes.ServiceType) bool

	// Filled by ValidateInput() with the keys being the service type and the rate name.
	Requests map[limes.ServiceType]map[limesrates.RateName]RateLimitRequest
}

RateLimitUpdater is the equivalent of QuotaUpdater for rate limit PUT requests.

func (u RateLimitUpdater) CommitAuditTrail(token *gopherpolicy.Token, r *http.Request, requestTime time.Time)

func (u RateLimitUpdater) IsValid() bool

func (u *RateLimitUpdater) ValidateInput(input limesrates.RateRequest, dbi db.Interface) error

func (u RateLimitUpdater) WritePutErrorResponse(w http.ResponseWriter)

func (u RateLimitUpdater) WriteSimulationReport(w http.ResponseWriter)

type VersionData ¶

type VersionData struct {
	Status string            `json:"status"`
	ID     string            `json:"id"`
	Links  []VersionLinkData `json:"links"`
}

VersionData is used by version advertisement handlers.

type VersionLinkData ¶

type VersionLinkData struct {
	URL      string `json:"href"`
	Relation string `json:"rel"`
	Type     string `json:"type,omitempty"`
}

VersionLinkData is used by version advertisement handlers, as part of the VersionData struct.