Generate meaningful name for custom notebook image

[DaoDaoNoCode]

Goal

Allow users to set a display name for the custom images they are importing and generate a meaningful k8s name

Dependency issue

Tracker: #1254

Itemized goals

When adding custom images, the image stream names are not intuitive - eg. 'byon-xxxx'. This makes it hard to differentiate across custom images. Would like the name to be more intuitive and not include 'byon' prefix.

• Idea is to have an object (Kubernetes) name and display name for each custom NB image. The image stream would be "Custom: (Kubernetes name)".
• Users should be able to access the Kubernetes name from the custom NB images admin UI, so they can find it in the list of image streams.
• Kubernetes name must be unique (for custom NB images); display name does not need to be unique. Display name is what users will see in the UI for selecting images.
• When adding a URL for image location field, remove preceding and trailing white spaces.

Aspects continued elsewhere

No response

Mocks

No mocks

[shalberd]

@DaoDaoNoCode additionally, if not done so yet, a meaningful name should also be set for imagestream metadata.annotations opendatahub.io/notebook-image-name, like here Is that what you mean by display name?

[lucferbux]

@shalberd We tend to use this annotation for internal resources in the dashboard, both of them are to add descriptions and display names to render in the dashboard. I wasn't aware of that annotation in the notebook, so it's up to @DaoDaoNoCode to see which one fits best for our logic

[DaoDaoNoCode]

@shalberd Hmm, interesting, I didn't know we have this annotation before. I guess if we want to also show the OOTB images in the future, we should adopt the same annotations. So I agree that we should use opendatahub.io/notebook-image-name and opendatahub.io/notebook-image-desc for the display name and description. So the order of finding the display name could be opendatahub.io/notebook-image-name || openshift.io/display-name || metadata.name

[andrewballantyne]

@harshad16 do you have documentation behind these annotations?

[harshad16]

We haven't clearly documented the annotation in the imagestream.
We will include it , tracker issue: opendatahub-io/notebooks#138

[manosnoam]

Verified on RHODS 2.4: