Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving UI Manifests to root manifests directory #731

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

Griffin-Sullivan
Copy link
Contributor

@Griffin-Sullivan Griffin-Sullivan commented Jan 23, 2025

Description

As described in #705 we are moving the UI manifests to the root manifests dir.

How Has This Been Tested?

No testing done yet. Can easily test by checking out the PR and running the script in the clients/ui directory.

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.

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.

@Griffin-Sullivan
Copy link
Contributor Author

@tarilabs @lucferbux I think you would be the best two to review this!

@tarilabs
Copy link
Member

/assing @Al-Pragliola

Alessio, can you kindly dedicate your quick 👀 on this one please?

Copy link
Contributor

@Al-Pragliola Al-Pragliola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found 2 small issues in the doc, other than that it looks good to me

cd clients/ui

kubectl apply -k manifests/overlay/standalone -n kubeflow
kubectl apply -k manifests/kustomize/options/ui/overlays/standalone -n kubeflow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to follow these steps, but I ran into this error

kubectl apply -k manifests/kustomize/options/ui/overlays/standalone -n kubeflow
serviceaccount/model-registry-ui created
clusterrole.rbac.authorization.k8s.io/model-registry-create-sars created
clusterrole.rbac.authorization.k8s.io/model-registry-retrieve-clusterrolebindings created
clusterrole.rbac.authorization.k8s.io/model-registry-ui-namespaces-reader created
clusterrole.rbac.authorization.k8s.io/model-registry-ui-services-reader created
clusterrolebinding.rbac.authorization.k8s.io/service-access-cluster-binding created
service/model-registry-ui-service created
deployment.apps/model-registry-ui created
Error from server (Invalid): error when creating "manifests/kustomize/options/ui/overlays/standalone": ClusterRoleBinding.rbac.authorization.k8s.io "model-registry-create-sars-binding" is inv
alid: subjects[0].namespace: Required value
Error from server (Invalid): error when creating "manifests/kustomize/options/ui/overlays/standalone": ClusterRoleBinding.rbac.authorization.k8s.io "model-registry-retrieve-clusterrolebinding
s-binding" is invalid: subjects[0].namespace: Required value
Error from server (Invalid): error when creating "manifests/kustomize/options/ui/overlays/standalone": ClusterRoleBinding.rbac.authorization.k8s.io "model-registry-ui-namespaces-reader-bindin
g" is invalid: subjects[0].namespace: Required value
Error from server (Invalid): error when creating "manifests/kustomize/options/ui/overlays/standalone": ClusterRoleBinding.rbac.authorization.k8s.io "model-registry-ui-services-reader-binding"
 is invalid: subjects[0].namespace: Required value

maybe you can use something like this instead

UI_MANIFESTS_PATH=manifests/kustomize/options/ui/overlays/standalone && cd "$UI_MANIFESTS_PATH" && kustomize edit set namespace kubeflow && cd - && kubectl apply -k "$UI_MANIFESTS_PATH"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh yeah forgot we changed that. I'm interested what @lucferbux's thoughts are here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the part that adds the kustomize edit set namespace kubeflow cause that's the right command but I don't think we should parametrize the installation path neither add a new env variable since it won't change in the foreseeable future. But that's a good suggestion.

cd clients/ui

kubectl apply -k manifests/overlay/standalone -n kubeflow
kubectl apply -k manifests/kustomize/options/ui/overlays/standalone -n kubeflow
```

After a few seconds you should see 2 pods running (1 for BFF and 1 for UI):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this info is outdated, the user should see just 1 pod running

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's right, if we can change it it would be amazing

@@ -45,7 +45,7 @@ make docker-build-standalone
make docker-push-standalone

echo "Editing kustomize image..."
pushd ./manifests/base
pushd ../../manifests/kustomize/options/ui/base
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Griffin-Sullivan can you remove this check from the script?

# Check if the script has rights to push an image into the registry
if ! docker push "${IMG_UI_STANDALONE}" >/dev/null 2>&1; then
  echo -e "\033[31mError: No rights to push the image to the registry ${IMG_UI_STANDALONE}, you can change the image in the env variable IMG_UI_STANDALONE\033[0m"
  exit 1
fi

Maybe leave an echo warning users to have right owners, but it's gonna fail if the user doesn't have a local image, so fist time it's gonna always fail, (it's out of scope I know but it would be nice if we can add it here)

Copy link
Contributor

@lucferbux lucferbux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, reviewed all the docs and scripts, everything looks great, just the couple of suggestions @Al-Pragliola and I left in the comments and it would be ready to go.

Signed-off-by: Griffin-Sullivan <gsulliva@redhat.com>
Copy link
Contributor

@lucferbux lucferbux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

🚀

@pboyd
Copy link
Contributor

pboyd commented Jan 28, 2025

I walked through the instructions just now without issue. No blocker from my perspective.

@Al-Pragliola
Copy link
Contributor

/lgtm

Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

per discussion:

and thank you all for the contributions

/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Al-Pragliola, lucferbux, pboyd, tarilabs

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@google-oss-prow google-oss-prow bot merged commit 2eb66b4 into kubeflow:main Jan 28, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants