TFJob Common (in development)

Reference documentation for TFJob

Packages:

kubeflow.org

Package v1beta2 is the v1beta2 version of the API.

Resource Types:

    CleanPodPolicy (string alias)

    CleanPodPolicy describes how to deal with pods when the job is finished.

    JobCondition

    (Appears on: JobStatus)

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

    Field Description
    type
    JobConditionType

    Type of job condition.

    status
    Kubernetes core/v1.ConditionStatus

    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
    Kubernetes meta/v1.Time

    The last time this condition was updated.

    lastTransitionTime
    Kubernetes meta/v1.Time

    Last time the condition transitioned from one status to another.

    JobConditionType (string alias)

    (Appears on: JobCondition)

    JobConditionType defines all kinds of types of JobStatus.

    JobStatus

    JobStatus represents the current observed state of the training Job.

    Field Description
    conditions
    []JobCondition

    Conditions is an array of current observed job conditions.

    replicaStatuses
    map[github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaType]*github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaStatus

    ReplicaStatuses is map of ReplicaType and ReplicaStatus, specifies the status of each replica.

    startTime
    Kubernetes meta/v1.Time

    Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

    completionTime
    Kubernetes meta/v1.Time

    Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

    lastReconcileTime
    Kubernetes meta/v1.Time

    Represents last time when the job was reconciled. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

    ReplicaSpec

    ReplicaSpec is a description of the replica

    Field Description
    replicas
    int32

    Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1.

    template
    Kubernetes core/v1.PodTemplateSpec

    Template is the object that describes the pod that will be created for this replica. RestartPolicy in PodTemplateSpec will be overide by RestartPolicy in ReplicaSpec

    restartPolicy
    RestartPolicy

    Restart policy for all replicas within the job. One of Always, OnFailure, Never and ExitCode. Default to Never.

    ReplicaStatus

    (Appears on: JobStatus)

    ReplicaStatus represents the current observed state of the replica.

    Field Description
    active
    int32

    The number of actively running pods.

    succeeded
    int32

    The number of pods which reached phase Succeeded.

    failed
    int32

    The number of pods which reached phase Failed.

    ReplicaType (string alias)

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

    RestartPolicy (string alias)

    (Appears on: ReplicaSpec)

    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.


    Generated with gen-crd-api-reference-docs on git commit a91cddc3.