ctf

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

• Variables
• func Create(ctx cpi.Context, acc accessobj.AccessMode, path string, mode vfs.FileMode, ...) (cpi.Repository, error)
• func GetFormats() []string
• func NewRepositorySpec(acc accessobj.AccessMode, path string, opts ...accessio.Option) (*genericocireg.RepositorySpec, error)
• func Open(ctx cpi.Context, acc accessobj.AccessMode, path string, mode vfs.FileMode, ...) (cpi.Repository, error)
• func SupportedFormats() []accessio.FileFormat
• type FormatHandler
  • func GetFormat(name accessio.FileFormat) FormatHandler
• type Object

Variables

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

Functions

func Create

func Create(ctx cpi.Context, 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 Open(ctx cpi.Context, acc accessobj.AccessMode, path string, mode vfs.FileMode, opts ...accessio.Option) (cpi.Repository, error)

func SupportedFormats

func SupportedFormats() []accessio.FileFormat

Types

type FormatHandler

type FormatHandler = ctf.FormatHandler

func GetFormat

func GetFormat(name accessio.FileFormat) FormatHandler

type Object

type Object = ctf.Object