packages

Documentation

Overview

Package packages provides the facilities to read package directory. And to compile these files into an (Cluster)ObjectDeployment.

Index

• type FolderLoader
  • func NewFolderLoader(scheme *runtime.Scheme) *FolderLoader
  • func (l *FolderLoader) FindManifest(ctx context.Context, rootPath string) (*manifestsv1alpha1.PackageManifest, error)
  • func (l *FolderLoader) Load(ctx context.Context, rootPath string, ...) (res FolderLoaderResult, err error)
  • func (l *FolderLoader) LoadPackageManifest(ctx context.Context, filePath string) (*manifestsv1alpha1.PackageManifest, error)
• type FolderLoaderResult
• type FolderLoaderTemplateContext
• type GenericClusterObjectDeployment
  • func (a *GenericClusterObjectDeployment) ClientObject() client.Object
  • func (a *GenericClusterObjectDeployment) SetSelector(labels map[string]string)
  • func (a *GenericClusterObjectDeployment) SetTemplateSpec(spec corev1alpha1.ObjectSetTemplateSpec)
• type GenericClusterPackage
  • func (a *GenericClusterPackage) ClientObject() client.Object
  • func (a *GenericClusterPackage) GetConditions() *[]metav1.Condition
  • func (a *GenericClusterPackage) Scope() manifestsv1alpha1.PackageManifestScope
  • func (a *GenericClusterPackage) TemplateContext() FolderLoaderTemplateContext
• type GenericObjectDeployment
  • func (a *GenericObjectDeployment) ClientObject() client.Object
  • func (a *GenericObjectDeployment) SetSelector(labels map[string]string)
  • func (a *GenericObjectDeployment) SetTemplateSpec(spec corev1alpha1.ObjectSetTemplateSpec)
• type GenericPackage
  • func (a *GenericPackage) ClientObject() client.Object
  • func (a *GenericPackage) GetConditions() *[]metav1.Condition
  • func (a *GenericPackage) Scope() manifestsv1alpha1.PackageManifestScope
  • func (a *GenericPackage) TemplateContext() FolderLoaderTemplateContext
• type PackageInvalidScopeError
  • func (e *PackageInvalidScopeError) Error() string
• type PackageLoader
  • func NewClusterPackageLoader(c client.Client, scheme *runtime.Scheme) *PackageLoader
  • func NewPackageLoader(c client.Client, scheme *runtime.Scheme) *PackageLoader
  • func (l *PackageLoader) Load(ctx context.Context, packageKey client.ObjectKey, folderPath string) error
• type PackageManifestInvalidError
  • func (e *PackageManifestInvalidError) Error() string
  • func (e *PackageManifestInvalidError) Unwrap() error
• type PackageManifestNotFoundError
  • func (e *PackageManifestNotFoundError) Error() string
• type PackageObjectInvalidError
  • func (e *PackageObjectInvalidError) Error() string
• type PackageTemplateContext

Types

type FolderLoader

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

FolderLoader reads a package as files in the filesystem. Parsing them according to their packaging specification.

func NewFolderLoader

func NewFolderLoader(scheme *runtime.Scheme) *FolderLoader

func (*FolderLoader) FindManifest

func (l *FolderLoader) FindManifest(ctx context.Context, rootPath string) (
	*manifestsv1alpha1.PackageManifest, error,
)

Tries to find the PackageManifest at multiple predetermined locations.

func (*FolderLoader) Load

func (l *FolderLoader) Load(
	ctx context.Context, rootPath string,
	templateContext FolderLoaderTemplateContext,
) (res FolderLoaderResult, err error)

func (*FolderLoader) LoadPackageManifest

func (l *FolderLoader) LoadPackageManifest(ctx context.Context, filePath string) (
	*manifestsv1alpha1.PackageManifest, error,
)

Loads a PackageManifest at the given path. Converts whatever PackageManifest version it finds into an v1alpha1 PackageManifest.

type FolderLoaderResult

type FolderLoaderResult struct {
	Annotations, Labels map[string]string
	TemplateSpec        corev1alpha1.ObjectSetTemplateSpec
	Manifest            *manifestsv1alpha1.PackageManifest
}

Result of a loading operation.

type FolderLoaderTemplateContext

type FolderLoaderTemplateContext struct {
	Package PackageTemplateContext
}

Template Context provided when executing file templates.

type GenericClusterObjectDeployment

type GenericClusterObjectDeployment struct {
	corev1alpha1.ClusterObjectDeployment
}

func (*GenericClusterObjectDeployment) ClientObject

func (a *GenericClusterObjectDeployment) ClientObject() client.Object

func (*GenericClusterObjectDeployment) SetSelector

func (a *GenericClusterObjectDeployment) SetSelector(labels map[string]string)

func (*GenericClusterObjectDeployment) SetTemplateSpec

func (a *GenericClusterObjectDeployment) SetTemplateSpec(spec corev1alpha1.ObjectSetTemplateSpec)

type GenericClusterPackage

type GenericClusterPackage struct {
	corev1alpha1.ClusterPackage
}

func (*GenericClusterPackage) ClientObject

func (a *GenericClusterPackage) ClientObject() client.Object

func (*GenericClusterPackage) GetConditions

func (a *GenericClusterPackage) GetConditions() *[]metav1.Condition

func (*GenericClusterPackage) Scope

func (a *GenericClusterPackage) Scope() manifestsv1alpha1.PackageManifestScope

func (*GenericClusterPackage) TemplateContext

func (a *GenericClusterPackage) TemplateContext() FolderLoaderTemplateContext

type GenericObjectDeployment

type GenericObjectDeployment struct {
	corev1alpha1.ObjectDeployment
}

func (*GenericObjectDeployment) ClientObject

func (a *GenericObjectDeployment) ClientObject() client.Object

func (*GenericObjectDeployment) SetSelector

func (a *GenericObjectDeployment) SetSelector(labels map[string]string)

func (*GenericObjectDeployment) SetTemplateSpec

func (a *GenericObjectDeployment) SetTemplateSpec(spec corev1alpha1.ObjectSetTemplateSpec)

type GenericPackage

type GenericPackage struct {
	corev1alpha1.Package
}

func (*GenericPackage) ClientObject

func (a *GenericPackage) ClientObject() client.Object

func (*GenericPackage) GetConditions

func (a *GenericPackage) GetConditions() *[]metav1.Condition

func (*GenericPackage) Scope

func (a *GenericPackage) Scope() manifestsv1alpha1.PackageManifestScope

func (*GenericPackage) TemplateContext

func (a *GenericPackage) TemplateContext() FolderLoaderTemplateContext

type PackageInvalidScopeError

type PackageInvalidScopeError struct {
	RequiredScope   manifestsv1alpha1.PackageManifestScope
	SupportedScopes []manifestsv1alpha1.PackageManifestScope
}

func (*PackageInvalidScopeError) Error

func (e *PackageInvalidScopeError) Error() string

type PackageLoader

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

PackageLoader loads an ObjectDeployment from file, wraps it into an ObjectDeployment and updates/creates it on the cluster.

func NewClusterPackageLoader

func NewClusterPackageLoader(c client.Client, scheme *runtime.Scheme) *PackageLoader

Returns a new cluster-scoped loader for the ClusterPackage API.

func NewPackageLoader

func NewPackageLoader(c client.Client, scheme *runtime.Scheme) *PackageLoader

Returns a new namespace-scoped loader for the Package API.

func (*PackageLoader) Load

func (l *PackageLoader) Load(ctx context.Context, packageKey client.ObjectKey, folderPath string) error

type PackageManifestInvalidError

type PackageManifestInvalidError struct {
	Reason string
	Err    error // if this error was caused by another error.
}

PackageManifestInvalidError is returned when the found PackageManifest can not be parsed.

func (*PackageManifestInvalidError) Error

func (e *PackageManifestInvalidError) Error() string

func (*PackageManifestInvalidError) Unwrap

func (e *PackageManifestInvalidError) Unwrap() error

type PackageManifestNotFoundError

type PackageManifestNotFoundError struct{}

PackageManifestNotFoundError is returned when no manifest.yml can be found.

func (*PackageManifestNotFoundError) Error

func (e *PackageManifestNotFoundError) Error() string

type PackageObjectInvalidError

type PackageObjectInvalidError struct {
	FilePath string
	Reason   string
}

func (*PackageObjectInvalidError) Error

func (e *PackageObjectInvalidError) Error() string

type PackageTemplateContext

type PackageTemplateContext struct {
	metav1.ObjectMeta
}