[FrontendSpec] Add internal_labels to frontend_spec #5542
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liranbg
requested changes
May 13, 2024
liranbg
requested changes
May 22, 2024
mlrun/common/constants.py
Outdated
Comment on lines
24
to
51
| MLRUN_INTERNAL_LABELS = [ | ||
| "dask.org/cluster-name", | ||
| "dask.org/component", | ||
| "host", | ||
| "job-type", | ||
| "kind", | ||
| "mlrun-auth-keynuclio.io/project-name", | ||
| "mlrun/class", | ||
| "mlrun/client_python_version", | ||
| "mlrun/client_version", | ||
| "mlrun/function", | ||
| "mlrun/job", | ||
| "mlrun/name", | ||
| "mlrun/owner", | ||
| "mlrun/owner_domain", | ||
| "mlrun/project", | ||
| "mlrun/runner-pod", | ||
| "mlrun/schedule-name", | ||
| "mlrun/scrape-metrics", | ||
| "mlrun/tag", | ||
| "mlrun/uid", | ||
| "mlrun/username", | ||
| "mlrun/username_domain", | ||
| "owner", | ||
| "resource_name", | ||
| "v3io_user", | ||
| "workflow", | ||
| ] |
There was a problem hiding this comment.
This is not helpful to understand each label usage and does not link to its usages - thus, prone to errors (such as label changes, etc).
What I do suggest is
- make it a class, where each subclass is the resource name (e.g. "functions", "runs", "artifacts", ...)
- values would be named so it could be reused - DRY
e.g.
class InternalLabels:
class Runs:
hostname = "hostname"
and so on.
also. note that this code should be used from mlrun server mostly. because mlrun client should not use/enforce internal labels.
There was a problem hiding this comment.
About the subclasses, I think we can do it in the following PR
quaark
requested changes
May 22, 2024
quaark
reviewed
May 23, 2024
quaark
requested changes
May 23, 2024
liranbg
requested changes
May 26, 2024
| MlrunInternalLabels.project: self.project, | ||
| MlrunInternalLabels.scrape_metrics: "True", | ||
| MlrunInternalLabels.tag: "latest", | ||
| MlrunInternalLabels.uid: self.run_uid, | ||
| "mpi-job-name": "trainer-1b019005", |
| MlrunInternalLabels.project: self.project, | ||
| MlrunInternalLabels.schedule_name: "True", | ||
| MlrunInternalLabels.tag: "latest", | ||
| MlrunInternalLabels.uid: self.run_uid, | ||
| "mpi-job-name": "trainer-1b019005", |
Comment on lines
68
to
70
| "spark-app-selector": "spark-12f88a73cb544ce298deba34947226a4", | ||
| "spark-exec-id": "1", | ||
| "spark-role": "executor", |
Comment on lines
92
to
94
| "spark-app-selector": "spark-12f88a73cb544ce298deba34947226a4", | ||
| "spark-role": "driver", | ||
| "sparkoperator.k8s.io/app-name": "my-spark-jdbc-2ea432f1", |
| "kind": "job", | ||
| MlrunInternalLabels.v3io_user: self._test_env["V3IO_USERNAME"], | ||
| MlrunInternalLabels.owner: self._test_env["V3IO_USERNAME"], | ||
| MlrunInternalLabels.kind: "job", | ||
| "category": "tests", |
|
@liranbg , Pay attention that the over labels you asked me to add are only sets in tests and are not mlrun internal labels. |
liranbg
approved these changes
May 26, 2024
rokatyy
pushed a commit
to rokatyy/mlrun
that referenced
this pull request
May 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add internal_labels to frontend_spec so the ui can know which labels are internal and should not be editable
After merging this pr we need to keep in mind adding any new internal labels to the
MlrunInternalLabelsclass and use it in the code.https://iguazio.atlassian.net/browse/ML-5939