Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.9.4

Aug 13, 2026

Changes in this version

+ const MissingState

type Storage

+ func (s Storage) RolloutStateFor(tag, updateName, rolloutName, status string) ([]string, error)

+ func (s Storage) RolloutSummary(tag, updateName, rolloutName string) (*UpdateSummary, error)

+ func (s Storage) UpdateStateFor(tag, updateName, status string) ([]string, error)

+ func (s Storage) UpdateSummary(tag, name string) (*UpdateSummary, error)

+ type UpdateSummary struct

+ Status map[string]int

v0.9.3

Jul 24, 2026

Changes in this version

+ var ErrUpdateInUse = storage.ErrUpdateInUse

type Storage

+ func (s Storage) DeleteUpdate(tag, name string) error

+ func (s Storage) DeviceCreate(uuid, pubkey string, labels Labels) error

v0.9.2

Jul 14, 2026

Changes in this version

+ const ConfigHistoryLimit

+ const ConfigSotaOverride

+ const OrderByDeviceCreatedAsc

+ const OrderByDeviceCreatedDsc

+ const OrderByDeviceLastSeenAsc

+ const OrderByDeviceLastSeenDsc

+ const OrderByDeviceNameAsc

+ const OrderByDeviceNameDesc

+ const OrderByDeviceUuidAsc

+ const OrderByDeviceUuidDesc

+ var DbFile = storage.DbFile

+ var ErrDbConstraintUnique = storage.ErrDbConstraintUnique

+ var ErrInvalidUpdate = storage.ErrInvalidUpdate

+ var IsDbError = storage.IsDbError

+ var NewDb = storage.NewDb

+ var NewFs = storage.NewFs

+ var TestIdRegex = storage.TestIdRegex

+ var ValidCorrelationId = storage.ValidCorrelationId

+ type AppliedConfigs = storage.AppliedConfigs

+ type AppsStates = storage.AppsStates

+ type ConfigFile = storage.ConfigFile

+ type ConfigFileSet = storage.ConfigFileSet

+ type Device struct

+ Aktoml string

+ Apps []string

+ HwInfo string

+ NetInfo string

+ OstreeHash string

+ PubKey string

+ Status *DeviceStatus

+ UpdateName string

+ func (d *Device) GetTest(testId string) (*TargetTest, error)

+ func (d *Device) GetTestArtifact(testId, name string) (io.ReadCloser, error)

+ func (d *Device) GetTests() ([]TargetTest, error)

+ func (d Device) AppsStates() ([]AppsStates, error)

+ func (d Device) Delete() error

+ func (d Device) Events(updateId string) ([]DeviceUpdateEvent, error)

+ func (d Device) Updates() ([]string, error)

+ type DeviceListItem struct

+ CreatedAt int64

+ Labels Labels

+ LastSeen int64

+ Tag string

+ Target string

+ Uuid string

+ type DeviceListOpts struct

+ Limit int

+ Offset int

+ OrderBy OrderBy

+ type DeviceStatus = storage.DeviceStatus

+ type DeviceUpdateEvent = storage.DeviceUpdateEvent

+ type ErrConfigUploadBroken = storage.ErrConfigUploadBroken

+ type FsHandle = storage.FsHandle

+ type Labels map[string]string

+ type OrderBy string

+ type Rollout struct

+ Commit bool

+ Effect []string

+ Groups []string

+ Uuids []string

+ type Storage struct

+ func NewStorage(db *storage.DbHandle, fs *storage.FsHandle) (*Storage, error)

+ func (s Storage) CommitRollout(tag, updateName, rolloutName string, rollout Rollout) (err error)

+ func (s Storage) CreateRollout(tag, updateName, rolloutName string, rollout Rollout) error

+ func (s Storage) CreateUpdate(tag, updateName, uploadedBy string, opts TargetOptions, payload io.Reader) error

+ func (s Storage) DeniedDevicesList() ([]string, error)

+ func (s Storage) DeviceGet(uuid string) (*Device, error)

+ func (s Storage) DevicesList(opts DeviceListOpts) ([]DeviceListItem, int, error)

+ func (s Storage) GenerateTufMeta(tufDir string, opts TargetOptions) error

+ func (s Storage) GetKnownDeviceGroupNames() ([]string, error)

+ func (s Storage) GetKnownDeviceLabelNames() ([]string, error)

+ func (s Storage) GetRollout(tag, updateName, rolloutName string) (res Rollout, err error)

+ func (s Storage) GetTufRoot(version int) ([]byte, error)

+ func (s Storage) GetUpdateTufMetadata(tag, updateName string) (map[string]map[string]any, error)

+ func (s Storage) InsertUpdate(tag, name, uploadedBy string) error

+ func (s Storage) ListRollouts(tag, updateName string) ([]string, error)

+ func (s Storage) ListUpdates(tag string) (map[string][]Update, error)

+ func (s Storage) PatchDeviceLabels(labels map[string]*string, uuids []string) error

+ func (s Storage) ReadAppliedConfigs(uuid string) (*storage.AppliedConfigs, error)

+ func (s Storage) ReadDeviceConfigHistory(uuid string, latest int, withFiles bool) ([]*ConfigFileSet, error)

+ func (s Storage) ReadFactoryConfigHistory(latest int, withFiles bool) ([]*ConfigFileSet, error)

+ func (s Storage) ReadGroupConfigHistory(name string, latest int, withFiles bool) ([]*ConfigFileSet, error)

+ func (s Storage) ReadRolloutJournal() iter.Seq2[*[3]string, error]

+ func (s Storage) RefreshTufTimestamps(c context.Context) error

+ func (s Storage) RolloverRolloutJournal() error

+ func (s Storage) SaveDeviceConfig(uuid, content, username, reason string) error

+ func (s Storage) SaveFactoryConfig(content, username, reason string) error

+ func (s Storage) SaveGroupConfig(name, content, username, reason string) error

+ func (s Storage) SaveRollout(tag, updateName, rolloutName string, rollout Rollout) error

+ func (s Storage) SetUpdateName(tag, updateName string, uuids, groups []string) (effectiveUuids []string, err error)

+ func (s Storage) TailRolloutsLog(tag, updateName string, stop storage.DoneChan) iter.Seq2[string, error]

+ func (s Storage) UndenyDevice(uuid string) (bool, error)

+ func (s Storage) UploadConfigs(payload io.Reader) (err error)

+ type TargetOptions struct

+ AppVersion int

+ Apps map[string]string

+ BaseUrl string

+ HardwareId string

+ Name string

+ OstreeHash string

+ Tag string

+ type TargetTest = storage.TargetTest

+ type Update = storage.Update