open-services-group / byon

Bring Your Own Notebook (BYON) project repository.
GNU General Public License v3.0
4 stars 8 forks source link

Define new image tag annotations #18

Closed tumido closed 2 years ago

tumido commented 2 years ago

Find agreement on new additional imagestream annotations:

Status Annotation key Values Description
Preexisting opendatahub.io/notebook-image-desc string User facing image description
Proposed new opendatahub.io/notebook-image-messages string encoded JSON Validation output (errors and recommendations)
Preexisting opendatahub.io/notebook-image-name string User facing image name
Proposed new, questionable opendatahub.io/notebook-image-origin string Defines if the image is part of ODH distribution, admin imported or user created. Proposed values Default, Admin and Custom
Proposed new opendatahub.io/notebook-image-phase string State of validation process: Validating, Success, Failed
Preexisting opendatahub.io/notebook-image-url url Container image url e.g. quay.io/org/image:tag
~Proposed new~ Dismissed ~opendatahub.io/notebook-image-visible~ ~boolean string~ ~Decides if the imagestream is shown to users in spawner UI. Either "true" or "false"~ Replaced by adding/removing the standard opendatahub.io/notebook-image label, see https://github.com/opendatahub-io/jupyterhub-singleuser-profiles/issues/217
Proposed new opendatahub.io/notebook-image-creator string Kubernetes user name of the person initiating the import
tumido commented 2 years ago

@lavlas, should we move this discussion into ODH or can we decide that in here?

tumido commented 2 years ago

@Lavlas basically all we are introducing are the annotations in the table above with status Proposed new, the rest is just summary of what we know about the already existing annotations that we're trying to populate during the import.

tumido commented 2 years ago

bump @lavlas, should I open a similar issue in the ODH? Who should we pull in for this?

LaVLaS commented 2 years ago

I created a linked issue in the odh-dashboard repo to reference this issue. We can track the final list of annotations in this issue since they are produced and reference this in the Dashboard documentation

tumido commented 2 years ago

Updated: removed notebook-image-visible, added notebook-image-creator