model-registry icon indicating copy to clipboard operation
model-registry copied to clipboard

[Proposal] Model Registry UI Installation

Open lucferbux opened this issue 10 months ago • 6 comments

Overview

After porting the UI manifests to the root directory as proposed in this issue we wanna improve the use experience installing Model Registry in kubeflow.

Current installation

Kubeflow central dashboard uses profiles to manage user access to resources and namespaces. The default installation experience makes that the user has no access to the default namespace (kubeflow), so, for a regular user to experience Model Registry UI, it should follow this steps:

  1. Install Kubeflow following the official instructions.
  2. Deploy Model Registry UI following the instructions under Istio deployment.
  3. Once deployed in the cluster, modify the central dashboard configmap to add a new section inside menuLinks
apiVersion: v1
data:
  links: |-
    {
        "menuLinks": [
            {
                "icon": "assignment",
                "link": "/model-registry/",
                "text": "Model Registry",
                "type": "item"
            },
....
  1. Now you should see Model Registry inside Kubeflow.
  2. Deploy Model Registry following the instructions to the namespace your user has access to (Profile).
  3. Now you should see a new Model Registry in Central Dashboard.

Proposal

There's a few things we can do to improve the installation, the main action points would be:

  • Change the Model Registry installation instructions to reflect the steps mentioned above.

  • Tweak the UI to point at the instructions mentioned above to deploy MR in a given namespace rather than the administrator empty view. Image Image

  • Talk with the community around how to overlay the central dashboard configmap given that there's already an overlay for kserve

Next steps

Given that most of the use cases with Model Registry is sharing an instance between several users/teams, it might be interesting to enable All Namespaces in the namespace selector as described here, so users can share MR that are out of scope of the Profiles they have access to.

lucferbux avatar Feb 04 '25 10:02 lucferbux

"menuLinks": [
            {
                "icon": "assessment",
                "link": "/model-registry/",
                "text": "Model Registry",
                "type": "item"
            },

We should consider using a different icon since the assessment icon is already used. See https://www.webcomponents.org/element/@polymer/iron-icons/demo/demo/index.html for options

Griffin-Sullivan avatar Feb 12 '25 15:02 Griffin-Sullivan

"Given that most of the use cases with Model Registry is sharing an instance between several users/teams, it might be interesting to enable All Namespaces in the namespace selector as described here, so users can share MR that are out of scope of the Profiles they have access to." Sharing is good, but by default there should be hard multi-tenancy. Sharing must be an opt in.

juliusvonkohout avatar Mar 03 '25 12:03 juliusvonkohout

I mean you could even drop the central default instance and just have a proper hard multi-tenancy (100 % isolated) by default and opt-in sharing for private MRs.

juliusvonkohout avatar Mar 03 '25 12:03 juliusvonkohout

"Given that most of the use cases with Model Registry is sharing an instance between several users/teams, it might be interesting to enable All Namespaces in the namespace selector as described here, so users can share MR that are out of scope of the Profiles they have access to." Sharing is good, but by default there should be hard multi-tenancy. Sharing must be an opt in.

Yeah, I agree, @juliusvonkohout, there's a section in the issue for "Next steps" that detail exactly that. I don't think we can get this for 1.10 but I would 100% that's the best solution we can aim in the near future.

lucferbux avatar Mar 03 '25 18:03 lucferbux

I'll close this issue and open a new one just focused on enabling All namespaces for the near future, what do you think @tarilabs @juliusvonkohout @ederign

lucferbux avatar Mar 03 '25 18:03 lucferbux

#848 the same issue.

jiekechoo avatar Mar 04 '25 06:03 jiekechoo

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Jun 12 '25 04:06 github-actions[bot]