predicate

Documentation

Index

• Variables
• func Not(p predicate.Predicate) predicate.Predicate

Variables

var HasName = func(name string) predicate.Predicate {
	return predicate.NewPredicateFuncs(func(obj client.Object) bool {
		return name == obj.GetName()
	})
}

HasName is predicate.Predicate that returns true if the specified client.Object has the desired name.

var InNamespace = func(namespace string) predicate.Predicate {
	return predicate.NewPredicateFuncs(func(obj client.Object) bool {
		return namespace == obj.GetNamespace()
	})
}

InNamespace is a predicate.Predicate that returns true if the specified client.Object is in the desired namespace.

var InstallModePredicate = func(config etc.Config) (predicate.Predicate, error) {
	mode, operatorNamespace, targetNamespaces, err := config.ResolveInstallMode()
	if err != nil {
		return nil, err
	}
	return predicate.NewPredicateFuncs(func(obj client.Object) bool {
		if mode == etc.SingleNamespace {
			return targetNamespaces[0] == obj.GetNamespace() &&
				operatorNamespace != obj.GetNamespace()
		}

		if mode == etc.MultiNamespace {
			return ext.SliceContainsString(targetNamespaces, obj.GetNamespace())
		}

		if mode == etc.AllNamespaces && strings.TrimSpace(config.ExcludeNamespaces) != "" {
			namespaces := strings.Split(config.ExcludeNamespaces, ",")
			for _, namespace := range namespaces {
				matches, err := filepath.Match(strings.TrimSpace(namespace), obj.GetNamespace())
				if err != nil {

					return true
				}
				if matches {
					return false
				}
			}
		}

		return true
	}), nil
}

InstallModePredicate is a predicate.Predicate that determines whether to reconcile the specified client.Object based on the give etc.InstallMode.

In etc.SingleNamespace install mode we're configuring client.Client cache to watch the operator namespace, in which the operator runs scan jobs. However, we do not want to scan the workloads that might run in the operator namespace.

Similarly, in etc.MultiNamespace install mode we're configuring client.Client cache to watch the operator namespace, in which the operator runs scan jobs. However, we do not want to scan the workloads that might run in the operator namespace unless the operator namespace is added to the list of target namespaces.

var IsBeingTerminated = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	return obj.GetDeletionTimestamp() != nil
})

IsBeingTerminated is a predicate.Predicate that returns true if the specified client.Object is being terminated, i.e. its DeletionTimestamp property is set to non nil value.

var IsConfigAuditReportScan = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if _, ok := obj.GetLabels()[starboard.LabelConfigAuditReportScanner]; ok {
		return true
	}
	return false
})

var IsKubeBenchReportScan = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if _, ok := obj.GetLabels()[starboard.LabelKubeBenchReportScanner]; ok {
		return true
	}
	return false
})

var IsLeaderElectionResource = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if _, ok := obj.GetAnnotations()[resourcelock.LeaderElectionRecordAnnotationKey]; ok {
		return true
	}
	return false
})

IsLeaderElectionResource returns true for resources used in leader election, means resources annotated with resourcelock.LeaderElectionRecordAnnotationKey.

var IsLinuxNode = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if os, exists := obj.GetLabels()[corev1.LabelOSStable]; exists && os == "linux" {
		return true
	}
	return false
})

var IsVulnerabilityReportScan = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if _, ok := obj.GetLabels()[starboard.LabelVulnerabilityReportScanner]; ok {
		return true
	}
	return false
})

var JobHasAnyCondition = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if job, ok := obj.(*batchv1.Job); ok {
		return len(job.Status.Conditions) > 0
	}
	return false
})

JobHasAnyCondition is a predicate.Predicate that returns true if the specified client.Object is a v1.Job with any v1.JobConditionType.

var ManagedByStarboardOperator = predicate.NewPredicateFuncs(func(obj client.Object) bool {
	if managedBy, ok := obj.GetLabels()[starboard.LabelK8SAppManagedBy]; ok {
		return managedBy == starboard.AppStarboard
	}
	return false
})

ManagedByStarboardOperator is a predicate.Predicate that returns true if the specified client.Object is managed by Starboard.

For example, pods controlled by jobs scheduled by Starboard Operator are labeled with `app.kubernetes.io/managed-by=starboard`.

Functions

func Not

func Not(p predicate.Predicate) predicate.Predicate