store

package
v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 4, 2025 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SortByName      SortColumn = "name"
	SortByCreatedAt SortColumn = "created_at"

	SortAsc  SortOrder = "asc"
	SortDesc SortOrder = "desc"
)

Variables

View Source 
var (
	NullOrgId              = uuid.MustParse("00000000-0000-0000-0000-000000000000")
	CurrentContinueVersion = 1
)

Functions

func AddPaginationToQuery 

func AddPaginationToQuery(query *gorm.DB, limit int, cont *Continue, listParams ListParams) *gorm.DB

func BuildContinueString added in v0.8.1 

func BuildContinueString(names []string, count int64) *string

func CallEventCallback added in v0.9.0 

func CallEventCallback(resourceKind api.ResourceKind, log logrus.FieldLogger) func(ctx context.Context, callbackEvent EventCallback, orgId uuid.UUID, name string, oldResource, newResource interface{}, created bool, err error)

func CloseDB 

func CloseDB(db *gorm.DB)

func CountRemainingItems 

func CountRemainingItems(query *gorm.DB, nextValues []string, listParams ListParams) int64

func DeleteTestDB 

func DeleteTestDB(ctx context.Context, log *logrus.Logger, cfg *config.Config, store Store, dbName string)

func ErrorFromGormError added in v0.3.0 

func ErrorFromGormError(err error) error

func GetNonNilFieldsFromResource 

func GetNonNilFieldsFromResource(resource model.Resource) []string

func InitDB 

func InitDB(cfg *config.Config, log *logrus.Logger) (*gorm.DB, error)

func InitMigrationDB added in v0.9.0 

func InitMigrationDB(cfg *config.Config, log *logrus.Logger) (*gorm.DB, error)

func ListQuery added in v0.3.0 

func ListQuery(dest any, opts ...ListQueryOption) *listQuery

func NewTraceContextEnforcer added in v0.8.1 

func NewTraceContextEnforcer() gorm.Plugin

func SafeEventCallback added in v0.9.0 

func SafeEventCallback(log logrus.FieldLogger, callback func())

Call callback if provided (but don't fail the operation if callback fails) with panic recovery to prevent callback failures from affecting the main operation

func WithBypassSpanCheck added in v0.8.1 

func WithBypassSpanCheck(ctx context.Context) context.Context

WithBypassSpanCheck returns a child context that disables span enforcement.

Types

type CertificateSigningRequest 

type CertificateSigningRequest interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, req *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, error)
	Update(ctx context.Context, orgId uuid.UUID, req *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, certificatesigningrequest *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string) (*api.CertificateSigningRequest, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.CertificateSigningRequestList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, eventCallback EventCallback) error
	UpdateStatus(ctx context.Context, orgId uuid.UUID, certificatesigningrequest *api.CertificateSigningRequest) (*api.CertificateSigningRequest, error)

	UpdateConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition) error
}

func NewCertificateSigningRequest 

func NewCertificateSigningRequest(db *gorm.DB, log logrus.FieldLogger) CertificateSigningRequest

type CertificateSigningRequestStore 

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

func (*CertificateSigningRequestStore) Create 

func (s *CertificateSigningRequestStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, error)

Warning: this is a user-facing function and will set the Status to nil

func (*CertificateSigningRequestStore) CreateOrUpdate 

func (s *CertificateSigningRequestStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, bool, error)

func (*CertificateSigningRequestStore) Delete 

func (s *CertificateSigningRequestStore) Delete(ctx context.Context, orgId uuid.UUID, name string, eventCallback EventCallback) error

func (*CertificateSigningRequestStore) Get 

func (s *CertificateSigningRequestStore) Get(ctx context.Context, orgId uuid.UUID, name string) (*api.CertificateSigningRequest, error)

func (*CertificateSigningRequestStore) InitialMigration 

func (s *CertificateSigningRequestStore) InitialMigration(ctx context.Context) error

func (*CertificateSigningRequestStore) List 

func (s *CertificateSigningRequestStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.CertificateSigningRequestList, error)

func (*CertificateSigningRequestStore) Update added in v0.2.0 

func (s *CertificateSigningRequestStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.CertificateSigningRequest, eventCallback EventCallback) (*api.CertificateSigningRequest, error)

Warning: this is a user-facing function and will set the Status to nil

func (*CertificateSigningRequestStore) UpdateConditions 

func (s *CertificateSigningRequestStore) UpdateConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition) error

func (*CertificateSigningRequestStore) UpdateStatus 

func (s *CertificateSigningRequestStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.CertificateSigningRequest) (*api.CertificateSigningRequest, error)

type Checkpoint added in v0.9.0 

type Checkpoint interface {
	InitialMigration(ctx context.Context) error
	Set(ctx context.Context, consumer string, key string, value []byte) error
	Get(ctx context.Context, consumer string, key string) ([]byte, error)
	GetDatabaseTime(ctx context.Context) (time.Time, error)
}

func NewCheckpoint added in v0.9.0 

func NewCheckpoint(db *gorm.DB, log logrus.FieldLogger) Checkpoint

type CheckpointStore added in v0.9.0 

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

func (*CheckpointStore) Get added in v0.9.0 

func (s *CheckpointStore) Get(ctx context.Context, consumer string, key string) ([]byte, error)

func (*CheckpointStore) GetDatabaseTime added in v0.9.0 

func (s *CheckpointStore) GetDatabaseTime(ctx context.Context) (time.Time, error)

func (*CheckpointStore) InitialMigration added in v0.9.0 

func (s *CheckpointStore) InitialMigration(ctx context.Context) error

func (*CheckpointStore) Set added in v0.9.0 

func (s *CheckpointStore) Set(ctx context.Context, consumer string, key string, value []byte) error

type Continue 

type Continue struct {
	Version int
	Names   []string
	Count   int64
}

func ParseContinueString 

func ParseContinueString(contStr *string) (*Continue, error)

type CreateOrUpdateMode added in v0.2.0 

type CreateOrUpdateMode string
const (
	ModeCreateOnly     CreateOrUpdateMode = "create-only"
	ModeUpdateOnly     CreateOrUpdateMode = "update-only"
	ModeCreateOrUpdate CreateOrUpdateMode = "create-or-update"
)

type DataStore 

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

func (*DataStore) CertificateSigningRequest 

func (s *DataStore) CertificateSigningRequest() CertificateSigningRequest

func (*DataStore) Checkpoint added in v0.9.0 

func (s *DataStore) Checkpoint() Checkpoint

func (*DataStore) Close 

func (s *DataStore) Close() error

func (*DataStore) Device 

func (s *DataStore) Device() Device

func (*DataStore) EnrollmentRequest 

func (s *DataStore) EnrollmentRequest() EnrollmentRequest

func (*DataStore) Event added in v0.7.0 

func (s *DataStore) Event() Event

func (*DataStore) Fleet 

func (s *DataStore) Fleet() Fleet

func (*DataStore) Organization added in v0.9.0 

func (s *DataStore) Organization() Organization

func (*DataStore) Repository 

func (s *DataStore) Repository() Repository

func (*DataStore) ResourceSync 

func (s *DataStore) ResourceSync() ResourceSync

func (*DataStore) RunMigrationWithMigrationUser added in v0.9.0 

func (s *DataStore) RunMigrationWithMigrationUser(ctx context.Context, cfg *config.Config, log *logrus.Logger) error

func (*DataStore) RunMigrations added in v0.9.0 

func (s *DataStore) RunMigrations(ctx context.Context) error

func (*DataStore) TemplateVersion 

func (s *DataStore) TemplateVersion() TemplateVersion

type Device 

type Device interface {
	InitialMigration(ctx context.Context) error

	// Exposed to users
	Create(ctx context.Context, orgId uuid.UUID, device *api.Device, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, error)
	Update(ctx context.Context, orgId uuid.UUID, device *api.Device, fieldsToUnset []string, fromAPI bool, validationCallback DeviceStoreValidationCallback, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, device *api.Device, fieldsToUnset []string, fromAPI bool, validationCallback DeviceStoreValidationCallback, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string) (*api.Device, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.DeviceList, error)
	Labels(ctx context.Context, orgId uuid.UUID, listParams ListParams) (api.LabelList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, callback DeviceStoreCallback, eventCallback EventCallback) (bool, error)
	UpdateStatus(ctx context.Context, orgId uuid.UUID, device *api.Device, eventCallback EventCallback) (*api.Device, error)
	GetRendered(ctx context.Context, orgId uuid.UUID, name string, knownRenderedVersion *string, consoleGrpcEndpoint string) (*api.Device, error)

	// Used internally
	UpdateAnnotations(ctx context.Context, orgId uuid.UUID, name string, annotations map[string]string, deleteKeys []string) error
	UpdateRendered(ctx context.Context, orgId uuid.UUID, name, renderedConfig, renderedApplications string) error
	SetServiceConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition, callback ServiceConditionsCallback) error
	OverwriteRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string, repositoryNames ...string) error
	GetRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.RepositoryList, error)

	// Used only by rollout
	Count(ctx context.Context, orgId uuid.UUID, listParams ListParams) (int64, error)
	UnmarkRolloutSelection(ctx context.Context, orgId uuid.UUID, fleetName string) error
	MarkRolloutSelection(ctx context.Context, orgId uuid.UUID, listParams ListParams, limit *int) error
	CompletionCounts(ctx context.Context, orgId uuid.UUID, owner string, templateVersion string, updateTimeout *time.Duration) ([]api.DeviceCompletionCount, error)
	CountByLabels(ctx context.Context, orgId uuid.UUID, listParams ListParams, groupBy []string) ([]map[string]any, error)
	Summary(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.DevicesSummary, error)

	// Used by fleet selector
	ListDevicesByServiceCondition(ctx context.Context, orgId uuid.UUID, conditionType string, conditionStatus string, listParams ListParams) (*api.DeviceList, error)

	// Used by tests
	SetIntegrationTestCreateOrUpdateCallback(IntegrationTestCallback)
}

func NewDevice 

func NewDevice(db *gorm.DB, log logrus.FieldLogger) Device

type DeviceStore 

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

func (*DeviceStore) CompletionCounts added in v0.4.0 

func (s *DeviceStore) CompletionCounts(ctx context.Context, orgId uuid.UUID, owner string, templateVersion string, updateTimeout *time.Duration) ([]api.DeviceCompletionCount, error)

CompletionCounts is used for finding if a rollout batch is complete or to set the success percentage of the batch. The result is a count of devices grouped by some fields: - rendered_template_version: taken from the annotation 'device-controller/renderedTemplateVersion' - summary_status: taken from the field 'status.summary.status' - updating_reason: it is the reason field from a condition having type 'Updating' - same_rendered_version: it is the result of comparison for equality between the annotation 'device-controller/renderedVersion' and the field 'status.config.renderedVersion' - update_timed_out: it is a boolean value indicating if the update of the device has been timed out

func (*DeviceStore) Count added in v0.4.0 

func (s *DeviceStore) Count(ctx context.Context, orgId uuid.UUID, listParams ListParams) (int64, error)

func (*DeviceStore) CountByLabels added in v0.4.0 

func (s *DeviceStore) CountByLabels(ctx context.Context, orgId uuid.UUID, listParams ListParams, groupBy []string) ([]map[string]any, error)

CountByLabels is used for rollout policy disruption budget to provide device count values grouped by the label values.

func (*DeviceStore) Create 

func (s *DeviceStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.Device, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, error)

func (*DeviceStore) CreateOrUpdate 

func (s *DeviceStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.Device, fieldsToUnset []string, fromAPI bool, validationCallback DeviceStoreValidationCallback, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, bool, error)

func (*DeviceStore) Delete 

func (s *DeviceStore) Delete(ctx context.Context, orgId uuid.UUID, name string, callback DeviceStoreCallback, eventCallback EventCallback) (bool, error)

func (*DeviceStore) Get 

func (s *DeviceStore) Get(ctx context.Context, orgId uuid.UUID, name string) (*api.Device, error)

func (*DeviceStore) GetRendered 

func (s *DeviceStore) GetRendered(ctx context.Context, orgId uuid.UUID, name string, knownRenderedVersion *string, consoleGrpcEndpoint string) (*api.Device, error)

func (*DeviceStore) GetRepositoryRefs 

func (s *DeviceStore) GetRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.RepositoryList, error)

func (*DeviceStore) InitialMigration 

func (s *DeviceStore) InitialMigration(ctx context.Context) error

func (*DeviceStore) Labels added in v0.5.0 

func (s *DeviceStore) Labels(ctx context.Context, orgId uuid.UUID, listParams ListParams) (api.LabelList, error)

func (*DeviceStore) List 

func (s *DeviceStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.DeviceList, error)

func (*DeviceStore) ListDevicesByServiceCondition added in v0.9.0 

func (s *DeviceStore) ListDevicesByServiceCondition(ctx context.Context, orgId uuid.UUID, conditionType string, conditionStatus string, listParams ListParams) (*api.DeviceList, error)

func (*DeviceStore) MarkRolloutSelection added in v0.4.0 

func (s *DeviceStore) MarkRolloutSelection(ctx context.Context, orgId uuid.UUID, listParams ListParams, limit *int) error

MarkRolloutSelection marks all devices that can be filtered by the list params. If limit is provided then the number of marked devices will not be greater than the provided limit.

func (*DeviceStore) OverwriteRepositoryRefs 

func (s *DeviceStore) OverwriteRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string, repositoryNames ...string) error

func (*DeviceStore) SetIntegrationTestCreateOrUpdateCallback 

func (s *DeviceStore) SetIntegrationTestCreateOrUpdateCallback(c IntegrationTestCallback)

func (*DeviceStore) SetServiceConditions 

func (s *DeviceStore) SetServiceConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition, callback ServiceConditionsCallback) error

func (*DeviceStore) Summary added in v0.3.0 

func (s *DeviceStore) Summary(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.DevicesSummary, error)

func (*DeviceStore) UnmarkRolloutSelection added in v0.4.0 

func (s *DeviceStore) UnmarkRolloutSelection(ctx context.Context, orgId uuid.UUID, fleetName string) error

UnmarkRolloutSelection unmarks all previously marked devices for rollout in a fleet

func (*DeviceStore) Update added in v0.2.0 

func (s *DeviceStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.Device, fieldsToUnset []string, fromAPI bool, validationCallback DeviceStoreValidationCallback, callback DeviceStoreCallback, eventCallback EventCallback) (*api.Device, error)

func (*DeviceStore) UpdateAnnotations 

func (s *DeviceStore) UpdateAnnotations(ctx context.Context, orgId uuid.UUID, name string, annotations map[string]string, deleteKeys []string) error

func (*DeviceStore) UpdateRendered 

func (s *DeviceStore) UpdateRendered(ctx context.Context, orgId uuid.UUID, name, renderedConfig, renderedApplications string) error

func (*DeviceStore) UpdateStatus 

func (s *DeviceStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.Device, eventCallback EventCallback) (*api.Device, error)

type DeviceStoreAllDeletedCallback 

type DeviceStoreAllDeletedCallback func(ctx context.Context, orgId uuid.UUID)

type DeviceStoreCallback 

type DeviceStoreCallback func(ctx context.Context, orgId uuid.UUID, before *api.Device, after *api.Device)

type DeviceStoreValidationCallback added in v0.4.0 

type DeviceStoreValidationCallback func(ctx context.Context, before *api.Device, after *api.Device) error

type EnrollmentRequest 

type EnrollmentRequest interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, req *api.EnrollmentRequest, callbackEvent EventCallback) (*api.EnrollmentRequest, error)
	Update(ctx context.Context, orgId uuid.UUID, req *api.EnrollmentRequest, callbackEvent EventCallback) (*api.EnrollmentRequest, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, enrollmentrequest *api.EnrollmentRequest, callbackEvent EventCallback) (*api.EnrollmentRequest, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string) (*api.EnrollmentRequest, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.EnrollmentRequestList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, callbackEvent EventCallback) error
	UpdateStatus(ctx context.Context, orgId uuid.UUID, enrollmentrequest *api.EnrollmentRequest, callbackEvent EventCallback) (*api.EnrollmentRequest, error)
}

func NewEnrollmentRequest 

func NewEnrollmentRequest(db *gorm.DB, log logrus.FieldLogger) EnrollmentRequest

type EnrollmentRequestStore 

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

func (*EnrollmentRequestStore) Create 

func (s *EnrollmentRequestStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.EnrollmentRequest, eventCallback EventCallback) (*api.EnrollmentRequest, error)

func (*EnrollmentRequestStore) CreateOrUpdate 

func (s *EnrollmentRequestStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.EnrollmentRequest, eventCallback EventCallback) (*api.EnrollmentRequest, bool, error)

func (*EnrollmentRequestStore) Delete 

func (s *EnrollmentRequestStore) Delete(ctx context.Context, orgId uuid.UUID, name string, eventCallback EventCallback) error

func (*EnrollmentRequestStore) Get 

func (s *EnrollmentRequestStore) Get(ctx context.Context, orgId uuid.UUID, name string) (*api.EnrollmentRequest, error)

func (*EnrollmentRequestStore) InitialMigration 

func (s *EnrollmentRequestStore) InitialMigration(ctx context.Context) error

func (*EnrollmentRequestStore) List 

func (s *EnrollmentRequestStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.EnrollmentRequestList, error)

func (*EnrollmentRequestStore) Update added in v0.4.0 

func (s *EnrollmentRequestStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.EnrollmentRequest, eventCallback EventCallback) (*api.EnrollmentRequest, error)

func (*EnrollmentRequestStore) UpdateStatus 

func (s *EnrollmentRequestStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.EnrollmentRequest, callbackEvent EventCallback) (*api.EnrollmentRequest, error)

type Event added in v0.7.0 

type Event interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, event *api.Event) error
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.EventList, error)
	DeleteOlderThan(ctx context.Context, cutoffTime time.Time) (int64, error)
}

func NewEvent added in v0.7.0 

func NewEvent(db *gorm.DB, log logrus.FieldLogger) Event

type EventCallback added in v0.9.0 

type EventCallback func(ctx context.Context, resourceKind api.ResourceKind, orgId uuid.UUID, name string, oldResource, newResource interface{}, created bool, err error)

type EventCallbackCaller added in v0.9.0 

type EventCallbackCaller func(ctx context.Context, callbackEvent EventCallback, orgId uuid.UUID, name string, oldResource, newResource interface{}, created bool, err error)

type EventStore added in v0.7.0 

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

func (*EventStore) Create added in v0.7.0 

func (s *EventStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.Event) error

func (*EventStore) DeleteOlderThan added in v0.7.0 

func (s *EventStore) DeleteOlderThan(ctx context.Context, cutoffTime time.Time) (int64, error)

DeleteEventsOlderThan deletes events older than the provided timestamp

func (*EventStore) InitialMigration added in v0.7.0 

func (s *EventStore) InitialMigration(ctx context.Context) error

func (*EventStore) List added in v0.7.0 

func (s *EventStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.EventList, error)

type Fleet 

type Fleet interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, fleet *api.Fleet, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, error)
	Update(ctx context.Context, orgId uuid.UUID, fleet *api.Fleet, fieldsToUnset []string, fromAPI bool, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, fleet *api.Fleet, fieldsToUnset []string, fromAPI bool, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string, opts ...GetOption) (*api.Fleet, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams, opts ...ListOption) (*api.FleetList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, callback FleetStoreCallback, eventCallback EventCallback) error
	UpdateStatus(ctx context.Context, orgId uuid.UUID, fleet *api.Fleet) (*api.Fleet, error)

	ListRolloutDeviceSelection(ctx context.Context, orgId uuid.UUID) (*api.FleetList, error)
	ListDisruptionBudgetFleets(ctx context.Context, orgId uuid.UUID) (*api.FleetList, error)
	UnsetOwner(ctx context.Context, tx *gorm.DB, orgId uuid.UUID, owner string) error
	UnsetOwnerByKind(ctx context.Context, tx *gorm.DB, orgId uuid.UUID, resourceKind string) error
	UpdateConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition, eventCallback EventCallback) error
	UpdateAnnotations(ctx context.Context, orgId uuid.UUID, name string, annotations map[string]string, deleteKeys []string, eventCallback EventCallback) error
	OverwriteRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string, repositoryNames ...string) error
	GetRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.RepositoryList, error)
}

func NewFleet 

func NewFleet(db *gorm.DB, log logrus.FieldLogger) Fleet

type FleetStore 

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

func (*FleetStore) Create 

func (s *FleetStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.Fleet, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, error)

func (*FleetStore) CreateOrUpdate 

func (s *FleetStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.Fleet, fieldsToUnset []string, fromAPI bool, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, bool, error)

func (*FleetStore) Delete 

func (s *FleetStore) Delete(ctx context.Context, orgId uuid.UUID, name string, callback FleetStoreCallback, eventCallback EventCallback) error

func (*FleetStore) Get 

func (s *FleetStore) Get(ctx context.Context, orgId uuid.UUID, name string, opts ...GetOption) (*api.Fleet, error)

func (*FleetStore) GetRepositoryRefs 

func (s *FleetStore) GetRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.RepositoryList, error)

func (*FleetStore) InitialMigration 

func (s *FleetStore) InitialMigration(ctx context.Context) error

func (*FleetStore) List 

func (s *FleetStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams, opts ...ListOption) (*api.FleetList, error)

func (*FleetStore) ListDisruptionBudgetFleets added in v0.4.0 

func (s *FleetStore) ListDisruptionBudgetFleets(ctx context.Context, orgId uuid.UUID) (*api.FleetList, error)

ListDisruptionBudgetFleets attempts to get fleets for disruption budget. Since the disruption budget acts like a gate to device rendering, the query searches for fleets that each contains at least 1 device that has different value set between tha annotation 'device-controller/templateVersion' which is set before rollout and 'device-controller/renderedTemplateVersion' which is set after rollout.

func (*FleetStore) ListIgnoreOrg 

func (s *FleetStore) ListIgnoreOrg(ctx context.Context) ([]model.Fleet, error)

A method to get all Fleets regardless of ownership. Used internally by the DeviceUpdater. TODO: Add pagination, perhaps via gorm scopes.

func (*FleetStore) ListRolloutDeviceSelection added in v0.4.0 

func (s *FleetStore) ListRolloutDeviceSelection(ctx context.Context, orgId uuid.UUID) (*api.FleetList, error)

ListRolloutDeviceSelection attempts to get all relevant fleets for rollout device selection. A relevant fleet contains at least 1 device that at least one of the conditions below is true: - marked as selected for rollout - the template version of the fleet is not the same the template version in the annotation 'device-controller/renderedTemplateVersion' - the field 'status.config.renderedVersion' is not the same as the annotation 'device-controller/renderedVersion'

func (*FleetStore) OverwriteRepositoryRefs 

func (s *FleetStore) OverwriteRepositoryRefs(ctx context.Context, orgId uuid.UUID, name string, repositoryNames ...string) error

func (*FleetStore) UnsetOwner 

func (s *FleetStore) UnsetOwner(ctx context.Context, tx *gorm.DB, orgId uuid.UUID, owner string) error

func (*FleetStore) UnsetOwnerByKind 

func (s *FleetStore) UnsetOwnerByKind(ctx context.Context, tx *gorm.DB, orgId uuid.UUID, resourceKind string) error

func (*FleetStore) Update added in v0.2.0 

func (s *FleetStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.Fleet, fieldsToUnset []string, fromAPI bool, callback FleetStoreCallback, eventCallback EventCallback) (*api.Fleet, error)

func (*FleetStore) UpdateAnnotations 

func (s *FleetStore) UpdateAnnotations(ctx context.Context, orgId uuid.UUID, name string, annotations map[string]string, deleteKeys []string, eventCallback EventCallback) error

func (*FleetStore) UpdateConditions 

func (s *FleetStore) UpdateConditions(ctx context.Context, orgId uuid.UUID, name string, conditions []api.Condition, eventCallback EventCallback) error

func (*FleetStore) UpdateStatus 

func (s *FleetStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.Fleet) (*api.Fleet, error)

type FleetStoreAllDeletedCallback 

type FleetStoreAllDeletedCallback func(ctx context.Context, orgId uuid.UUID)

type FleetStoreCallback 

type FleetStoreCallback func(ctx context.Context, orgId uuid.UUID, before *api.Fleet, after *api.Fleet)

type GenericStore added in v0.4.0 

type GenericStore[P extInt[M], M Model, A any, AL any] struct {

	// Callback for integration tests to inject logic
	IntegrationTestCreateOrUpdateCallback IntegrationTestCallback
	// contains filtered or unexported fields
}

func NewGenericStore added in v0.4.0 

func NewGenericStore[P extInt[M], M Model, A any, AL any](
	db *gorm.DB,
	log logrus.FieldLogger,
	apiToModelPtr func(*A) (P, error),
	modelPtrToAPI func(P, ...model.APIResourceOption) (*A, error),
	listModelToAPI func([]M, *string, *int64) (AL, error),
) *GenericStore[P, M, A, AL]

func (*GenericStore[P, M, A, AL]) Create added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) Create(ctx context.Context, orgId uuid.UUID, resource *A, callback func(ctx context.Context, orgId uuid.UUID, before, after *A)) (*A, error)

func (*GenericStore[P, M, A, AL]) CreateOrUpdate added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *A, fieldsToUnset []string, fromAPI bool, validationCallback func(ctx context.Context, before, after *A) error, callback func(ctx context.Context, orgId uuid.UUID, before, after *A)) (*A, *A, bool, error)

func (*GenericStore[P, M, A, AL]) Delete added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) Delete(ctx context.Context, resource M, callback func(ctx context.Context, orgId uuid.UUID, before, after *A), associatedResources ...Resource) (bool, error)

func (*GenericStore[P, M, A, AL]) Get added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) Get(ctx context.Context, orgId uuid.UUID, name string) (*A, error)

func (*GenericStore[P, M, A, AL]) List added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*AL, error)

func (*GenericStore[P, M, A, AL]) Update added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) Update(ctx context.Context, orgId uuid.UUID, resource *A, fieldsToUnset []string, fromAPI bool, validationCallback func(ctx context.Context, before, after *A) error, callback func(ctx context.Context, orgId uuid.UUID, before, after *A)) (*A, *A, error)

func (*GenericStore[P, M, A, AL]) UpdateStatus added in v0.4.0 

func (s *GenericStore[P, M, A, AL]) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *A) (*A, error)

type GetOption 

type GetOption func(*getOptions)

func GetWithDeviceSummary added in v0.4.0 

func GetWithDeviceSummary(val bool) GetOption

type IntegrationTestCallback 

type IntegrationTestCallback func()

type ListOption 

type ListOption func(*listOptions)

func ListWithDevicesSummary added in v0.4.0 

func ListWithDevicesSummary(val bool) ListOption

type ListParams 

type ListParams struct {
	Limit              int
	Continue           *Continue
	FieldSelector      *selector.FieldSelector
	LabelSelector      *selector.LabelSelector
	AnnotationSelector *selector.AnnotationSelector
	SortOrder          *SortOrder
	SortColumns        []SortColumn
}

type ListQueryOption added in v0.5.0 

type ListQueryOption func(*listQuery)

func WithSelectorResolver added in v0.5.0 

func WithSelectorResolver(resolver selector.Resolver) ListQueryOption

type Model added in v0.4.0 

type Model interface {
	model.CertificateSigningRequest | model.Device | model.EnrollmentRequest | model.Fleet | model.Repository | model.ResourceSync | model.TemplateVersion | model.Event
}

GenericStore provides generic CRUD operations for resources P is a pointer to a model, for example: *model.Device M is the model, for example: model.Device A is the API resource, for example: api.Device AL is the API list, for example: api.DeviceList

type Organization added in v0.9.0 

type Organization interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, org *model.Organization) (*model.Organization, error)
	List(ctx context.Context) ([]*model.Organization, error)
	GetByID(ctx context.Context, id uuid.UUID) (*model.Organization, error)
}

func NewOrganization added in v0.9.0 

func NewOrganization(db *gorm.DB) Organization

type OrganizationStore added in v0.9.0 

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

func (*OrganizationStore) Create added in v0.9.0 

func (s *OrganizationStore) Create(ctx context.Context, org *model.Organization) (*model.Organization, error)

func (*OrganizationStore) GetByID added in v0.9.0 

func (s *OrganizationStore) GetByID(ctx context.Context, id uuid.UUID) (*model.Organization, error)

func (*OrganizationStore) InitialMigration added in v0.9.0 

func (s *OrganizationStore) InitialMigration(ctx context.Context) error

func (*OrganizationStore) List added in v0.9.0 

func (s *OrganizationStore) List(ctx context.Context) ([]*model.Organization, error)

type Repository 

type Repository interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, repository *api.Repository, callback RepositoryStoreCallback, callbackEvent EventCallback) (*api.Repository, error)
	Update(ctx context.Context, orgId uuid.UUID, repository *api.Repository, callback RepositoryStoreCallback, callbackEvent EventCallback) (*api.Repository, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, repository *api.Repository, callback RepositoryStoreCallback, callbackEvent EventCallback) (*api.Repository, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string) (*api.Repository, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.RepositoryList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, callback RepositoryStoreCallback, callbackEvent EventCallback) error
	UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.Repository, callbackEvent EventCallback) (*api.Repository, error)

	GetFleetRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.FleetList, error)
	GetDeviceRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.DeviceList, error)
}

func NewRepository 

func NewRepository(db *gorm.DB, log logrus.FieldLogger) Repository

type RepositoryStore 

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

func (*RepositoryStore) Create 

func (s *RepositoryStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.Repository, callback RepositoryStoreCallback, eventCallback EventCallback) (*api.Repository, error)

func (*RepositoryStore) CreateOrUpdate 

func (s *RepositoryStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.Repository, callback RepositoryStoreCallback, eventCallback EventCallback) (*api.Repository, bool, error)

func (*RepositoryStore) Delete 

func (s *RepositoryStore) Delete(ctx context.Context, orgId uuid.UUID, name string, callback RepositoryStoreCallback, eventCallback EventCallback) error

func (*RepositoryStore) Get 

func (s *RepositoryStore) Get(ctx context.Context, orgId uuid.UUID, name string) (*api.Repository, error)

func (*RepositoryStore) GetDeviceRefs 

func (s *RepositoryStore) GetDeviceRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.DeviceList, error)

func (*RepositoryStore) GetFleetRefs 

func (s *RepositoryStore) GetFleetRefs(ctx context.Context, orgId uuid.UUID, name string) (*api.FleetList, error)

func (*RepositoryStore) GetInternal 

func (s *RepositoryStore) GetInternal(ctx context.Context, orgId uuid.UUID, name string) (*model.Repository, error)

func (*RepositoryStore) InitialMigration 

func (s *RepositoryStore) InitialMigration(ctx context.Context) error

func (*RepositoryStore) List 

func (s *RepositoryStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.RepositoryList, error)

func (*RepositoryStore) ListIgnoreOrg 

func (s *RepositoryStore) ListIgnoreOrg(ctx context.Context) ([]model.Repository, error)

A method to get all Repositories with secrets, regardless of ownership. Used internally by the RepoTester. TODO: Add pagination, perhaps via gorm scopes.

func (*RepositoryStore) Update added in v0.2.0 

func (s *RepositoryStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.Repository, callback RepositoryStoreCallback, eventCallback EventCallback) (*api.Repository, error)

func (*RepositoryStore) UpdateStatus added in v0.6.0 

func (s *RepositoryStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.Repository, eventCallback EventCallback) (*api.Repository, error)

type RepositoryStoreAllDeletedCallback 

type RepositoryStoreAllDeletedCallback func(context.Context, uuid.UUID)

type RepositoryStoreCallback 

type RepositoryStoreCallback func(context.Context, uuid.UUID, *api.Repository, *api.Repository)

type Resource added in v0.4.0 

type Resource struct {
	Table string
	OrgID string
	Name  string
}

type ResourceSync 

type ResourceSync interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, resourceSync *api.ResourceSync, callbackEvent EventCallback) (*api.ResourceSync, error)
	Update(ctx context.Context, orgId uuid.UUID, resourceSync *api.ResourceSync, callbackEvent EventCallback) (*api.ResourceSync, error)
	CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resourceSync *api.ResourceSync, callbackEvent EventCallback) (*api.ResourceSync, bool, error)
	Get(ctx context.Context, orgId uuid.UUID, name string) (*api.ResourceSync, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.ResourceSyncList, error)
	Delete(ctx context.Context, orgId uuid.UUID, name string, callback removeOwnerCallback, callbackEvent EventCallback) error
	UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.ResourceSync, eventCallback EventCallback) (*api.ResourceSync, error)
}

func NewResourceSync 

func NewResourceSync(db *gorm.DB, log logrus.FieldLogger) ResourceSync

type ResourceSyncStore 

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

func (*ResourceSyncStore) Create 

func (s *ResourceSyncStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.ResourceSync, eventCallback EventCallback) (*api.ResourceSync, error)

func (*ResourceSyncStore) CreateOrUpdate 

func (s *ResourceSyncStore) CreateOrUpdate(ctx context.Context, orgId uuid.UUID, resource *api.ResourceSync, eventCallback EventCallback) (*api.ResourceSync, bool, error)

func (*ResourceSyncStore) Delete 

func (s *ResourceSyncStore) Delete(ctx context.Context, orgId uuid.UUID, name string, callback removeOwnerCallback, callbackEvent EventCallback) error

func (*ResourceSyncStore) Get 

func (s *ResourceSyncStore) Get(ctx context.Context, orgId uuid.UUID, name string) (*api.ResourceSync, error)

func (*ResourceSyncStore) InitialMigration 

func (s *ResourceSyncStore) InitialMigration(ctx context.Context) error

func (*ResourceSyncStore) List 

func (s *ResourceSyncStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.ResourceSyncList, error)

func (*ResourceSyncStore) Update added in v0.2.0 

func (s *ResourceSyncStore) Update(ctx context.Context, orgId uuid.UUID, resource *api.ResourceSync, eventCallback EventCallback) (*api.ResourceSync, error)

func (*ResourceSyncStore) UpdateStatus added in v0.6.0 

func (s *ResourceSyncStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.ResourceSync, eventCallback EventCallback) (*api.ResourceSync, error)

type ServiceConditionsCallback added in v0.9.0 

type ServiceConditionsCallback func(ctx context.Context, orgId uuid.UUID, device *api.Device, oldConditions, newConditions []api.Condition)

type SortColumn added in v0.8.1 

type SortColumn string

type SortOrder added in v0.3.0 

type SortOrder string

type StatusCount 

type StatusCount struct {
	Category      string
	StatusSummary string
	Count         int64
}

type StatusCountList added in v0.3.0 

type StatusCountList []StatusCount

func CountStatusList added in v0.3.0 

func CountStatusList(ctx context.Context, query *gorm.DB, status ...string) (StatusCountList, error)

func (StatusCountList) List added in v0.3.0 

func (s StatusCountList) List(status string) map[string]int64

type Store 

type Store interface {
	Device() Device
	EnrollmentRequest() EnrollmentRequest
	CertificateSigningRequest() CertificateSigningRequest
	Fleet() Fleet
	TemplateVersion() TemplateVersion
	Repository() Repository
	ResourceSync() ResourceSync
	Event() Event
	Checkpoint() Checkpoint
	Organization() Organization
	RunMigrations(context.Context) error
	Close() error
}

func NewStore 

func NewStore(db *gorm.DB, log logrus.FieldLogger) Store

func PrepareDBForUnitTests 

func PrepareDBForUnitTests(ctx context.Context, log *logrus.Logger) (Store, *config.Config, string, *gorm.DB)

type TemplateVersion 

type TemplateVersion interface {
	InitialMigration(ctx context.Context) error

	Create(ctx context.Context, orgId uuid.UUID, templateVersion *api.TemplateVersion, callback TemplateVersionStoreCallback, eventCallback EventCallback) (*api.TemplateVersion, error)
	Get(ctx context.Context, orgId uuid.UUID, fleet string, name string) (*api.TemplateVersion, error)
	List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.TemplateVersionList, error)
	Delete(ctx context.Context, orgId uuid.UUID, fleet string, name string, eventCallback EventCallback) (bool, error)

	GetLatest(ctx context.Context, orgId uuid.UUID, fleet string) (*api.TemplateVersion, error)
	UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.TemplateVersion, valid *bool, callback TemplateVersionStoreCallback) error
}

func NewTemplateVersion 

func NewTemplateVersion(db *gorm.DB, log logrus.FieldLogger) TemplateVersion

type TemplateVersionStore 

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

func (*TemplateVersionStore) Create 

func (s *TemplateVersionStore) Create(ctx context.Context, orgId uuid.UUID, resource *api.TemplateVersion, callback TemplateVersionStoreCallback, eventCallback EventCallback) (*api.TemplateVersion, error)

func (*TemplateVersionStore) Delete 

func (s *TemplateVersionStore) Delete(ctx context.Context, orgId uuid.UUID, fleet string, name string, eventCallback EventCallback) (bool, error)

func (*TemplateVersionStore) Get 

func (s *TemplateVersionStore) Get(ctx context.Context, orgId uuid.UUID, fleet string, name string) (*api.TemplateVersion, error)

func (*TemplateVersionStore) GetLatest added in v0.4.0 

func (s *TemplateVersionStore) GetLatest(ctx context.Context, orgId uuid.UUID, fleet string) (*api.TemplateVersion, error)

func (*TemplateVersionStore) InitialMigration 

func (s *TemplateVersionStore) InitialMigration(ctx context.Context) error

func (*TemplateVersionStore) List 

func (s *TemplateVersionStore) List(ctx context.Context, orgId uuid.UUID, listParams ListParams) (*api.TemplateVersionList, error)

func (*TemplateVersionStore) UpdateStatus 

func (s *TemplateVersionStore) UpdateStatus(ctx context.Context, orgId uuid.UUID, resource *api.TemplateVersion, valid *bool, callback TemplateVersionStoreCallback) error

type TemplateVersionStoreCallback 

type TemplateVersionStoreCallback func(context.Context, uuid.UUID, *api.TemplateVersion, *api.TemplateVersion)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.