ocmutils

Documentation

Index

• Constants
• func Configure(ctxp config.ContextProvider, path string, fss ...vfs.FileSystem) (ocm.Context, error)
• func Configure2(ctx config.ContextProvider, path string, fss ...vfs.FileSystem) (ocm.Context, config.Config, error)
• func ConfigureByData(ctx config.ContextProvider, data []byte, info string) error
• func ConfigureByData2(ctx config.ContextProvider, data []byte, info string) (config.Config, error)
• func GetOCIArtifactRef(ctxp ocm.ContextProvider, r ocm.ResourceAccess) (string, error)
• func GetResourceData(acc ocm.AccessProvider) ([]byte, error)
• func GetResourceDataForPath(cv ocm.ComponentVersionAccess, id metav1.Identity, path []metav1.Identity, ...) ([]byte, error)
• func GetResourceDataForRef(cv ocm.ComponentVersionAccess, ref metav1.ResourceReference, ...) ([]byte, error)
• func GetResourceReader(acc ocm.AccessProvider) (io.ReadCloser, error)
• func GetResourceReaderForPath(cv ocm.ComponentVersionAccess, id metav1.Identity, path []metav1.Identity, ...) (io.ReadCloser, error)
• func GetResourceReaderForRef(cv ocm.ComponentVersionAccess, ref metav1.ResourceReference, ...) (io.ReadCloser, error)
• func Walk[T any](closure common.NameVersionInfo[T], cv ocm.ComponentVersionAccess, ...) (common.NameVersionInfo[T], error)
• type WalkingStep

Constants

const DEFAULT_OCM_CONFIG = ".ocmconfig"

const DEFAULT_OCM_CONFIG_DIR = ".ocm"

Functions

func Configure

func Configure(ctxp config.ContextProvider, path string, fss ...vfs.FileSystem) (ocm.Context, error)

func Configure2

func Configure2(ctx config.ContextProvider, path string, fss ...vfs.FileSystem) (ocm.Context, config.Config, error)

func ConfigureByData

func ConfigureByData(ctx config.ContextProvider, data []byte, info string) error

func ConfigureByData2

func ConfigureByData2(ctx config.ContextProvider, data []byte, info string) (config.Config, error)

func GetOCIArtifactRef

func GetOCIArtifactRef(ctxp ocm.ContextProvider, r ocm.ResourceAccess) (string, error)

func GetResourceData

func GetResourceData(acc ocm.AccessProvider) ([]byte, error)

func GetResourceDataForPath

func GetResourceDataForPath(cv ocm.ComponentVersionAccess, id metav1.Identity, path []metav1.Identity, resolvers ...ocm.ComponentVersionResolver) ([]byte, error)

func GetResourceDataForRef

func GetResourceDataForRef(cv ocm.ComponentVersionAccess, ref metav1.ResourceReference, reslist ...ocm.ComponentVersionResolver) ([]byte, error)

func GetResourceReader

func GetResourceReader(acc ocm.AccessProvider) (io.ReadCloser, error)

func GetResourceReaderForPath

func GetResourceReaderForPath(cv ocm.ComponentVersionAccess, id metav1.Identity, path []metav1.Identity, resolvers ...ocm.ComponentVersionResolver) (io.ReadCloser, error)

func GetResourceReaderForRef

func GetResourceReaderForRef(cv ocm.ComponentVersionAccess, ref metav1.ResourceReference, reslist ...ocm.ComponentVersionResolver) (io.ReadCloser, error)

func Walk

func Walk[T any](closure common.NameVersionInfo[T], cv ocm.ComponentVersionAccess, resolver ocm.ComponentVersionResolver, step WalkingStep[T]) (common.NameVersionInfo[T], error)

Walk traverses a component version graph using the WalkingStep to process found component version.

Types

type WalkingStep

type WalkingStep[T any] func(state common.WalkingState[T, ocm.ComponentVersionAccess], cv ocm.ComponentVersionAccess) (bool, error)

WalkingStep is used to process a component version during graph traversal. If returned true, the traversal process follows local component references. If an error is returned the traversal is aborted with this error. Additionally, an info object of type T can be registered in the state for the component version.