util

Documentation

Index

• Constants
• Variables
• func BToInt32(v []byte) uint32
• func BToInt64(v []byte) uint64
• func ConfigLogger() (ctx context.Context)
• func ConfigLoggerWithLevel(level string) (ctx context.Context)
• func ExportToJsonFile(v interface{}, p string) error
• func FindProjectRoot() string
• func GetEtcConfigPath() string
• func GetRandomId(prefix string) string
• func Int32ToB(v uint32) []byte
• func Int64ToB(v uint64) []byte
• func NewStarlightLayer(f *os.File, stargzWriter *common.Writer) (goreg.Layer, error)
• func OpenDatabase(ctx context.Context, dbPath string) (*bolt.DB, error)
• func VersionAction(context *cli.Context) error
• func VersionCommand() *cli.Command
• type Convertor
  • func NewConvertor(ctx context.Context, src, dst string, optsSrc, dstSrc []name.Option, ...) (c *Convertor, err error)
  • func (c *Convertor) GetDst() name.Reference
  • func (c *Convertor) GetSrc() name.Reference
  • func (c *Convertor) String() string
  • func (c *Convertor) ToStarlightImage() (err error)
• type CountWriter
  • func NewCountWriter(w io.Writer) (cw *CountWriter)
  • func (c *CountWriter) GetWrittenSize() int64
  • func (c *CountWriter) Write(p []byte) (n int, err error)
• type DigestWriter
  • func NewDigestWriter(w io.Writer) (dw *DigestWriter)
  • func (d *DigestWriter) GetDigest() []byte
  • func (d *DigestWriter) Write(p []byte) (n int, err error)
• type StarlightLayer
  • func (l StarlightLayer) Compressed() (io.ReadCloser, error)
  • func (l StarlightLayer) DiffID() (goreg.Hash, error)
  • func (l StarlightLayer) Digest() (goreg.Hash, error)
  • func (l StarlightLayer) MediaType() (types.MediaType, error)
  • func (l StarlightLayer) Size() (int64, error)
  • func (l StarlightLayer) Uncompressed() (io.ReadCloser, error)

Constants

const (
	ImageNameLabel     = "containerd.io/snapshot/remote/starlight/imageName.label"
	ImageTagLabel      = "containerd.io/snapshot/remote/starlight/imageTag.label"
	OptimizeLabel      = "containerd.io/snapshot/remote/starlight/optimize.label"
	OptimizeGroupLabel = "containerd.io/snapshot/remote/starlight/optimizeGroup.label"

	ProxyLabel       = "containerd.io/snapshot/remote/starlight/proxy"
	SnapshotterLabel = "containerd.io/gc.ref.snapshot.starlight"

	UserRwLayerText = "containerd.io/layer/user-rw-layer"

	StarlightTOCDigestAnnotation       = "containerd.io/snapshot/remote/starlight/toc.digest"
	StarlightTOCCreationTimeAnnotation = "containerd.io/snapshot/remote/starlight/toc.timestamp"

	// ImageMediaTypeManifestV2 for containerd image TYPE field
	ImageMediaTypeManifestV2 = "application/vnd.docker.distribution.manifest.v2+json"

	// ImageLabelPuller and ImageLabelStarlightMetadata are labels for containerd image
	ImageLabelPuller            = "puller.containerd.io"
	ImageLabelStarlightMetadata = "metadata.starlight.mc256.dev"

	// ContentLabelStarlightMediaType is the media type of the content, can be manifest, config, or starlight
	ContentLabelStarlightMediaType = "mediaType.starlight.mc256.dev"
	// ContentLabelContainerdGC prevents containerd from removing the content
	ContentLabelContainerdGC = "containerd.io/gc.ref.content"
	ContentLabelSnapshotGC   = "containerd.io/gc.ref.snapshot.starlight"
	ContentLabelCompletion   = "complete.starlight.mc256.dev"

	// ---------------------------------------------------------------------------------
	// Snapshot labels have a prefix of "containerd.io/snapshot/"
	// or are the "containerd.io/snapshot.ref" label.
	// SnapshotLabelRefImage is the digest of the image manifest
	SnapshotLabelRefImage        = "containerd.io/snapshot/starlight.ref.image"
	SnapshotLabelRefUncompressed = "containerd.io/snapshot/starlight.ref.uncompressed"
	SnapshotLabelRefLayer        = "containerd.io/snapshot/starlight.ref.layer"

	// find the project root directory
	ProjectIdentifier = "module github.com/mc256/starlight"
)

Variables

var Version = "0.0.0"

Functions

func BToInt32

func BToInt32(v []byte) uint32

func BToInt64

func BToInt64(v []byte) uint64

func ConfigLogger

func ConfigLogger() (ctx context.Context)

func ConfigLoggerWithLevel

func ConfigLoggerWithLevel(level string) (ctx context.Context)

func ExportToJsonFile

func ExportToJsonFile(v interface{}, p string) error

func FindProjectRoot

func FindProjectRoot() string

FindProjectRoot returns the root directory of the Git project if exists. otherwise, it returns os.Getwd(). To identify whether a directory is a root directory, it check the `go.mod` file please making sure the first line of the go mode file is: ``` module github.com/mc256/starlight ```

func GetEtcConfigPath

func GetEtcConfigPath() string

GetEtcConfigPath return a path to the configuration json

func GetRandomId

func GetRandomId(prefix string) string

func Int32ToB

func Int32ToB(v uint32) []byte

func Int64ToB

func Int64ToB(v uint64) []byte

func NewStarlightLayer

func NewStarlightLayer(f *os.File, stargzWriter *common.Writer) (goreg.Layer, error)

NewStarlightLayer mainly populate the hash values for the StarlightLayer object

func OpenDatabase

func OpenDatabase(ctx context.Context, dbPath string) (*bolt.DB, error)

func VersionAction

func VersionAction(context *cli.Context) error

func VersionCommand

func VersionCommand() *cli.Command

Types

type Convertor

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

func NewConvertor

func NewConvertor(ctx context.Context, src, dst string, optsSrc, dstSrc []name.Option, optsRemote []remote.Option, platforms string) (c *Convertor, err error)

func (*Convertor) GetDst

func (c *Convertor) GetDst() name.Reference

func (*Convertor) GetSrc

func (c *Convertor) GetSrc() name.Reference

func (*Convertor) String

func (c *Convertor) String() string

func (*Convertor) ToStarlightImage

func (c *Convertor) ToStarlightImage() (err error)

type CountWriter

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

func NewCountWriter

func NewCountWriter(w io.Writer) (cw *CountWriter)

func (*CountWriter) GetWrittenSize

func (c *CountWriter) GetWrittenSize() int64

func (*CountWriter) Write

func (c *CountWriter) Write(p []byte) (n int, err error)

type DigestWriter

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

func NewDigestWriter

func NewDigestWriter(w io.Writer) (dw *DigestWriter)

func (*DigestWriter) GetDigest

func (d *DigestWriter) GetDigest() []byte

func (*DigestWriter) Write

func (d *DigestWriter) Write(p []byte) (n int, err error)

type StarlightLayer

type StarlightLayer struct {
	R io.Reader

	// Diff is the hash of the uncompressed layer
	Diff goreg.Hash
	// Hash is the hash of the compressed layer
	Hash goreg.Hash

	SizeVal int64
}

func (StarlightLayer) Compressed

func (l StarlightLayer) Compressed() (io.ReadCloser, error)

func (StarlightLayer) DiffID

func (l StarlightLayer) DiffID() (goreg.Hash, error)

func (StarlightLayer) Digest

func (l StarlightLayer) Digest() (goreg.Hash, error)

func (StarlightLayer) MediaType

func (l StarlightLayer) MediaType() (types.MediaType, error)

func (StarlightLayer) Size

func (l StarlightLayer) Size() (int64, error)

func (StarlightLayer) Uncompressed

func (l StarlightLayer) Uncompressed() (io.ReadCloser, error)