pipeline

Documentation

Index

• func Apply(ctx context.Context, input *bundlev1.Bundle, opts ...Option) (*bundlev1.Bundle, error)
• func Run(ctx context.Context, opts ...Option) error
• type ChainProcessorFunc
• type Context
• type FileProcessorFunc
• type KVProcessorFunc
• type Option
  • func ChainProcessor(f ChainProcessorFunc) Option
  • func FileProcessor(f FileProcessorFunc) Option
  • func InputReader(value io.Reader) Option
  • func KVProcessor(f KVProcessorFunc) Option
  • func OutputDisabled() Option
  • func OutputWriter(value io.Writer) Option
  • func PackageProcessor(f PackageProcessorFunc) Option
• type Options
• type PackageProcessorFunc
• type Processor

Functions

func Apply

func Apply(ctx context.Context, input *bundlev1.Bundle, opts ...Option) (*bundlev1.Bundle, error)

Apply a pipeline process to the given bundle.

func Run

func Run(ctx context.Context, opts ...Option) error

Run a processor.

Types

type ChainProcessorFunc

type ChainProcessorFunc func(Context, *bundlev1.SecretChain) error

ChainProcessorFunc describes a secret chain object processor contract.

type Context

type Context interface {
	GetFile() *bundlev1.Bundle
	GetPackage() *bundlev1.Package
	GetSecret() *bundlev1.SecretChain
	GetKeyValue() *bundlev1.KV
}

Context defines tree processing context.

type FileProcessorFunc

type FileProcessorFunc func(Context, *bundlev1.Bundle) error

FileProcessorFunc describes a file object processor contract.

type KVProcessorFunc

type KVProcessorFunc func(Context, *bundlev1.KV) error

KVProcessorFunc describes a kv object processor contract.

type Option

type Option func(*Options)

Option represents option function.

func ChainProcessor

func ChainProcessor(f ChainProcessorFunc) Option

ChainProcessor assign the chain object processor.

func FileProcessor

func FileProcessor(f FileProcessorFunc) Option

FileProcessor assign the file object processor.

func InputReader

func InputReader(value io.Reader) Option

InputReader defines the input reader used to retrieve the bundle content.

func KVProcessor

func KVProcessor(f KVProcessorFunc) Option

KVProcessor assign the KV object processor.

func OutputDisabled

func OutputDisabled() Option

OutputDisabled assign the value to disableOutput option.

func OutputWriter

func OutputWriter(value io.Writer) Option

OutputWriter defines where the bundle will be written after process execution.

func PackageProcessor

func PackageProcessor(f PackageProcessorFunc) Option

PackageProcessor assign the package object processor.

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options defines default options.

type PackageProcessorFunc

type PackageProcessorFunc func(Context, *bundlev1.Package) error

PackageProcessorFunc describes a package object processor contract.

type Processor

type Processor func(context.Context, *bundlev1.Bundle) error

Processor declares a bundle processor contract.