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

[Service Mesh] include SM notebook patches in one function #1955

Merged

Conversation

cam-garrison
Copy link

Closes #1954

Description

During review of #1088, it was left as an open comment to consolidate the three notebook annotation/label patch functions into one for code cleanness and to ensure future development doesn't "disable" one of the patches.

This PR implements this by wrapping the three patches into one function, and calling it the same as before but now flattening the returned array of patches.

How Has This Been Tested?

Tested by installing operator v2 with service mesh: see opendatahub-io/opendatahub-operator#605. Then, tested creating notebooks from the jupyter tile and from a data science project to ensure that the correct annotations and label are still added to the notebook object when using Service Mesh.

Test Impact

I would be happy to add tests, but would need some directions on how to add testing for this type of PR (patching of NB resource).

Request review criteria:

Self checklist (all need to be checked):

  • The developer has manually tested the changes and verified that the changes work
  • Commits have been squashed into descriptive, self-contained units of work (e.g. 'WIP' and 'Implements feedback' style messages have been removed)
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has added tests or explained why testing cannot be added (unit tests & storybook for related changes)

If you have UI changes:

  • Included any necessary screenshots or gifs if it was a UI change.
  • Included tags to the UX team if it was a UI/UX change (find relevant UX in the SMEs section).

After the PR is posted & before it merges:

  • The developer has tested their solution on a cluster by using the image produced by the PR to main

@andrewballantyne andrewballantyne linked an issue Oct 11, 2023 that may be closed by this pull request
Copy link
Member

@andrewballantyne andrewballantyne left a comment

Choose a reason for hiding this comment

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

Looks good -- one inquiry.

path: '/metadata/annotations/opendatahub.io~1service-mesh',
value: String(enableServiceMesh),
});
export const getServiceMeshPatches = (enableServiceMesh: boolean): Patch[] => [
Copy link
Member

@andrewballantyne andrewballantyne Oct 11, 2023

Choose a reason for hiding this comment

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

Simple inquiry -- do we plan to support these patches not being included or should they always be included since they share the on/off state. (such as feature flag off)

Copy link
Author

Choose a reason for hiding this comment

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

I think these patches should always be included.

Reasoning being that in particular, the inject-oauth alongside the service-mesh patch/annotation is used by the notebook-controller (see PR https://github.com/opendatahub-io/kubeflow/pull/172/files) to decide if the oauth-proxy sidecar should be injected.

So for inject-oauth particularly this must be included, and I think similar reasoning applies for the other two.

Copy link
Contributor

openshift-ci bot commented Nov 3, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewballantyne

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

@openshift-ci openshift-ci bot added the approved label Nov 3, 2023
@openshift-ci openshift-ci bot merged commit 9f1c6b4 into opendatahub-io:f/ossm Nov 3, 2023
4 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.

OSSM: Consolidate Service Mesh related notebook patches
2 participants