v1

Documentation

Index

• Constants
• func InstallApp(ctx context.Context, app compose.App, provider compose.BlobProvider, ...) error
• func MakeAkliteHappy(ctx context.Context, store compose.AppStore, app compose.App, ...) error
• func NewAppLoader() compose.AppLoader
• func NewAppStore(root string, platform ocispec.Platform, skopeoStoreAware ...bool) (compose.AppStore, error)
• func NewDefaultConfig(options ...ConfigOpt) (*compose.Config, error)
• func ReadAppManifest(ctx context.Context, provider compose.BlobProvider, ref string) (*appCtx, *ocispec.Descriptor, error)
• type ConfigOpt
  • func WithComposeRoot(composeRoot string) ConfigOpt
  • func WithConnectTimeout(timeout time.Duration) ConfigOpt
  • func WithSkopeoSupport(skopeoSupport bool) ConfigOpt
  • func WithStoreRoot(storeRoot string) ConfigOpt
  • func WithUpdateDB(dbPath string) ConfigOpt
• type ConfigOpts
• type StoreType

Constants

const (
	AppManifestMediaType   = "application/vnd.oci.image.manifest.v1+json"
	AppManifestMaxSize     = 50 * 1024
	AppComposeMaxSize      = 1024 * 1024
	AppBundleFileMaxSize   = 1024*1024*1024 - AppComposeMaxSize
	AppBundleMaxSize       = AppComposeMaxSize + AppBundleFileMaxSize
	AppLayerMediaType      = "application/octet-stream"
	AppLayersMetaVersion   = "v1"
	AppServiceHashLabelKey = "io.compose-spec.config-hash"

	AnnotationKeyAppBundleIndexDigest = "org.foundries.app.bundle.index.digest"
	AnnotationKeyAppBundleIndexSize   = "org.foundries.app.bundle.index.size"

	StoreTypeSkopeo     = "skopeo store"
	StoreTypeComposeCtl = "composectl store"
)

const (
	DefaultRootDir        = ".composeapps"
	DefaultStoreDir       = "store"
	DefaultComposeDir     = "projects"
	DefaultConnectTimeout = time.Duration(120) * time.Second
	DefaultReadTimeout    = time.Duration(900) * time.Second
	DefaultDBFileName     = "updates.db"
)

const (
	BlobProviderTypeAppStore compose.BlobProviderType = "blob-provider:app-store"
)

Functions

func InstallApp

func InstallApp(ctx context.Context, app compose.App, provider compose.BlobProvider, blobRoot string, composeRoot string, dockerHost string) error

func MakeAkliteHappy

func MakeAkliteHappy(ctx context.Context, store compose.AppStore, app compose.App, platformMatcher platforms.MatchComparer) error

func NewAppLoader

func NewAppLoader() compose.AppLoader

func NewAppStore

func NewAppStore(root string, platform ocispec.Platform, skopeoStoreAware ...bool) (compose.AppStore, error)

func NewDefaultConfig

func NewDefaultConfig(options ...ConfigOpt) (*compose.Config, error)

func ReadAppManifest

func ReadAppManifest(ctx context.Context, provider compose.BlobProvider, ref string) (*appCtx, *ocispec.Descriptor, error)

Types

type ConfigOpt

type ConfigOpt func(*ConfigOpts)

func WithComposeRoot

func WithComposeRoot(composeRoot string) ConfigOpt

func WithConnectTimeout

func WithConnectTimeout(timeout time.Duration) ConfigOpt

func WithSkopeoSupport

func WithSkopeoSupport(skopeoSupport bool) ConfigOpt

func WithStoreRoot

func WithStoreRoot(storeRoot string) ConfigOpt

func WithUpdateDB

func WithUpdateDB(dbPath string) ConfigOpt

type ConfigOpts

type ConfigOpts struct {
	StoreRoot      string
	ComposeRoot    string
	ConnectTimeout time.Duration
	ReadTimeout    time.Duration
	SkopeoSupport  bool
	UpdateDBPath   string
}

type StoreType

type StoreType string