oci

README

OCI

oci is a library for working with OCI images in VanillaOS.

Documentation

Index

• func Digest(image string) (string, error)
• func DigestPath(image string) (string, error)
• func Save(image, basePath string) error
• func Write(image, basePath string) error
• type OCIManifest
  • func Manifest(image string) (OCIManifest, error)

Functions

func Digest

func Digest(image string) (string, error)

Digest returns the sha256 digest of an OCI image as a string

func DigestPath

func DigestPath(image string) (string, error)

DigestPath returns the sha256 digest of an OCI image as a string that has been sanitized for safety as a file name

func Save

func Save(image, basePath string) error

Save creates a tar file in `basePath` with the sanitized `image` sha256 as the file name. This is probably not what you want to extract an image

func Write

func Write(image, basePath string) error

Types

type OCIManifest

type OCIManifest struct {
	SchemaVersion int `json:"schemaVersion"`
	Config        struct {
		MediaType string `json:"mediaType"`
		Digest    string `json:"digest"`
		Size      int    `json:"size"`
	} `json:"config"`
	Layers []struct {
		MediaType string `json:"mediaType"`
		Digest    string `json:"digest"`
		Size      int    `json:"size"`
	} `json:"layers"`
}

func Manifest

func Manifest(image string) (OCIManifest, error)

Manifest returns the container manifest of an OCI image