Skip to content

Latest commit

 

History

History
133 lines (83 loc) · 4.1 KB

generated.asciidoc

File metadata and controls

133 lines (83 loc) · 4.1 KB

API Reference

Packages

kubeflow.org/v1

Package v1 is the v1 version of the API.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definitions

JobCondition

JobCondition describes the state of the job at a certain point.

Appears In:
Field Description

Type of job condition.

Status of the condition, one of True, False, Unknown.

reason string

The reason for the condition’s last transition.

message string

A human readable message indicating details about the transition.

lastUpdateTime Time

The last time this condition was updated.

lastTransitionTime Time

Last time the condition transitioned from one status to another.

JobConditionType (string)

JobConditionType defines all kinds of types of JobStatus.

Appears In:

ReplicaStatus

ReplicaStatus represents the current observed state of the replica.

Appears In:
Field Description

active integer

The number of actively running pods.

succeeded integer

The number of pods which reached phase Succeeded.

failed integer

The number of pods which reached phase Failed.

ReplicaType (string)

ReplicaType represents the type of the replica. Each operator needs to define its own set of ReplicaTypes.

Appears In:

RestartPolicy (string)

RestartPolicy describes how the replicas should be restarted. Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways.

Appears In:

SchedulingPolicy

SchedulingPolicy encapsulates various scheduling policies of the distributed training job, for example minAvailable for gang-scheduling.

Appears In:
Field Description

minAvailable integer