Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add ModelRegistry component (opendatahub-io#775) (opendatahub-i…
…o#776) Squashed commit due to buildability since ComponentInterface has changed. Other patches squashed as well to avoid double squashing due to merge policy. modelregistry: regenerate autogenerated files Run `make generate manifests` after all the changes Signed-off-by: Yauheni Kaliuta <[email protected]> feat: Add ModelRegistry component (opendatahub-io#775) (opendatahub-io#776) * feat: Add ModelRegistry component (opendatahub-io#775) * fix: Fix modelregistry odh overlays path * fix: fix dsc_create_test tests err nil check * fix: refactor ModelRegistry.ReconcileComponent for new parameters * chore: added modelregistry to README.md * fix: add missing rbac rules for deploymentconfigs and daemonsets * chore: code lint cleanup * fix: added check for nil DevFlags in model-registry component * fix: add nil check for dscispec.DevFlags in model-registry ReconcileComponent * fix: remove RBAC rules for daemonsets and deploymentconfigs * fix(chore): fix lint errors in dsc_deletion_test.go (cherry picked from commit 112d3f1) Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: partial: chore: removes SetImageParamsMap from ComponentInterface (opendatahub-io#897) Partial application of already applied commit d10a764 Author: Bartosz Majsak <[email protected]> Date: Thu Mar 7 15:43:37 2024 +0100 chore: removes SetImageParamsMap from ComponentInterface (opendatahub-io#897) As it's not used by any component, acting as a simple pass-return loop. This makes the API contract a bit cleaner. Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: partial: chore: remove the need of passing rest config (opendatahub-io#895) Partial application of already applied commit ca7fa98 Author: Bartosz Majsak <[email protected]> Date: Fri Mar 8 17:40:54 2024 +0100 chore: remove the need of passing rest config (opendatahub-io#895) * chore: fixes ComponentInterface docs By removing reference to non-existing func. This function has been in use outside of this component. * fix: removes rest config As we are already using client.Client interface we do not have to instantiate other typed clients to e.g. list resources using their own funcs. Generic client.Client is sufficient for these needs. Additionally this change adds ctx propogation for these calls. Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: partial: feat(logger): for both controller level and component level (opendatahub-io#837) Partial application of already applied commit d8a83a2 Author: Wen Zhou <[email protected]> Date: Mon Apr 1 22:06:16 2024 +0200 feat(logger): for both controller level and component level (opendatahub-io#837) * feat(logger): for both controller level and component level Signed-off-by: Wen Zhou <[email protected]> * update(logger): use logr instead of uber's zap Signed-off-by: Wen Zhou <[email protected]> * update: do not log error only print Signed-off-by: Wen Zhou <[email protected]> * update: use zap.Options for both and tune levels Signed-off-by: Wen Zhou <[email protected]> * update: move setting into common function Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Zhou, Wen <[email protected]> --------- Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Zhou, Wen <[email protected]> Signed-off-by: Yauheni Kaliuta <[email protected]> update(modelregistry): rename image name (opendatahub-io#877) Signed-off-by: Wen Zhou <[email protected]> (cherry picked from commit b4e4d6f) modelregistry: partial: chore: cleanup duplicated functions packages and add more for godoc (opendatahub-io#981) Partial application of already applied commit 96c85f2 Author: Wen Zhou <[email protected]> Date: Tue Apr 23 14:05:24 2024 +0200 chore: cleanup duplicated functions packages and add more for godoc (opendatahub-io#981) * chore: cleanup duplicated functions/package and add godoc - move GetPlatform() from deploy package to cluster package - move const ManagedRhods SelfManagedRhods OpenDataHub from deploy to cluster package - move WaitForDeploymentAvailable() monitoring package to cluster package - remove monitoring package - move UpdatePodSecurityRolebinding() from common package to cluster package - deprecate GetDomain from common package, to only use GetDomain from cluster package. - remove gvk package, move its GVK to cluster package - move DeleteExistingSubscription() from deploy package to upgrade package - do not export getSubscription() Signed-off-by: Wen Zhou <[email protected]> * update: remove gvk into one file but under cluster package Signed-off-by: Wen Zhou <[email protected]> * update: rename variable, removing GVK from it Signed-off-by: Wen Zhou <[email protected]> * update: move gvk into a sub package under cluster Signed-off-by: Wen Zhou <[email protected]> --------- Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Yauheni Kaliuta <[email protected]> feat(mr): create namespace for Model Registry (opendatahub-io#930) * feat(mr): create namespace for smm Signed-off-by: Wen Zhou <[email protected]> * fix: rebase Signed-off-by: Zhou, Wen <[email protected]> * update: code review comments Signed-off-by: Wen Zhou <[email protected]> * fix(doc): wrong comments Signed-off-by: Wen Zhou <[email protected]> * update: remove label to keep namespace even opreator is uninstalled Signed-off-by: Wen Zhou <[email protected]> --------- Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Zhou, Wen <[email protected]> (cherry picked from commit 1188ce1) feat(mr): add model registry odh extras manifests, fixes RHOAIENG-5112 (opendatahub-io#953) (cherry picked from commit 7c3e81b) modelregistry: partial: chore: Open up util functions for context propagation (opendatahub-io#1033) Partial application of already applied commit 105adae Author: Aslak Knutsen <[email protected]> Date: Tue Jun 4 15:16:21 2024 +0200 chore: Open up util functions for context propagation (opendatahub-io#1033) context should be determined by the caller and propagated down the call chain. Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: partial: chore: remove duplicated platform call in each component (opendatahub-io#1055) Partial application of already applied commit 1b04761 Author: Wen Zhou <[email protected]> Date: Fri Jun 14 14:47:33 2024 +0200 chore: remove duplicated platform call in each component (opendatahub-io#1055) - get in DSC and pass into compoment Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: update api docs run `make api-docs` add +groupName=datasciencecluster.opendatahub.io On backporting of 1b86e42 ("Update readme.md (opendatahub-io#890)") Signed-off-by: Yauheni Kaliuta <[email protected]> modelregistry: partial: chore(lint): enable contextcheck and containedctx (opendatahub-io#1070) Partial application of already applied: commit 06e21a4 Author: Luca Burgazzoli <[email protected]> Date: Tue Jun 25 17:15:13 2024 +0200 chore(lint): enable contextcheck and containedctx (opendatahub-io#1070) * chore(lint): enable contextcheck Signed-off-by: Luca Burgazzoli <[email protected]> * chore(lint): enable containedctx Signed-off-by: Luca Burgazzoli <[email protected]> * Fix PR review findings * Fix rebase --------- Signed-off-by: Luca Burgazzoli <[email protected]> Signed-off-by: Yauheni Kaliuta <[email protected]> refactor: dashboard with new manifests structure (opendatahub-io#1065) Partial application of already applied: commit 438f4c2 Author: Wen Zhou <[email protected]> Date: Tue Jul 2 16:56:25 2024 +0200 refactor: dashboard with new manifests structure (opendatahub-io#1065) * refactor: dashboard with new manifests structure - change type of platform, skip convert to string - add more support for ApplyParam() to not only take ENV but also anything from ExtraParamMaps * update: simplify override function * update: add value for Unknown platform --------- Signed-off-by: Wen Zhou <[email protected]> Signed-off-by: Yauheni Kaliuta <[email protected]> feat: add managed model registry prometheus config handling logic, part of RHOAIENG-4273 (opendatahub-io#1150) (cherry picked from commit 72fc80f) Adjusted Kueue and TrainingOperator rules Signed-off-by: Yauheni Kaliuta <[email protected]> feat: add default cert for model registry, fixes RHOAIENG-9909 (opendatahub-io#1165) Conflicts: ApplyParams arguments due to missing: d84cd33 ("update: remove unnecessary param from ApplyParams() (opendatahub-io#1180)") * feat: add default cert for model registry, fixes RHOAIENG-9909 * fix: fixed lint errors * fix: add servicemesh feature check for MR, add MR enable check in e2e default cert test * fix: changed MR servicemesh status check to look for Managed state * fix: ignore missing model-registry default cert if already removed (cherry picked from commit 4c411a6) feat: add servicemeshmember for model registry namespace, fixes RHOAIENG-11831 (opendatahub-io#1202) * feat: add servicemeshmember for model registry namespace, fixes RHOAIENG-11831 * fix: ignore error if MR smm already exists * code cleanup for readability Co-authored-by: Bartosz Majsak <[email protected]> * Avoid shadowing package name in variable Co-authored-by: Bartosz Majsak <[email protected]> * chore: rename createServicemeshMember to enrollToServiceMesh, add log messages --------- Co-authored-by: Bartosz Majsak <[email protected]> (cherry picked from commit 8f3d013) feat: add managed model registry prometheus job, metrics, and alering rules, fixes RHOAIENG-4273 (cherry picked from commit f811d67)
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| // Package modelregistry provides utility functions to config ModelRegistry, an ML Model metadata repository service | ||
| // +groupName=datasciencecluster.opendatahub.io | ||
| package modelregistry | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "path/filepath" | ||
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| operatorv1 "github.com/openshift/api/operator/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| dsciv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/dscinitialization/v1" | ||
| infrav1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/infrastructure/v1" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/components" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/pkg/conversion" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy" | ||
|
|
||
| _ "embed" | ||
| ) | ||
|
|
||
| const DefaultModelRegistryCert = "default-modelregistry-cert" | ||
|
|
||
| var ( | ||
| ComponentName = "model-registry-operator" | ||
| Path = deploy.DefaultManifestPath + "/" + ComponentName + "/overlays/odh" | ||
| // we should not apply this label to the namespace, as it triggered namspace deletion during operator uninstall | ||
| // modelRegistryLabels = cluster.WithLabels( | ||
| // labels.ODH.OwnedNamespace, "true", | ||
| // ). | ||
| ModelRegistriesNamespace = "odh-model-registries" | ||
| ) | ||
|
|
||
| // Verifies that ModelRegistry implements ComponentInterface. | ||
| var _ components.ComponentInterface = (*ModelRegistry)(nil) | ||
|
|
||
| // ModelRegistry struct holds the configuration for the ModelRegistry component. | ||
| // +kubebuilder:object:generate=true | ||
| type ModelRegistry struct { | ||
| components.Component `json:""` | ||
| } | ||
|
|
||
| func (m *ModelRegistry) OverrideManifests(ctx context.Context, _ cluster.Platform) error { | ||
| // If devflags are set, update default manifests path | ||
| if len(m.DevFlags.Manifests) != 0 { | ||
| manifestConfig := m.DevFlags.Manifests[0] | ||
| if err := deploy.DownloadManifests(ctx, ComponentName, manifestConfig); err != nil { | ||
| return err | ||
| } | ||
| // If overlay is defined, update paths | ||
| defaultKustomizePath := "overlays/odh" | ||
| if manifestConfig.SourcePath != "" { | ||
| defaultKustomizePath = manifestConfig.SourcePath | ||
| } | ||
| Path = filepath.Join(deploy.DefaultManifestPath, ComponentName, defaultKustomizePath) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (m *ModelRegistry) GetComponentName() string { | ||
| return ComponentName | ||
| } | ||
|
|
||
| func (m *ModelRegistry) ReconcileComponent(ctx context.Context, cli client.Client, logger logr.Logger, | ||
| owner metav1.Object, dscispec *dsciv1.DSCInitializationSpec, platform cluster.Platform, _ bool) error { | ||
| l := m.ConfigComponentLogger(logger, ComponentName, dscispec) | ||
| var imageParamMap = map[string]string{ | ||
| "IMAGES_MODELREGISTRY_OPERATOR": "RELATED_IMAGE_ODH_MODEL_REGISTRY_OPERATOR_IMAGE", | ||
| "IMAGES_GRPC_SERVICE": "RELATED_IMAGE_ODH_MLMD_GRPC_SERVER_IMAGE", | ||
| "IMAGES_REST_SERVICE": "RELATED_IMAGE_ODH_MODEL_REGISTRY_IMAGE", | ||
| } | ||
| enabled := m.GetManagementState() == operatorv1.Managed | ||
| monitoringEnabled := dscispec.Monitoring.ManagementState == operatorv1.Managed | ||
|
|
||
| if enabled { | ||
| // return error if ServiceMesh is not enabled, as it's a required feature | ||
| if dscispec.ServiceMesh == nil || dscispec.ServiceMesh.ManagementState != operatorv1.Managed { | ||
| return errors.New("ServiceMesh needs to be set to 'Managed' in DSCI CR, it is required by Model Registry") | ||
| } | ||
|
|
||
| if err := m.createDependencies(ctx, cli, dscispec); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if m.DevFlags != nil { | ||
| // Download manifests and update paths | ||
| if err := m.OverrideManifests(ctx, platform); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Update image parameters only when we do not have customized manifests set | ||
| if (dscispec.DevFlags == nil || dscispec.DevFlags.ManifestsUri == "") && (m.DevFlags == nil || len(m.DevFlags.Manifests) == 0) { | ||
| extraParamsMap := map[string]string{ | ||
| "DEFAULT_CERT": DefaultModelRegistryCert, | ||
| } | ||
| if err := deploy.ApplyParams(Path, imageParamMap, extraParamsMap); err != nil { | ||
| return fmt.Errorf("failed to update image from %s : %w", Path, err) | ||
| } | ||
| } | ||
|
|
||
| // Create model registries namespace | ||
| // We do not delete this namespace even when ModelRegistry is Removed or when operator is uninstalled. | ||
| ns, err := cluster.CreateNamespace(ctx, cli, ModelRegistriesNamespace) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| l.Info("created model registry namespace", "namespace", ModelRegistriesNamespace) | ||
| // create servicemeshmember here, for now until post MVP solution | ||
| err = enrollToServiceMesh(ctx, cli, dscispec, ns) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| l.Info("created model registry servicemesh member", "namespace", ModelRegistriesNamespace) | ||
| } else { | ||
| err := m.removeDependencies(ctx, cli, dscispec) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Deploy ModelRegistry Operator | ||
| if err := deploy.DeployManifestsFromPath(ctx, cli, owner, Path, dscispec.ApplicationsNamespace, m.GetComponentName(), enabled); err != nil { | ||
| return err | ||
| } | ||
| l.Info("apply manifests done") | ||
|
|
||
| // Create additional model registry resources, componentEnabled=true because these extras are never deleted! | ||
| if err := deploy.DeployManifestsFromPath(ctx, cli, owner, Path+"/extras", dscispec.ApplicationsNamespace, m.GetComponentName(), true); err != nil { | ||
| return err | ||
| } | ||
| l.Info("apply extra manifests done") | ||
|
|
||
| // CloudService Monitoring handling | ||
| if platform == cluster.ManagedRhods { | ||
| if enabled { | ||
| if err := cluster.WaitForDeploymentAvailable(ctx, cli, ComponentName, dscispec.ApplicationsNamespace, 10, 1); err != nil { | ||
| return fmt.Errorf("deployment for %s is not ready to server: %w", ComponentName, err) | ||
| } | ||
| l.Info("deployment is done, updating monitoring rules") | ||
| } | ||
| if err := m.UpdatePrometheusConfig(cli, enabled && monitoringEnabled, ComponentName); err != nil { | ||
|
Check failure on line 150 in components/modelregistry/modelregistry.go
|
||
| return err | ||
| } | ||
| if err := deploy.DeployManifestsFromPath(ctx, cli, owner, | ||
| filepath.Join(deploy.DefaultManifestPath, "monitoring", "prometheus", "apps"), | ||
| dscispec.Monitoring.Namespace, | ||
| "prometheus", true); err != nil { | ||
| return err | ||
| } | ||
| l.Info("updating SRE monitoring done") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (m *ModelRegistry) createDependencies(ctx context.Context, cli client.Client, dscispec *dsciv1.DSCInitializationSpec) error { | ||
| // create DefaultModelRegistryCert | ||
| if err := cluster.PropagateDefaultIngressCertificate(ctx, cli, DefaultModelRegistryCert, dscispec.ServiceMesh.ControlPlane.Namespace); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (m *ModelRegistry) removeDependencies(ctx context.Context, cli client.Client, dscispec *dsciv1.DSCInitializationSpec) error { | ||
| // delete DefaultModelRegistryCert | ||
| certSecret := corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: DefaultModelRegistryCert, | ||
| Namespace: dscispec.ServiceMesh.ControlPlane.Namespace, | ||
| }, | ||
| } | ||
| // ignore error if the secret has already been removed | ||
| if err := cli.Delete(ctx, &certSecret); client.IgnoreNotFound(err) != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| //go:embed resources/servicemesh-member.tmpl.yaml | ||
| var smmTemplate string | ||
|
|
||
| func enrollToServiceMesh(ctx context.Context, cli client.Client, dscispec *dsciv1.DSCInitializationSpec, namespace *corev1.Namespace) error { | ||
| tmpl, err := template.New("servicemeshmember").Parse(smmTemplate) | ||
| if err != nil { | ||
| return fmt.Errorf("error parsing servicemeshmember template: %w", err) | ||
| } | ||
| builder := strings.Builder{} | ||
| controlPlaneData := struct { | ||
| Namespace string | ||
| ControlPlane *infrav1.ControlPlaneSpec | ||
| }{Namespace: namespace.Name, ControlPlane: &dscispec.ServiceMesh.ControlPlane} | ||
|
|
||
| if err = tmpl.Execute(&builder, controlPlaneData); err != nil { | ||
| return fmt.Errorf("error executing servicemeshmember template: %w", err) | ||
| } | ||
|
|
||
| unstrObj, err := conversion.StrToUnstructured(builder.String()) | ||
| if err != nil || len(unstrObj) != 1 { | ||
| return fmt.Errorf("error converting servicemeshmember template: %w", err) | ||
| } | ||
|
|
||
| return client.IgnoreAlreadyExists(cli.Create(ctx, unstrObj[0])) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| apiVersion: maistra.io/v1 | ||
| kind: ServiceMeshMember | ||
| metadata: | ||
| name: default | ||
| namespace: {{.Namespace}} | ||
| spec: | ||
| controlPlaneRef: | ||
| namespace: {{ .ControlPlane.Namespace }} | ||
| name: {{ .ControlPlane.Name }} |
Oops, something went wrong.