repo

Documentation

Index

• Constants
• func GenerateInstanceID() string
• func IsUnknownVersion(err error) bool
• func IsValidVersion(version int) bool
• type ErrUnknownRepoVersion
  • func NewUnknownRepoVersionError(version int) ErrUnknownRepoVersion
  • func (e ErrUnknownRepoVersion) Error() string
• type FsRepo
  • func NewFS(params FsRepoParams) (*FsRepo, error)
  • func (fsr *FsRepo) EnsureRepoPathsConfigured(c config_legacy.ReadWriter)
  • func (fsr *FsRepo) Exists() (bool, error)
  • func (fsr *FsRepo) Init() error
  • func (fsr *FsRepo) InstanceID() string
  • func (fsr *FsRepo) MustInstanceID() (string, error)
  • func (fsr *FsRepo) Open() error
  • func (fsr *FsRepo) Path() (string, error)
  • func (fsr *FsRepo) ReadLastUpdateCheck() (time.Time, error)
  • func (fsr *FsRepo) ReadLegacyVersion() (int, error)
  • func (fsr *FsRepo) ReadNodeName() (string, error)
  • func (fsr *FsRepo) SystemMetadata() (*SystemMetadata, error)
  • func (fsr *FsRepo) Version() (int, error)
  • func (fsr *FsRepo) WriteLastUpdateCheck(lastUpdateCheck time.Time) error
  • func (fsr *FsRepo) WriteLegacyVersion(version int) error
  • func (fsr *FsRepo) WriteNodeName(name string) error
  • func (fsr *FsRepo) WriteRunInfo(ctx context.Context, summaryShellVariablesString string) (string, error)
  • func (fsr *FsRepo) WriteVersion(version int) error
• type FsRepoParams
• type Migration
  • func NewMigration(fromVersion, toVersion int, migrations ...MigrationFn) Migration
  • func (m Migration) Migrate(repo FsRepo) error
• type MigrationFn
• type MigrationManager
  • func NewMigrationManager(migrations ...Migration) (*MigrationManager, error)
  • func (m *MigrationManager) Add(migration Migration) error
  • func (m *MigrationManager) Migrate(repo FsRepo) error
• type SystemMetadata
  • func LoadSystemMetadata(path string) (*SystemMetadata, error)
• type Version

Constants

const (
	// Version1 is the repo versioning for v1-v1.1.4
	Version1 = iota + 1
	// Version2 is the repo versioning up to v1.2.1
	Version2
	// Version3 is the repo version to (including) v1.4.0
	Version3
	// Version4 is the latest version
	Version4
)

const LegacyVersionFile = "repo.version"

LegacyVersionFile is the name of the repo file containing the repo version. This file is only used in versions 1.4.0 and below. Subsequent bacalhau versions persist the repo version to system_metadata.yaml

const SystemMetadataFile = "system_metadata.yaml"

SystemMetadataFile is the name of the file containing the SystemMetadata.

const UnknownVersion = -1

Functions

func GenerateInstanceID

func GenerateInstanceID() string

GenerateInstanceID creates a unique, anonymous identifier for the instance of bacalhau.

func IsUnknownVersion

func IsUnknownVersion(err error) bool

func IsValidVersion

func IsValidVersion(version int) bool

IsValidVersion returns true if the version is valid.

Types

type ErrUnknownRepoVersion

type ErrUnknownRepoVersion int

func NewUnknownRepoVersionError

func NewUnknownRepoVersionError(version int) ErrUnknownRepoVersion

func (ErrUnknownRepoVersion) Error

func (e ErrUnknownRepoVersion) Error() string

type FsRepo

type FsRepo struct {
	Migrations *MigrationManager
	// contains filtered or unexported fields
}

func NewFS

func NewFS(params FsRepoParams) (*FsRepo, error)

func (*FsRepo) EnsureRepoPathsConfigured

func (fsr *FsRepo) EnsureRepoPathsConfigured(c config_legacy.ReadWriter)

EnsureRepoPathsConfigured modifies the config to include keys for accessing repo paths

func (*FsRepo) Exists

func (fsr *FsRepo) Exists() (bool, error)

Exists returns true if the repo exists and is valid, false otherwise.

func (*FsRepo) Init

func (fsr *FsRepo) Init() error

Init initializes a new repo, returning an error if the repo already exists.

func (*FsRepo) InstanceID

func (fsr *FsRepo) InstanceID() string

InstanceID reads the InstanceID in the metadata. It returns empty string if it fails to read the metadata.

func (*FsRepo) MustInstanceID

func (fsr *FsRepo) MustInstanceID() (string, error)

MustInstanceID reads the InstanceID in the metadata. It fails if the metadata file doesn't exist.

func (*FsRepo) Open

func (fsr *FsRepo) Open() error

Open opens an existing repo, returning an error if the repo is uninitialized.

func (*FsRepo) Path

func (fsr *FsRepo) Path() (string, error)

Path returns the filesystem path to of the repo directory.

func (*FsRepo) ReadLastUpdateCheck

func (fsr *FsRepo) ReadLastUpdateCheck() (time.Time, error)

ReadLastUpdateCheck returns the last update check value from system_metadata.yaml It fails if the metadata file doesn't exist.

func (*FsRepo) ReadLegacyVersion

func (fsr *FsRepo) ReadLegacyVersion() (int, error)

ReadLegacyVersion reads the repo version from the LegacyVersionFile.

func (*FsRepo) ReadNodeName

func (fsr *FsRepo) ReadNodeName() (string, error)

func (*FsRepo) SystemMetadata

func (fsr *FsRepo) SystemMetadata() (*SystemMetadata, error)

func (*FsRepo) Version

func (fsr *FsRepo) Version() (int, error)

Version returns the version of the repo.

func (*FsRepo) WriteLastUpdateCheck

func (fsr *FsRepo) WriteLastUpdateCheck(lastUpdateCheck time.Time) error

WriteLastUpdateCheck updates the LastUpdateCheck in the metadata. It fails if the metadata file doesn't exist.

func (*FsRepo) WriteLegacyVersion

func (fsr *FsRepo) WriteLegacyVersion(version int) error

WriteLegacyVersion writes the repo version to LegacyVersionFile.

func (*FsRepo) WriteNodeName

func (fsr *FsRepo) WriteNodeName(name string) error

func (*FsRepo) WriteRunInfo

func (fsr *FsRepo) WriteRunInfo(ctx context.Context, summaryShellVariablesString string) (string, error)

func (*FsRepo) WriteVersion

func (fsr *FsRepo) WriteVersion(version int) error

WriteVersion updates the RepoVersion in the SystemMetadataFile. If the metadata file doesn't exist, it creates a new one.

type FsRepoParams

type FsRepoParams struct {
	Path       string
	Migrations *MigrationManager
}

type Migration

type Migration struct {
	FromVersion int
	ToVersion   int
	Migrations  []MigrationFn
}

func NewMigration

func NewMigration(fromVersion, toVersion int, migrations ...MigrationFn) Migration

NewMigration creates a new migration.

func (Migration) Migrate

func (m Migration) Migrate(repo FsRepo) error

Migrate runs the migrations on the given repo.

type MigrationFn

type MigrationFn = func(FsRepo) error

type MigrationManager

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

func NewMigrationManager

func NewMigrationManager(migrations ...Migration) (*MigrationManager, error)

NewMigrationManager creates a new migration manager.

func (*MigrationManager) Add

func (m *MigrationManager) Add(migration Migration) error

Add adds a migration to the manager.

func (*MigrationManager) Migrate

func (m *MigrationManager) Migrate(repo FsRepo) error

Migrate runs the migrations on the given repo.

type SystemMetadata

type SystemMetadata struct {
	RepoVersion     int       `yaml:"RepoVersion"`
	InstanceID      string    `yaml:"InstanceID"`
	LastUpdateCheck time.Time `yaml:"LastUpdateCheck"`
	NodeName        string    `yaml:"NodeName"`
}

func LoadSystemMetadata

func LoadSystemMetadata(path string) (*SystemMetadata, error)

type Version

type Version struct {
	Version int
}