Documentation
¶
Index ¶
- func SortDirectories(directories []Directory)
- type Annotation
- type Directory
- type DirectoryMetadata
- type Image
- func (image *Image) ForEachObject(objectFunc func(hash.Hash) error) error
- func (image *Image) GetMissingObjects(objectServer objectserver.ObjectServer, ...) error
- func (image *Image) ListMissingObjects(objectsChecker objectserver.ObjectsChecker) ([]hash.Hash, error)
- func (image *Image) ListObjects() []hash.Hash
- func (image *Image) RegisterStrings(registerFunc func(string))
- func (image *Image) ReplaceStrings(replaceFunc func(string) string)
- func (image *Image) Verify() error
- func (image *Image) VerifyObjects(checker objectserver.ObjectsChecker) error
- func (image *Image) VerifyRequiredPaths(requiredPaths map[string]rune) error
- type Package
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SortDirectories ¶
func SortDirectories(directories []Directory)
Types ¶
type Annotation ¶
type Directory ¶
type Directory struct {
Name string
Metadata DirectoryMetadata
}
type DirectoryMetadata ¶
type DirectoryMetadata struct {
OwnerGroup string
}
type Image ¶
type Image struct {
BuildBranch string
BuildCommitId string
BuildGitUrl string
CreatedBy string // Username. Set by imageserver. Empty: unauthenticated
CreatedFor string // Username. Set by imaginator.
Filter *filter.Filter
FileSystem *filesystem.FileSystem
Triggers *triggers.Triggers
ReleaseNotes *Annotation
BuildLog *Annotation
CreatedOn time.Time
ExpiresAt time.Time
Packages []Package
SourceImage string // Name of source image.
Tags tags.Tags
}
func (*Image) ForEachObject ¶
ForEachObject will call objectFunc for all objects (including those for annotations) for the image. If objectFunc returns a non-nil error, processing stops and the error is returned.
func (*Image) GetMissingObjects ¶
func (image *Image) GetMissingObjects(objectServer objectserver.ObjectServer, objectsGetter objectserver.ObjectsGetter, logger log.DebugLogger) error
GetMissingObjects will check if objectServer has all the objects for the image and if any are missing it will download them from objectsGetter and add them to objectServer.
func (*Image) ListMissingObjects ¶
func (image *Image) ListMissingObjects( objectsChecker objectserver.ObjectsChecker) ([]hash.Hash, error)
func (*Image) ListObjects ¶
ListObjects will return a list of all objects (including those for annotations for an image).
func (*Image) RegisterStrings ¶ added in v0.3.3
func (*Image) ReplaceStrings ¶
func (*Image) Verify ¶
Verify will perform some self-consistency checks on the image. If a problem is found, an error is returned.
func (*Image) VerifyObjects ¶
func (image *Image) VerifyObjects(checker objectserver.ObjectsChecker) error
func (*Image) VerifyRequiredPaths ¶
VerifyRequiredPaths will verify if required paths are present in the image. The table of required paths is given by requiredPaths. If the image is a sparse image (has no filter), then this check is skipped. If a problem is found, an error is returned. This function will create cache data associated with the image, consuming more memory.