ctf

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

Repository CommonTransportFormat - Filesystem based OCM Repositories

Synopsis
type: CommonTransportFormat/v1
Description

The content of an OCM repository will be stored on a filesystem.

Supported specification version is v1.

Specification Versions
Version v1

The type specific specification fields are:

  • filePath string

    Path in filesystem used to host the repository.

  • fileFormat (optional) string

    The format to use to store content:

    • directory: stored as directory structure
    • tar: stored as directory structure in a tar file
    • tgz: stored as directory structure in a tar file compressed by GNU Zip.
Go Bindings

The Go binding can be found here.

Documentation

Index

Constants

View Source
const (
	ACC_CREATE   = accessobj.ACC_CREATE
	ACC_WRITABLE = accessobj.ACC_WRITABLE
	ACC_READONLY = accessobj.ACC_READONLY
)
View Source
const Type = ctf.Type

Variables

View Source
var (
	FormatDirectory = ctf.FormatDirectory
	FormatTAR       = ctf.FormatTAR
	FormatTGZ       = ctf.FormatTGZ
)

Functions

func Create

func Create(ctx cpi.ContextProvider, acc accessobj.AccessMode, path string, mode vfs.FileMode, opts ...accessio.Option) (cpi.Repository, error)

func GetFormats

func GetFormats() []string

func NewRepositorySpec

func NewRepositorySpec(acc accessobj.AccessMode, path string, opts ...accessio.Option) (*genericocireg.RepositorySpec, error)

func Open

func RepositoryPrefix added in v0.3.0

func RepositoryPrefix(path string) accessio.Option

RepositoryPrefix set the OCI repository prefix used to store the component versions.

func SupportedFormats

func SupportedFormats() []accessio.FileFormat

Types

type CTFOption added in v0.3.0

type CTFOption interface {
	accessio.Option
	ApplyCTFOption(opts *CTFOptions)
}

type CTFOptions added in v0.3.0

type CTFOptions struct {
	genericocireg.ComponentRepositoryMeta
}

type FormatHandler

type FormatHandler = ctf.FormatHandler

func GetFormat

func GetFormat(name accessio.FileFormat) FormatHandler

type Object

type Object = ctf.Object

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL