Skip to content

Commit 0aba7b7

Browse files
committed
address final comments
1 parent fd627fb commit 0aba7b7

File tree

7 files changed

+124
-104
lines changed

7 files changed

+124
-104
lines changed

openapi/generated_openapi/zz_generated.openapi.go

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/openapi.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -33207,7 +33207,7 @@
3320733207
}
3320833208
},
3320933209
"com.github.openshift.api.operator.v1alpha1.ExternalFramework": {
33210-
"description": "This is the GVK for an external framework. Controller runtime requires this in this format for api discoverability.",
33210+
"description": "This is the GVR for an external framework. Controller runtime requires this in this format for api discoverability.",
3321133211
"type": "object",
3321233212
"required": [
3321333213
"group",
@@ -33216,17 +33216,17 @@
3321633216
],
3321733217
"properties": {
3321833218
"group": {
33219-
"description": "group of externalFramework must be a valid qualified name consisting of a lower-case alphanumeric string, and hyphens of at most 63 characters in length. The name must start and end with an alphanumeric character. The name may be optionally prefixed with a subdomain consisting of lower-case alphanumeric characters, hyphens and periods, of at most 253 characters in length. Each period separated segment within the subdomain must start and end with an alphanumeric character. The optional prefix and the name are separate by a forward slash (/).",
33219+
"description": "group of externalFramework group is the API group of the externalFramework. Must be a valid qualified name consisting of a lower-case alphanumeric string, and hyphens of at most 63 characters in length. The name must start and end with an alphanumeric character. The name may be optionally prefixed with a subdomain consisting of lower-case alphanumeric characters, hyphens and periods, of at most 253 characters in length. Each period separated segment within the subdomain must start and end with an alphanumeric character. The optional prefix and the name are separate by a forward slash (/).",
3322033220
"type": "string",
3322133221
"default": ""
3322233222
},
3322333223
"resource": {
33224-
"description": "resource of external framework must be a valid qualified name consisting of a lower-case alphanumeric string, and hyphens of at most 63 characters in length. The name must start and end with an alphanumeric character. The name may be optionally prefixed with a subdomain consisting of lower-case alphanumeric characters, hyphens and periods, of at most 253 characters in length. Each period separated segment within the subdomain must start and end with an alphanumeric character.",
33224+
"description": "resource is the Resource type of the external framework. Resource types are lowercase and plural (e.g. pods, deployments). Must be a valid qualified name consisting of a lower-case alphanumeric string and hyphens of at most 63 characters in length. The name must start and end with an alphanumeric character. The name may be optionally prefixed with a subdomain consisting of lower-case alphanumeric characters, hyphens and periods, of at most 253 characters in length. Each period separated segment within the subdomain must start and end with an alphanumeric character.",
3322533225
"type": "string",
3322633226
"default": ""
3322733227
},
3322833228
"version": {
33229-
"description": "version is the version of the api",
33229+
"description": "version is the version of the api (e.g. v1alpha1, v1beta1, v1).",
3323033230
"type": "string",
3323133231
"default": ""
3323233232
}
@@ -33392,7 +33392,7 @@
3339233392
"x-kubernetes-list-type": "atomic"
3339333393
},
3339433394
"frameworks": {
33395-
"description": "frameworks are a list of names to be enabled. This is required and must have at least one element. The frameworks are jobs that Kueue will manage. KueueIntegrations is a list of frameworks that Kueue has support for. The allowed values are BatchJob;RayJob;RayCluster;JobSet;MPIJob;PaddleJob;PytorchJob;TFJob;XGBoostJob;AppWrappers;Pod;Deployment;StatefulSet;LeaderWorkerSet. kubebuilder:validation:UniqueItems=true",
33395+
"description": "frameworks are a unique list of names to be enabled. This is required and must have at least one element. The frameworks are jobs that Kueue will manage. Frameworks are a list of frameworks that Kueue has support for. The allowed values are BatchJob;RayJob;RayCluster;JobSet;MPIJob;PaddleJob;PytorchJob;TFJob;XGBoostJob;AppWrappers;Pod;Deployment;StatefulSet;LeaderWorkerSet.",
3339633396
"type": "array",
3339733397
"items": {
3339833398
"type": "string",
@@ -33401,7 +33401,7 @@
3340133401
"x-kubernetes-list-type": "atomic"
3340233402
},
3340333403
"labelKeysToCopy": {
33404-
"description": "labelKeysToCopy are a list of label keys that are copied once a workload is created these keys are persisted to the internal Kueue workload object. otherwise only the Kueue labels will be copied.",
33404+
"description": "labelKeysToCopy are a list of label keys that are copied once a workload is created. These keys are persisted to the internal Kueue workload object. If not specified, only the Kueue labels will be copied.",
3340533405
"type": "array",
3340633406
"items": {
3340733407
"default": {},
@@ -33450,7 +33450,7 @@
3345033450
],
3345133451
"properties": {
3345233452
"integrations": {
33453-
"description": "integrations are the workloads Kueue will manage Kueue has integrations in the codebase and it also allows for external frameworks Kueue are an important part to specify for the API as Kueue will only manage the workloads that are specfied in this list. This is a required field.",
33453+
"description": "integrations is a required field that configures the Kueue's workload integrations. Kueue has both standard integrations, known as job frameworks, and external integrations known as external frameworks. Kueue will only manage workloads that correspond to the specified integrations.",
3345433454
"default": {},
3345533455
"$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.Integrations"
3345633456
}

0 commit comments

Comments
 (0)