util

Documentation

Index

• Constants
• Variables
• func AdoptObject(obj client.Object, systemNamespace, bundleDeploymentName string)
• func BundleDeploymentProvisionerFilter(provisionerClassName string) predicate.Predicate
• func BundleProvisionerFilter(provisionerClassName string) predicate.Predicate
• func CheckDesiredBundleTemplate(existingBundle *rukpakv1alpha1.Bundle, ...) bool
• func CheckExistingBundlesMatchesTemplate(existingBundles *rukpakv1alpha1.BundleList, ...) *rukpakv1alpha1.Bundle
• func CreateOrRecreate(ctx context.Context, cl client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)
• func DeepHashObject(hasher hash.Hash, objectToWrite interface{})
• func EnsureBaseDirFS(fsys fs.FS, defaultBaseDir string) (fs.FS, error)
• func FSToTarGZ(w io.Writer, fsys fs.FS) error
• func GenerateBundleName(bdName, hash string) string
• func GenerateTemplateHash(template *rukpakv1alpha1.BundleTemplate) string
• func GetBundlesForBundleDeploymentSelector(ctx context.Context, c client.Client, bd *rukpakv1alpha1.BundleDeployment) (*rukpakv1alpha1.BundleList, error)
• func LoadCertPool(certFile string) (*x509.CertPool, error)
• func MapBundleDeploymentToBundles(ctx context.Context, c client.Client, bd rukpakv1alpha1.BundleDeployment) *rukpakv1alpha1.BundleList
• func MapBundleToBundleDeployment(ctx context.Context, c client.Client, b rukpakv1alpha1.Bundle) *rukpakv1alpha1.BundleDeployment
• func MapBundleToBundleDeploymentHandler(ctx context.Context, cl client.Client, log logr.Logger, ...) handler.MapFunc
• func MapOwneeToOwnerProvisionerHandler(ctx context.Context, cl client.Client, log logr.Logger, ...) handler.EventHandler
• func MergeMaps(maps ...map[string]string) map[string]string
• func NewBundleDeploymentLabelSelector(bd *rukpakv1alpha1.BundleDeployment) labels.Selector
• func NewBundleLabelSelector(bundle *rukpakv1alpha1.Bundle) labels.Selector
• func PodNamespace(defaultNamespace string) string
• func ReconcileDesiredBundle(ctx context.Context, c client.Client, bd *rukpakv1alpha1.BundleDeployment) (*rukpakv1alpha1.Bundle, *rukpakv1alpha1.BundleList, error)
• func SortBundlesByCreation(bundles *rukpakv1alpha1.BundleList)
• type FilesOnlyFilesystem
  • func (f *FilesOnlyFilesystem) Open(name string) (fs.File, error)
• type ProvisionerClassNameGetter

Constants

const (
	CoreOwnerKindKey          = "core.rukpak.io/owner-kind"
	CoreOwnerNameKey          = "core.rukpak.io/owner-name"
	CoreBundleTemplateHashKey = "core.rukpak.io/bundle-template-hash"
)

Variables

var (
	// ErrMaxGeneratedLimit is the error returned by the BundleDeployment controller
	// when the configured maximum number of Bundles that match a label selector
	// has been reached.
	ErrMaxGeneratedLimit = errors.New("reached the maximum generated Bundle limit")
)

Functions

func AdoptObject

func AdoptObject(obj client.Object, systemNamespace, bundleDeploymentName string)

AdoptObject sets metadata on an object to associate that object with a bundle deployment, such that it could be adopted by that bundle deployment.

The systemNamespace is the namespace in which the provisioner managing the objects is running. And the bundleDeployment name is the name of the bundle deployment that should adopt the provided object.

This function does _not_ apply the changes to a cluster, so callers must apply the updates themselves.

NOTE: This function is designed specifically for the current helm-based implementation of the plain provisioner, and will track the plain provisioner's implementation. Should the plain provisioner change it's underlying mechanism for associating bundle deployments to managed objects, this implementation will also change.

func BundleDeploymentProvisionerFilter

func BundleDeploymentProvisionerFilter(provisionerClassName string) predicate.Predicate

func BundleProvisionerFilter

func BundleProvisionerFilter(provisionerClassName string) predicate.Predicate

func CheckDesiredBundleTemplate

func CheckDesiredBundleTemplate(existingBundle *rukpakv1alpha1.Bundle, desiredBundle *rukpakv1alpha1.BundleTemplate) bool

CheckDesiredBundleTemplate is responsible for determining whether the existingBundle hash is equal to the desiredBundle Bundle template hash.

func CheckExistingBundlesMatchesTemplate

func CheckExistingBundlesMatchesTemplate(existingBundles *rukpakv1alpha1.BundleList, desiredBundleTemplate *rukpakv1alpha1.BundleTemplate) *rukpakv1alpha1.Bundle

CheckExistingBundlesMatchesTemplate evaluates whether the existing list of Bundle objects match the desired Bundle template that's specified in a BundleDeployment object. If a match is found, that Bundle object is returned, so callers are responsible for nil checking the result.

func CreateOrRecreate

func CreateOrRecreate(ctx context.Context, cl client.Client, obj client.Object, f controllerutil.MutateFn) (controllerutil.OperationResult, error)

func DeepHashObject

func DeepHashObject(hasher hash.Hash, objectToWrite interface{})

DeepHashObject writes specified object to hash using the spew library which follows pointers and prints actual values of the nested objects ensuring the hash does not change when a pointer changes. From https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/lib/kubernetes/pkg/util/hash/hash.go

func EnsureBaseDirFS

func EnsureBaseDirFS(fsys fs.FS, defaultBaseDir string) (fs.FS, error)

EnsureBaseDirFS ensures that an fs.FS contains a single directory in its root This is useful for bundle formats that require a base directory in the root of the bundle.

For example, an unpacked Helm chart might have <chartDir>/Chart.yaml, and we'd typically assume <chartDir> as the bundle root. However, when helm archives contain <chartDir> at the root of the archive: <archiveRoot>/<chartDir>/Chart.yaml.

If the fs.FS already has this structure, EnsureBaseDirFS just returns fsys directly. Otherwise, it returns a new fs.FS where the defaultBaseDir is inserted at the root, such that fsys appears within defaultBaseDir.

func FSToTarGZ

func FSToTarGZ(w io.Writer, fsys fs.FS) error

FSToTarGZ writes the filesystem represented by fsys to w as a gzipped tar archive. This function unsets user and group information in the tar archive so that readers of archives produced by this function do not need to account for differences in permissions between source and destination filesystems.

func GenerateBundleName

func GenerateBundleName(bdName, hash string) string

func GenerateTemplateHash

func GenerateTemplateHash(template *rukpakv1alpha1.BundleTemplate) string

func GetBundlesForBundleDeploymentSelector

func GetBundlesForBundleDeploymentSelector(ctx context.Context, c client.Client, bd *rukpakv1alpha1.BundleDeployment) (*rukpakv1alpha1.BundleList, error)

GetBundlesForBundleDeploymentSelector is responsible for returning a list of Bundle resource that exist on cluster that match the label selector specified in the BD parameter's spec.Selector field.

func LoadCertPool

func LoadCertPool(certFile string) (*x509.CertPool, error)

func MapBundleDeploymentToBundles

func MapBundleDeploymentToBundles(ctx context.Context, c client.Client, bd rukpakv1alpha1.BundleDeployment) *rukpakv1alpha1.BundleList

func MapBundleToBundleDeployment

func MapBundleToBundleDeployment(ctx context.Context, c client.Client, b rukpakv1alpha1.Bundle) *rukpakv1alpha1.BundleDeployment

MapBundleToBundleDeployment is responsible for finding the BundleDeployment resource that's managing this Bundle in the cluster. In the case that this Bundle is a standalone resource, then no BundleDeployment will be returned as static creation of Bundle resources is not a supported workflow right now.

func MapBundleToBundleDeploymentHandler

func MapBundleToBundleDeploymentHandler(ctx context.Context, cl client.Client, log logr.Logger, provisionerClassName string) handler.MapFunc

MapBundleToBundleDeploymentHandler is responsible for requeuing a BundleDeployment resource when a new Bundle event has been encountered. In the case that the Bundle resource is a standalone resource, then no BundleDeployment will be returned as static creation of Bundle resources is not a supported workflow right now. The provisionerClassName parameter is used to filter out BundleDeployments that the caller shouldn't be watching.

func MapOwneeToOwnerProvisionerHandler

func MapOwneeToOwnerProvisionerHandler(ctx context.Context, cl client.Client, log logr.Logger, provisionerClassName string, owner ProvisionerClassNameGetter) handler.EventHandler

MapOwneeToOwnerProvisionerHandler is a handler implementation that finds an owner reference in the event object that references the provided owner. If a reference for the provided owner is found AND that owner's provisioner class name matches the provided provisionerClassName, this handler enqueues a request for that owner to be reconciled.

func MergeMaps

func MergeMaps(maps ...map[string]string) map[string]string

func NewBundleDeploymentLabelSelector

func NewBundleDeploymentLabelSelector(bd *rukpakv1alpha1.BundleDeployment) labels.Selector

NewBundleDeploymentLabelSelector is responsible for constructing a label.Selector for any underlying resources that are associated with the BundleDeployment parameter.

func NewBundleLabelSelector

func NewBundleLabelSelector(bundle *rukpakv1alpha1.Bundle) labels.Selector

NewBundleLabelSelector is responsible for constructing a label.Selector for any underlying resources that are associated with the Bundle parameter.

func PodNamespace

func PodNamespace(defaultNamespace string) string

GetPodNamespace checks whether the controller is running in a Pod vs. being run locally by inspecting the namespace file that gets mounted automatically for Pods at runtime. If that file doesn't exist, then return the @defaultNamespace namespace parameter.

func ReconcileDesiredBundle

func ReconcileDesiredBundle(ctx context.Context, c client.Client, bd *rukpakv1alpha1.BundleDeployment) (*rukpakv1alpha1.Bundle, *rukpakv1alpha1.BundleList, error)

reconcileDesiredBundle is responsible for checking whether the desired Bundle resource that's specified in the BundleDeployment parameter's spec.Template configuration is present on cluster, and if not, creates a new Bundle resource matching that desired specification.

func SortBundlesByCreation

func SortBundlesByCreation(bundles *rukpakv1alpha1.BundleList)

SortBundlesByCreation sorts a BundleList's items by it's metadata.CreationTimestamp value.

Types

type FilesOnlyFilesystem

type FilesOnlyFilesystem struct {
	FS fs.FS
}

FilesOnlyFilesystem is an fs.FS implementation that treats non-regular files (e.g. directories, symlinks, devices, etc.) as non-existent. The reason for this is so that we only serve bundle files.

This treats directories as not found so that the http server does not serve HTML directory index responses.

This treats other symlink files as not found so that we prevent HTTP requests from escaping the filesystem root.

Lastly, this treats other non-regular files as not found because they are out of scope for serving bundle contents.

func (*FilesOnlyFilesystem) Open

func (f *FilesOnlyFilesystem) Open(name string) (fs.File, error)

type ProvisionerClassNameGetter

type ProvisionerClassNameGetter interface {
	client.Object
	ProvisionerClassName() string
}