Revamp profile installation instructions for MR by lucferbux · Pull Request #854 · kubeflow/hub

lucferbux · 2025-03-06T16:01:23Z

Description

Revamp docs for Kubeflow UI installation and installing MR in Profiles.

How Has This Been Tested?

Merge criteria:

All the commits have been signed-off (To pass the DCO check)

The commits have meaningful messages; the author will squash them after approval or in case of manual merges will ask to merge with squash.
Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
The developer has manually tested the changes and verified that the changes work.
Code changes follow the kubeflow contribution guidelines.
For first time contributors: Please reach out to the Reviewers to ensure all tests are being run, ensuring the label ok-to-test has been added to the PR.

If you have UI changes

The developer has added tests or explained why testing cannot be added.
Included any necessary screenshots or gifs if it was a UI change.
Verify that UI/UX changes conform the UX guidelines for Kubeflow.

Signed-off-by: lucferbux <lferrnan@redhat.com>

rareddy · 2025-03-14T00:52:47Z

I need to read through them again with gained knowledge about the `profile'. Please give me some time to go through it again.

Co-authored-by: Paul Boyd <paul@camelot.email> Signed-off-by: Lucas Fernandez <lucasfernandezaragon@gmail.com>

Signed-off-by: lucferbux <lferrnan@redhat.com>

lucferbux · 2025-03-20T10:39:23Z

@pboyd @rareddy let me know if this is a better layout, fitting all the changes in the website too.

pboyd · 2025-03-20T16:41:33Z

I think this will help a lot.

/lgtm

rareddy · 2025-03-22T22:54:32Z

+These instructions assume that you've installed Kubeflow from the [manifests](https://github.com/kubeflow/manifests/), if you're using a distribution consult its documentation instead.

-As the default Kubeflow installation provides an Istio mesh, apply the necessary manifests:
+Kubeflow Central Dashboard uses [Profiles](https://www.kubeflow.org/docs/components/central-dash/profiles/) to handle user namespaces and permissions. By default, the manifests deploy the Model Registry instance in the `kubeflow` namespace, to install a compatible version of Model Registry for Kubeflow, you should deploy a separate instance of Model Registry in the profile's namespace. For that just run:


Let us NOT install default Model Registry in 'Kubeflow'. Define a profile like kubeflow-model-registry and install there where UI can be used.

We cannot define a profile if we don't know the user, that would be an opinionated way of installation. Profiles (https://www.kubeflow.org/docs/components/central-dash/profiles/) need to have a subject that you can then expand adding the required files, but you need to know the user in advance. We cannot enable a deafult profile.

rareddy · 2025-03-22T23:02:25Z

-```bash
-kubectl apply -k options/istio
+```sh
+PROFILE_NAME=<your-profile>


I recommend something like PROFILE_NAME=kubeflow-model-registry

As I commented above, we cannot have an opinionated profile, the default one in regular kubeflow installation is kubeflow-user-example-com but you can have any other user.

rareddy · 2025-03-23T01:37:35Z

+PROFILE_NAME=<your-profile>
+for DIR in options/istio overlays/db ; do (cd $DIR; kustomize edit set namespace $PROFILE_NAME; kubectl delete -k .); done
+
+# Uninstall Model Registry UI
+kubectl delete -k options/ui/overlays/istio -n kubeflow


adjust with above

We cannot have default profiles.

rareddy · 2025-03-23T01:39:20Z

+## Model Registry as a separate component Installation
+


what is this and why is this needed? if were to add instructions to add additional MR instance ran as the profile again, IMO it is not acceptable to install without UI.

This is the instructions if you only wanna install Model Registry without UI, we can rename it or completly remove it, it's basically what @pboyd did in https://github.com/kubeflow/website/pull/4042/files we can call it "standalone" here too, but it's basically that. If we should not install it wihtout UI I'm more than fine deleting this section.

My understanding is that given that there's a full flegde API CLI users might wanna install MR without the UI in some cases.

rareddy · 2025-03-23T01:40:46Z

 For a basic usage of the Kubeflow Model Registry, follow the [Kubeflow Model Registry getting started documentation](https://www.kubeflow.org/docs/components/model-registry/getting-started/)

-## Uninstall
+### Uninstall


shouldn't all the uninstalls be one place? can we please collate them in single section?

These uninstalls are for the two sections, if we wanna remove the latter one this won't be needed, they are different because there's different steps.

ederign

Lucas, I guess we need two commands here, one to install the UI on kubeflow ns and another to install the model registry on user namespace isn't? (sorry on L72)

lucferbux · 2025-03-25T15:53:32Z

Lucas, I guess we need two commands here, one to install the UI on kubeflow ns and another to install the model registry on user namespace isn't? (sorry on L72)

I'm following most of what we've done here https://github.com/kubeflow/website/pull/4042/files there's the installation on profiles (concept for kubeflow) and installation in the default namespace.

ederign · 2025-03-25T16:17:22Z

Lucas, I am sorry for the misunderstanding in my last comment. The process looks good to me and is aligned with the instructions that we have on the website from @pboyd PR's !

I agree with @rareddy that the solution presented both here and also on the website is not ideal from a user perspective, but it's the current the best that we can do with the current Kubeflow Central Dashboard profiles design.

But indeed, we should talk with the central dashboard guys to provide more streamlined installation process for model registry.

ederign · 2025-03-25T16:17:26Z

/lgtm

mahdikhashan · 2025-03-25T17:48:16Z

looping here to make sure I'm on sync for this issue accordingly: #863

tarilabs · 2025-03-28T11:07:49Z

based on the reviews I've read in this PR and main ones linked above, my understanding is that for the current state-of-art is best to proceed in merging this PR as-is, and iterate on this with the future work currently tracked with:

track enablement by default in KF/manifests #863
- [todo] get a consensus involving Platform WG and Central Dashboard WG #916

/approve

google-oss-prow · 2025-03-28T11:07:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ederign, tarilabs

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~manifests/kustomize/OWNERS~~ [tarilabs]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…l docker digest to c570170 (kubeflow#854) Signed-off-by: konflux-internal-p02 <170854209+konflux-internal-p02[bot]@users.noreply.github.com> Co-authored-by: konflux-internal-p02[bot] <170854209+konflux-internal-p02[bot]@users.noreply.github.com>

google-oss-prow Bot added the do-not-merge/work-in-progress label Mar 6, 2025

google-oss-prow Bot requested review from Tomcli and rareddy March 6, 2025 16:01

lucferbux mentioned this pull request Mar 6, 2025

model-registry: Revamp installation docs kubeflow/website#4034

Closed

3 tasks

github-actions Bot added the Area/Manifests label Mar 6, 2025

google-oss-prow Bot added the size/S label Mar 6, 2025

(feat): Revamp profile installation instructions for MR

6adeaaa

Signed-off-by: lucferbux <lferrnan@redhat.com>

lucferbux force-pushed the revamp-profile-installation-instructions branch from 2ba2892 to 6adeaaa Compare March 7, 2025 00:19

google-oss-prow Bot added size/M and removed size/S labels Mar 10, 2025

lucferbux force-pushed the revamp-profile-installation-instructions branch from 013e57d to 0c69e72 Compare March 10, 2025 15:45

rareddy reviewed Mar 11, 2025

View reviewed changes

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

(feat):Improve docs and remove standalone mention

985cf55

Signed-off-by: lucferbux <lferrnan@redhat.com>

lucferbux force-pushed the revamp-profile-installation-instructions branch from 0c69e72 to 985cf55 Compare March 13, 2025 22:34

lucferbux marked this pull request as ready for review March 13, 2025 22:35

google-oss-prow Bot removed the do-not-merge/work-in-progress label Mar 13, 2025

google-oss-prow Bot requested a review from tarilabs March 13, 2025 22:35

lucferbux changed the title ~~(feat): Revamp profile installation instructions for MR~~ Revamp profile installation instructions for MR Mar 13, 2025

pboyd reviewed Mar 18, 2025

View reviewed changes

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

Comment thread manifests/kustomize/README.md Outdated

lucferbux and others added 2 commits March 20, 2025 11:14

Update manifests/kustomize/README.md

37ff873

Co-authored-by: Paul Boyd <paul@camelot.email> Signed-off-by: Lucas Fernandez <lucasfernandezaragon@gmail.com>

Change layout of manifest

029a9dc

Signed-off-by: lucferbux <lferrnan@redhat.com>

google-oss-prow Bot added size/L and removed size/M labels Mar 20, 2025

lucferbux mentioned this pull request Mar 20, 2025

After registry the model, see nothing from ui #885

Closed

google-oss-prow Bot assigned pboyd Mar 20, 2025

google-oss-prow Bot added the lgtm label Mar 20, 2025

rareddy requested changes Mar 23, 2025

View reviewed changes

ederign requested changes Mar 24, 2025

View reviewed changes

google-oss-prow Bot assigned ederign Mar 25, 2025

ederign approved these changes Mar 25, 2025

View reviewed changes

tarilabs mentioned this pull request Mar 28, 2025

[todo] get a consensus involving Platform WG and Central Dashboard WG #916

Closed

google-oss-prow Bot added the approved label Mar 28, 2025

google-oss-prow Bot merged commit 28ee681 into kubeflow:main Mar 28, 2025
4 checks passed

Al-Pragliola mentioned this pull request Apr 7, 2025

[pull] main from kubeflow:main opendatahub-io/model-registry#185

Merged

tarilabs mentioned this pull request May 9, 2025

OWNERS: add ederign as approvers #1091

Merged

14 tasks

Conversation

lucferbux commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Merge criteria:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rareddy commented Mar 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lucferbux commented Mar 20, 2025

Uh oh!

pboyd commented Mar 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ederign left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucferbux commented Mar 25, 2025

Uh oh!

ederign commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ederign commented Mar 25, 2025

Uh oh!

mahdikhashan commented Mar 25, 2025

Uh oh!

tarilabs commented Mar 28, 2025

Uh oh!

google-oss-prow Bot commented Mar 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

lucferbux commented Mar 6, 2025 •

edited

Loading

ederign left a comment •

edited

Loading

ederign commented Mar 25, 2025 •

edited

Loading