Skip to content

Commit

Permalink
generate new manifest
Browse files Browse the repository at this point in the history
  • Loading branch information
mszadkow committed Aug 12, 2024
1 parent 4f5c8e6 commit 366c1c2
Show file tree
Hide file tree
Showing 25 changed files with 90 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/api/kubeflow.org_v1_generated.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,20 @@ Suspending a Job will reset the StartTime field of the Job.


Defaults to false.
| *`managedBy`* __string__ | ManagedBy is used to indicate the controller or entity that manages a job.
The value must be either an empty, 'kubeflow.org/training-operator' or
'kueue.x-k8s.io/multikueue'.
The built-in job controller reconciles a job which don't have this
field at all or the field value is the reserved string
'kubeflow.org/training-operator', but delegates reconciling the job
with a 'kueue.x-k8s.io/multikueue' to the Kueue.


The value must be a valid domain-prefixed path (e.g. acme.io/foo) -
all characters before the first "/" must be a valid subdomain as defined
by RFC 1123. All characters trailing the first "/" must be valid HTTP Path
characters as defined by RFC 3986. The value cannot exceed 63 characters.
The field is immutable.
|===


Expand Down
4 changes: 4 additions & 0 deletions hack/python-sdk/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,10 @@
"description": "CleanPodPolicy defines the policy to kill pods after the job completes. Default to None.",
"type": "string"
},
"managedBy": {
"description": "ManagedBy is used to indicate the controller or entity that manages a job. The value must be either an empty, 'kubeflow.org/training-operator' or 'kueue.x-k8s.io/multikueue'. The built-in job controller reconciles a job which don't have this field at all or the field value is the reserved string 'kubeflow.org/training-operator', but delegates reconciling the job with a 'kueue.x-k8s.io/multikueue' to the Kueue.\n\nThe value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable.",
"type": "string"
},
"schedulingPolicy": {
"description": "SchedulingPolicy defines the policy related to scheduling, e.g. gang-scheduling",
"$ref": "#/definitions/kubeflow.org.v1.SchedulingPolicy"
Expand Down
7 changes: 7 additions & 0 deletions pkg/apis/kubeflow.org/v1/openapi_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions pkg/apis/kubeflow.org/v1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions sdk/python/docs/KubeflowOrgV1RunPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**active_deadline_seconds** | **int** | Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer. | [optional]
**backoff_limit** | **int** | Optional number of retries before marking this job failed. | [optional]
**clean_pod_policy** | **str** | CleanPodPolicy defines the policy to kill pods after the job completes. Default to None. | [optional]
**managed_by** | **str** | ManagedBy is used to indicate the controller or entity that manages a job. The value must be either an empty, 'kubeflow.org/training-operator' or 'kueue.x-k8s.io/multikueue'. The built-in job controller reconciles a job which don't have this field at all or the field value is the reserved string 'kubeflow.org/training-operator', but delegates reconciling the job with a 'kueue.x-k8s.io/multikueue' to the Kueue. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable. | [optional]
**scheduling_policy** | [**KubeflowOrgV1SchedulingPolicy**](KubeflowOrgV1SchedulingPolicy.md) | | [optional]
**suspend** | **bool** | suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods and PodGroups associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job. Defaults to false. | [optional]
**ttl_seconds_after_finished** | **int** | TTLSecondsAfterFinished is the TTL to clean up jobs. It may take extra ReconcilePeriod seconds for the cleanup, since reconcile gets called periodically. Default to infinite. | [optional]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class KubeflowOrgV1RunPolicy(object):
'active_deadline_seconds': 'int',
'backoff_limit': 'int',
'clean_pod_policy': 'str',
'managed_by': 'str',
'scheduling_policy': 'KubeflowOrgV1SchedulingPolicy',
'suspend': 'bool',
'ttl_seconds_after_finished': 'int'
Expand All @@ -45,12 +46,13 @@ class KubeflowOrgV1RunPolicy(object):
'active_deadline_seconds': 'activeDeadlineSeconds',
'backoff_limit': 'backoffLimit',
'clean_pod_policy': 'cleanPodPolicy',
'managed_by': 'managedBy',
'scheduling_policy': 'schedulingPolicy',
'suspend': 'suspend',
'ttl_seconds_after_finished': 'ttlSecondsAfterFinished'
}

def __init__(self, active_deadline_seconds=None, backoff_limit=None, clean_pod_policy=None, scheduling_policy=None, suspend=None, ttl_seconds_after_finished=None, local_vars_configuration=None): # noqa: E501
def __init__(self, active_deadline_seconds=None, backoff_limit=None, clean_pod_policy=None, managed_by=None, scheduling_policy=None, suspend=None, ttl_seconds_after_finished=None, local_vars_configuration=None): # noqa: E501
"""KubeflowOrgV1RunPolicy - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
Expand All @@ -59,6 +61,7 @@ def __init__(self, active_deadline_seconds=None, backoff_limit=None, clean_pod_p
self._active_deadline_seconds = None
self._backoff_limit = None
self._clean_pod_policy = None
self._managed_by = None
self._scheduling_policy = None
self._suspend = None
self._ttl_seconds_after_finished = None
Expand All @@ -70,6 +73,8 @@ def __init__(self, active_deadline_seconds=None, backoff_limit=None, clean_pod_p
self.backoff_limit = backoff_limit
if clean_pod_policy is not None:
self.clean_pod_policy = clean_pod_policy
if managed_by is not None:
self.managed_by = managed_by
if scheduling_policy is not None:
self.scheduling_policy = scheduling_policy
if suspend is not None:
Expand Down Expand Up @@ -146,6 +151,29 @@ def clean_pod_policy(self, clean_pod_policy):

self._clean_pod_policy = clean_pod_policy

@property
def managed_by(self):
"""Gets the managed_by of this KubeflowOrgV1RunPolicy. # noqa: E501
ManagedBy is used to indicate the controller or entity that manages a job. The value must be either an empty, 'kubeflow.org/training-operator' or 'kueue.x-k8s.io/multikueue'. The built-in job controller reconciles a job which don't have this field at all or the field value is the reserved string 'kubeflow.org/training-operator', but delegates reconciling the job with a 'kueue.x-k8s.io/multikueue' to the Kueue. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable. # noqa: E501
:return: The managed_by of this KubeflowOrgV1RunPolicy. # noqa: E501
:rtype: str
"""
return self._managed_by

@managed_by.setter
def managed_by(self, managed_by):
"""Sets the managed_by of this KubeflowOrgV1RunPolicy.
ManagedBy is used to indicate the controller or entity that manages a job. The value must be either an empty, 'kubeflow.org/training-operator' or 'kueue.x-k8s.io/multikueue'. The built-in job controller reconciles a job which don't have this field at all or the field value is the reserved string 'kubeflow.org/training-operator', but delegates reconciling the job with a 'kueue.x-k8s.io/multikueue' to the Kueue. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable. # noqa: E501
:param managed_by: The managed_by of this KubeflowOrgV1RunPolicy. # noqa: E501
:type: str
"""

self._managed_by = managed_by

@property
def scheduling_policy(self):
"""Gets the scheduling_policy of this KubeflowOrgV1RunPolicy. # noqa: E501
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_jax_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_jax_job_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down Expand Up @@ -106,6 +107,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_jax_job_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand All @@ -69,6 +70,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_mpi_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_mpi_job_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down Expand Up @@ -111,6 +112,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_mpi_job_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_paddle_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_paddle_job_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down Expand Up @@ -120,6 +121,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_paddle_job_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand All @@ -76,6 +77,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_py_torch_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_py_torch_job_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down Expand Up @@ -144,6 +145,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
2 changes: 2 additions & 0 deletions sdk/python/test/test_kubeflow_org_v1_py_torch_job_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand All @@ -88,6 +89,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_run_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
1 change: 1 addition & 0 deletions sdk/python/test/test_kubeflow_org_v1_tf_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ def make_instance(self, include_optional):
active_deadline_seconds = 56,
backoff_limit = 56,
clean_pod_policy = '0',
managed_by = '0',
scheduling_policy = kubeflow_org_v1_scheduling_policy.KubeflowOrgV1SchedulingPolicy(
min_available = 56,
min_resources = {
Expand Down
Loading

0 comments on commit 366c1c2

Please sign in to comment.