unleash

Documentation

Index

• Constants
• func APITokens(ctx context.Context, teamSlug slug.Slug) (int, error)
• func CPUUsage(ctx context.Context, teamSlug slug.Slug) (float64, error)
• func MemoryUsage(ctx context.Context, teamSlug slug.Slug) (float64, error)
• func NewLoaderContext(ctx context.Context, tenantName string, ...) context.Context
• func NewWatcher(ctx context.Context, mgr *watcher.Manager) *watcher.Watcher[*UnleashInstance]
• func Toggles(ctx context.Context, teamSlug slug.Slug) (int, error)
• type AllowTeamAccessToUnleashInput
  • func (i *AllowTeamAccessToUnleashInput) Validate(ctx context.Context) error
• type AllowTeamAccessToUnleashPayload
• type BifrostClient
  • func NewBifrostClient(url string, log logrus.FieldLogger) BifrostClient
  • func NewFakeBifrostClient(wtchr *watcher.Watcher[*UnleashInstance]) BifrostClient
• type CreateUnleashForTeamInput
• type CreateUnleashForTeamPayload
• type FakeBifrostClient
  • func (f FakeBifrostClient) Post(ctx context.Context, path string, v any) (*http.Response, error)
  • func (f FakeBifrostClient) WithClient(_ *http.Client)
• type FakePrometheusClient
  • func (f FakePrometheusClient) Query(_ context.Context, query string, _ time.Time, _ ...promv1.Option) (model.Value, promv1.Warnings, error)
• type Prometheus
  • func NewFakePrometheusClient() Prometheus
• type RevokeTeamAccessToUnleashInput
• type RevokeTeamAccessToUnleashPayload
• type UnleashInstance
  • func AllowTeamAccess(ctx context.Context, input AllowTeamAccessToUnleashInput) (*UnleashInstance, error)
  • func Create(ctx context.Context, input *CreateUnleashForTeamInput) (*UnleashInstance, error)
  • func ForTeam(ctx context.Context, teamSlug slug.Slug) (*UnleashInstance, error)
  • func GetByIdent(ctx context.Context, id ident.Ident) (*UnleashInstance, error)
  • func RevokeTeamAccess(ctx context.Context, input RevokeTeamAccessToUnleashInput) (*UnleashInstance, error)
  • func (u *UnleashInstance) DeepCopyObject() runtime.Object
  • func (u *UnleashInstance) GetLabels() map[string]string
  • func (u *UnleashInstance) GetName() string
  • func (u *UnleashInstance) GetNamespace() string
  • func (u *UnleashInstance) GetObjectKind() schema.ObjectKind
  • func (u UnleashInstance) ID() ident.Ident
  • func (UnleashInstance) IsNode()
• type UnleashInstanceCreatedActivityLogEntry
• type UnleashInstanceMetrics
• type UnleashInstanceUpdatedActivityLogEntry
• type UnleashInstanceUpdatedActivityLogEntryData

Constants

const (
	FakeBifrostURL = "*fake*"
)

const (
	ManagementClusterNamespace = "bifrost-unleash"
)

Functions

func APITokens

func APITokens(ctx context.Context, teamSlug slug.Slug) (int, error)

func CPUUsage

func CPUUsage(ctx context.Context, teamSlug slug.Slug) (float64, error)

func MemoryUsage

func MemoryUsage(ctx context.Context, teamSlug slug.Slug) (float64, error)

func NewLoaderContext

func NewLoaderContext(ctx context.Context, tenantName string, appWatcher *watcher.Watcher[*UnleashInstance], bifrostAPIURL string, log logrus.FieldLogger) context.Context

NewLoaderContext creates a new context with a loaders value. If *fake* is provided as bifrostAPIURL, a fake client will be used.

func NewWatcher

func NewWatcher(ctx context.Context, mgr *watcher.Manager) *watcher.Watcher[*UnleashInstance]

func Toggles

func Toggles(ctx context.Context, teamSlug slug.Slug) (int, error)

Types

type AllowTeamAccessToUnleashInput

type AllowTeamAccessToUnleashInput struct {
	TeamSlug        slug.Slug `json:"team"`
	AllowedTeamSlug slug.Slug `json:"allowedTeam"`
}

func (*AllowTeamAccessToUnleashInput) Validate

func (i *AllowTeamAccessToUnleashInput) Validate(ctx context.Context) error

type AllowTeamAccessToUnleashPayload

type AllowTeamAccessToUnleashPayload struct {
	Unleash *UnleashInstance `json:"unleash,omitempty"`
}

type BifrostClient

type BifrostClient interface {
	Post(ctx context.Context, path string, v any) (*http.Response, error)
	WithClient(client *http.Client)
}

func NewBifrostClient

func NewBifrostClient(url string, log logrus.FieldLogger) BifrostClient

func NewFakeBifrostClient

func NewFakeBifrostClient(wtchr *watcher.Watcher[*UnleashInstance]) BifrostClient

type CreateUnleashForTeamInput

type CreateUnleashForTeamInput struct {
	TeamSlug slug.Slug `json:"team"`
}

type CreateUnleashForTeamPayload

type CreateUnleashForTeamPayload struct {
	Unleash *UnleashInstance `json:"unleash,omitempty"`
}

type FakeBifrostClient

type FakeBifrostClient struct {
	// contains filtered or unexported fields
}

func (FakeBifrostClient) Post

func (f FakeBifrostClient) Post(ctx context.Context, path string, v any) (*http.Response, error)

func (FakeBifrostClient) WithClient

func (f FakeBifrostClient) WithClient(_ *http.Client)

type FakePrometheusClient

type FakePrometheusClient struct{}

func (FakePrometheusClient) Query

func (f FakePrometheusClient) Query(_ context.Context, query string, _ time.Time, _ ...promv1.Option) (model.Value, promv1.Warnings, error)

type Prometheus

type Prometheus interface {
	Query(ctx context.Context, query string, ts time.Time, opts ...prom.Option) (model.Value, prom.Warnings, error)
}

func NewFakePrometheusClient

func NewFakePrometheusClient() Prometheus

type RevokeTeamAccessToUnleashInput

type RevokeTeamAccessToUnleashInput struct {
	TeamSlug        slug.Slug `json:"team"`
	RevokedTeamSlug slug.Slug `json:"revokedTeam"`
}

type RevokeTeamAccessToUnleashPayload

type RevokeTeamAccessToUnleashPayload struct {
	Unleash *UnleashInstance `json:"unleash,omitempty"`
}

type UnleashInstance

type UnleashInstance struct {
	Name       string                  `json:"name"`
	Version    string                  `json:"version"`
	WebIngress string                  `json:"webIngress"`
	APIIngress string                  `json:"apiIngress"`
	Metrics    *UnleashInstanceMetrics `json:"metrics"`
	Ready      bool                    `json:"ready"`

	TeamSlug         slug.Slug   `json:"-"`
	AllowedTeamSlugs []slug.Slug `json:"-"`
}

func AllowTeamAccess

func AllowTeamAccess(ctx context.Context, input AllowTeamAccessToUnleashInput) (*UnleashInstance, error)

func Create

func Create(ctx context.Context, input *CreateUnleashForTeamInput) (*UnleashInstance, error)

func ForTeam

func ForTeam(ctx context.Context, teamSlug slug.Slug) (*UnleashInstance, error)

func GetByIdent

func GetByIdent(ctx context.Context, id ident.Ident) (*UnleashInstance, error)

func RevokeTeamAccess

func RevokeTeamAccess(ctx context.Context, input RevokeTeamAccessToUnleashInput) (*UnleashInstance, error)

func (*UnleashInstance) DeepCopyObject

func (u *UnleashInstance) DeepCopyObject() runtime.Object

func (*UnleashInstance) GetLabels

func (u *UnleashInstance) GetLabels() map[string]string

func (*UnleashInstance) GetName

func (u *UnleashInstance) GetName() string

func (*UnleashInstance) GetNamespace

func (u *UnleashInstance) GetNamespace() string

func (*UnleashInstance) GetObjectKind

func (u *UnleashInstance) GetObjectKind() schema.ObjectKind

func (UnleashInstance) ID

func (u UnleashInstance) ID() ident.Ident

func (UnleashInstance) IsNode

func (UnleashInstance) IsNode()

type UnleashInstanceCreatedActivityLogEntry

type UnleashInstanceCreatedActivityLogEntry struct {
	activitylog.GenericActivityLogEntry
}

type UnleashInstanceMetrics

type UnleashInstanceMetrics struct {
	CPURequests    float64 `json:"cpuRequests"`
	MemoryRequests float64 `json:"memoryRequests"`

	TeamSlug slug.Slug `json:"-"`
}

type UnleashInstanceUpdatedActivityLogEntry

type UnleashInstanceUpdatedActivityLogEntry struct {
	activitylog.GenericActivityLogEntry
	Data *UnleashInstanceUpdatedActivityLogEntryData `json:"data"`
}

type UnleashInstanceUpdatedActivityLogEntryData

type UnleashInstanceUpdatedActivityLogEntryData struct {
	RevokedTeamSlug *slug.Slug `json:"revokedTeamSlug"`
	AllowedTeamSlug *slug.Slug `json:"allowedTeamSlug"`
}