Documentation ¶
Index ¶
- Constants
- func AllocateBucket(c client.Client, log logr.Logger, owner types.NamespacedName, id string, ...) (*storage.ProvisionedBucket, error)
- func AnalyzeError(application *app.FybrikApplication, assetID string, err error)
- func ConstructApplicationContext(datasetID string, input *app.FybrikApplication, operation *pb.AccessOperation) *pb.ApplicationContext
- func CopyMap(m map[string]interface{}) map[string]interface{}
- func GetSupportedReadSources(module *app.FybrikModule) []*app.InterfaceDetails
- func LookupPolicyDecisions(datasetID string, policyManager connectors.PolicyManager, ...) ([]*pb.EnforcementAction, error)
- func SecretToCredentialMap(cl client.Client, secretRef types.NamespacedName) (map[string]interface{}, error)
- func SecretToCredentials(cl client.Client, secretRef types.NamespacedName) (*pb.Credentials, error)
- func SetMapField(obj map[string]interface{}, k string, v interface{}) bool
- type BlueprintReconciler
- type ContextInterface
- type FybrikApplicationReconciler
- func (r *FybrikApplicationReconciler) GenerateBlueprint(instances []modules.ModuleInstanceSpec, appContext *app.FybrikApplication) app.BlueprintSpec
- func (r *FybrikApplicationReconciler) GenerateBlueprints(instances []modules.ModuleInstanceSpec, appContext *app.FybrikApplication) map[string]app.BlueprintSpec
- func (r *FybrikApplicationReconciler) GetAllModules() (map[string]*app.FybrikModule, error)
- func (r *FybrikApplicationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
- func (r *FybrikApplicationReconciler) RefineInstances(instances []modules.ModuleInstanceSpec) []modules.ModuleInstanceSpec
- func (r *FybrikApplicationReconciler) RegisterAsset(catalogID string, info *app.DatasetDetails, input *app.FybrikApplication) (string, error)
- func (r *FybrikApplicationReconciler) SetupWithManager(mgr ctrl.Manager) error
- type ModuleManager
- func (m *ModuleManager) GetCopyDestination(item modules.DataInfo, destinationInterface *app.InterfaceDetails, geo string) (*app.DataStore, error)
- func (m *ModuleManager) GetProcessingGeography(applicationContext *app.FybrikApplication) (string, error)
- func (m *ModuleManager) SelectModuleInstances(item modules.DataInfo, appContext *app.FybrikApplication) ([]modules.ModuleInstanceSpec, error)
- type NewAssetInfo
- type PlotterInterface
- func (c *PlotterInterface) CreateOrUpdateResource(owner *app.ResourceReference, ref *app.ResourceReference, ...) error
- func (c *PlotterInterface) CreateResourceReference(owner *app.ResourceReference) *app.ResourceReference
- func (c *PlotterInterface) DeleteResource(ref *app.ResourceReference) error
- func (c *PlotterInterface) GetManagedObject() runtime.Object
- func (c *PlotterInterface) GetResourceSignature(ref *app.ResourceReference) *app.Plotter
- func (c *PlotterInterface) GetResourceStatus(ref *app.ResourceReference) (app.ObservedState, error)
- func (c *PlotterInterface) ResourceExists(ref *app.ResourceReference) bool
- type PlotterReconciler
Constants ¶
const BlueprintNamespace = "fybrik-blueprints"
BlueprintNamespace defines a namespace where blueprints and associated resources will be allocated
Variables ¶
This section is empty.
Functions ¶
func AllocateBucket ¶
func AllocateBucket(c client.Client, log logr.Logger, owner types.NamespacedName, id string, geo string) (*storage.ProvisionedBucket, error)
AllocateBucket allocates a bucket in the relevant geo The buckets are created as temporary, i.e. to be removed after the owner Dataset is deleted After a successful copy and registering a dataset, the bucket will become persistent
func AnalyzeError ¶
func AnalyzeError(application *app.FybrikApplication, assetID string, err error)
AnalyzeError analyzes whether the given error is fatal, or a retrial attempt can be made. Reasons for retrial can be either communication problems with external services, or kubernetes problems to perform some action on a resource. A retrial is achieved by returning an error to the reconcile method
func ConstructApplicationContext ¶
func ConstructApplicationContext(datasetID string, input *app.FybrikApplication, operation *pb.AccessOperation) *pb.ApplicationContext
ConstructApplicationContext constructs ApplicationContext structure to send to Policy Compiler
func GetSupportedReadSources ¶
func GetSupportedReadSources(module *app.FybrikModule) []*app.InterfaceDetails
GetSupportedReadSources returns a list of supported READ interfaces of a module
func LookupPolicyDecisions ¶
func LookupPolicyDecisions(datasetID string, policyManager connectors.PolicyManager, input *app.FybrikApplication, op *pb.AccessOperation) ([]*pb.EnforcementAction, error)
LookupPolicyDecisions provides a list of governance actions for the given dataset and the given operation
func SecretToCredentialMap ¶
func SecretToCredentialMap(cl client.Client, secretRef types.NamespacedName) (map[string]interface{}, error)
SecretToCredentialMap fetches a secret and converts into a map matching credentials proto
func SecretToCredentials ¶
func SecretToCredentials(cl client.Client, secretRef types.NamespacedName) (*pb.Credentials, error)
SecretToCredentials fetches a secret and constructs Credentials structure
func SetMapField ¶
SetMapField updates a map
Types ¶
type BlueprintReconciler ¶
type BlueprintReconciler struct { client.Client Name string Log logr.Logger Scheme *runtime.Scheme Helmer helm.Interface }
BlueprintReconciler reconciles a Blueprint object
func NewBlueprintReconciler ¶
func NewBlueprintReconciler(mgr ctrl.Manager, name string, helmer helm.Interface) *BlueprintReconciler
NewBlueprintReconciler creates a new reconciler for Blueprint resources
func (*BlueprintReconciler) SetupWithManager ¶
func (r *BlueprintReconciler) SetupWithManager(mgr ctrl.Manager) error
SetupWithManager registers Blueprint controller
type ContextInterface ¶
type ContextInterface interface { ResourceExists(ref *app.ResourceReference) bool CreateOrUpdateResource(owner *app.ResourceReference, ref *app.ResourceReference, blueprintPerClusterMap map[string]app.BlueprintSpec) error DeleteResource(ref *app.ResourceReference) error GetResourceStatus(ref *app.ResourceReference) (app.ObservedState, error) CreateResourceReference(owner *app.ResourceReference) *app.ResourceReference GetManagedObject() runtime.Object }
ContextInterface is an interface for communication with a generated resource (e.g. Blueprint)
type FybrikApplicationReconciler ¶
type FybrikApplicationReconciler struct { client.Client Name string Log logr.Logger Scheme *runtime.Scheme PolicyManager connectors.PolicyManager DataCatalog connectors.DataCatalog ResourceInterface ContextInterface ClusterManager multicluster.ClusterLister Provision storage.ProvisionInterface }
FybrikApplicationReconciler reconciles a FybrikApplication object
func NewFybrikApplicationReconciler ¶
func NewFybrikApplicationReconciler(mgr ctrl.Manager, name string, policyManager connectors.PolicyManager, catalog connectors.DataCatalog, cm multicluster.ClusterLister, provision storage.ProvisionInterface) *FybrikApplicationReconciler
NewFybrikApplicationReconciler creates a new reconciler for FybrikApplications
func (*FybrikApplicationReconciler) GenerateBlueprint ¶
func (r *FybrikApplicationReconciler) GenerateBlueprint(instances []modules.ModuleInstanceSpec, appContext *app.FybrikApplication) app.BlueprintSpec
GenerateBlueprint creates the Blueprint spec based on the datasets and the governance actions required, which dictate the modules that must run in the fybrik Credentials for accessing data set are stored in a credential management system (such as vault) and the paths for accessing them are included in the blueprint. The credentials themselves are not included in the blueprint.
func (*FybrikApplicationReconciler) GenerateBlueprints ¶
func (r *FybrikApplicationReconciler) GenerateBlueprints(instances []modules.ModuleInstanceSpec, appContext *app.FybrikApplication) map[string]app.BlueprintSpec
GenerateBlueprints creates Blueprint specs (one per cluster)
func (*FybrikApplicationReconciler) GetAllModules ¶
func (r *FybrikApplicationReconciler) GetAllModules() (map[string]*app.FybrikModule, error)
GetAllModules returns all CRDs of the kind FybrikModule mapped by their name
func (*FybrikApplicationReconciler) Reconcile ¶
func (r *FybrikApplicationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
Reconcile reconciles FybrikApplication CRD It receives FybrikApplication CRD and selects the appropriate modules that will run The outcome is either a single Blueprint running on the same cluster or a Plotter containing multiple Blueprints that may run on different clusters
func (*FybrikApplicationReconciler) RefineInstances ¶
func (r *FybrikApplicationReconciler) RefineInstances(instances []modules.ModuleInstanceSpec) []modules.ModuleInstanceSpec
RefineInstances collects all instances of the same read/write module and creates a new instance instead, with accumulated arguments. Copy modules are left unchanged.
func (*FybrikApplicationReconciler) RegisterAsset ¶
func (r *FybrikApplicationReconciler) RegisterAsset(catalogID string, info *app.DatasetDetails, input *app.FybrikApplication) (string, error)
RegisterAsset registers a new asset in the specified catalog Input arguments: - catalogID: the destination catalog identifier - info: connection and credential details Returns: - an error if happened - the new asset identifier
func (*FybrikApplicationReconciler) SetupWithManager ¶
func (r *FybrikApplicationReconciler) SetupWithManager(mgr ctrl.Manager) error
SetupWithManager registers FybrikApplication controller
type ModuleManager ¶
type ModuleManager struct { Client client.Client Log logr.Logger Modules map[string]*app.FybrikModule Clusters []multicluster.Cluster Owner types.NamespacedName PolicyManager connectors.PolicyManager WorkloadGeography string Provision storage.ProvisionInterface VaultConnection vault.Interface ProvisionedStorage map[string]NewAssetInfo }
ModuleManager builds a set of modules based on the requirements (governance actions, data location) and the existing set of FybrikModules
func (*ModuleManager) GetCopyDestination ¶
func (m *ModuleManager) GetCopyDestination(item modules.DataInfo, destinationInterface *app.InterfaceDetails, geo string) (*app.DataStore, error)
GetCopyDestination creates a Dataset for bucket allocation by implicit copies or ingest.
func (*ModuleManager) GetProcessingGeography ¶
func (m *ModuleManager) GetProcessingGeography(applicationContext *app.FybrikApplication) (string, error)
GetProcessingGeography determines the geography of the workload cluster. If no cluster has been specified for a workload, a local cluster is assumed.
func (*ModuleManager) SelectModuleInstances ¶
func (m *ModuleManager) SelectModuleInstances(item modules.DataInfo, appContext *app.FybrikApplication) ([]modules.ModuleInstanceSpec, error)
SelectModuleInstances selects the necessary read/copy/write modules for the blueprint for a given data set Write path is not yet implemented
type NewAssetInfo ¶
type NewAssetInfo struct { Storage *storage.ProvisionedBucket Details *pb.DatasetDetails }
NewAssetInfo points to the provisoned storage and hold information about the new asset
type PlotterInterface ¶
PlotterInterface context implementation for communication with a single Plotter resource
func NewPlotterInterface ¶
func NewPlotterInterface(cl client.Client) *PlotterInterface
NewPlotterInterface creates a new plotter interface for FybrikApplication controller
func (*PlotterInterface) CreateOrUpdateResource ¶
func (c *PlotterInterface) CreateOrUpdateResource(owner *app.ResourceReference, ref *app.ResourceReference, blueprintPerClusterMap map[string]app.BlueprintSpec) error
CreateOrUpdateResource creates a new Plotter resource or updates an existing one
func (*PlotterInterface) CreateResourceReference ¶
func (c *PlotterInterface) CreateResourceReference(owner *app.ResourceReference) *app.ResourceReference
CreateResourceReference returns an identifier (name and namespace) of the generated resource.
func (*PlotterInterface) DeleteResource ¶
func (c *PlotterInterface) DeleteResource(ref *app.ResourceReference) error
DeleteResource deletes the generated Plotter resource
func (*PlotterInterface) GetManagedObject ¶
func (c *PlotterInterface) GetManagedObject() runtime.Object
GetManagedObject returns the type of the managed runtime object
func (*PlotterInterface) GetResourceSignature ¶
func (c *PlotterInterface) GetResourceSignature(ref *app.ResourceReference) *app.Plotter
GetResourceSignature returns the namespaced information of the generated Plotter resource
func (*PlotterInterface) GetResourceStatus ¶
func (c *PlotterInterface) GetResourceStatus(ref *app.ResourceReference) (app.ObservedState, error)
GetResourceStatus returns the generated Plotter status
func (*PlotterInterface) ResourceExists ¶
func (c *PlotterInterface) ResourceExists(ref *app.ResourceReference) bool
ResourceExists checks whether the Plotter resource generated by FybrikApplication controller is active
type PlotterReconciler ¶
type PlotterReconciler struct { client.Client Name string Log logr.Logger Scheme *runtime.Scheme ClusterManager multicluster.ClusterManager }
PlotterReconciler reconciles a Plotter object
func NewPlotterReconciler ¶
func NewPlotterReconciler(mgr ctrl.Manager, name string, manager multicluster.ClusterManager) *PlotterReconciler
NewPlotterReconciler creates a new reconciler for Plotter resources
func (*PlotterReconciler) SetupWithManager ¶
func (r *PlotterReconciler) SetupWithManager(mgr ctrl.Manager) error
SetupWithManager registers Plotter controller