API Reference
Packages
batch.tensorstack.dev/v1beta1
Package v1beta1 contains API Schema definitions for the batch v1beta1 API group
Resource Types
MPIConfig
MPIConfig describes how to start the mpi job.
Appears in:
| Field | Description |
|---|---|
mca object (keys:string, values:string) | Open MPI uses Modular Component Architecture (MCA) parameters to provide a way to tune your runtime environment. |
home string | Open MPI installation path. |
extraArgs string array | Extra args for mpirun. |
script string array | Command line to start the MPI programs inside a worker pod. This is invoked by the launcher after all the worker pods have been created and entered ready state. |
MPIJob
MPIJob is the Schema for the mpijobs API
Appears in:
| Field | Description |
|---|---|
apiVersion string | batch.tensorstack.dev/v1beta1 |
kind string | MPIJob |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec MPIJobSpec | |
status MPIJobStatus |
MPIJobList
MPIJobList contains a list of MPIJob
| Field | Description |
|---|---|
apiVersion string | batch.tensorstack.dev/v1beta1 |
kind string | MPIJobList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items MPIJob array |
MPIJobSpec
MPIJobSpec outlines the intended configuration and execution parameters for a MPIJob.
Appears in:
| Field | Description |
|---|---|
ssh SSHConfig | SSH configs. |
runPolicy RunPolicy | Execution policy configurations governing the behavior of the MPI job. |
runMode RunMode | Job's execution behavior. If omitted, defaults to Immediate mode, and tasks are executed immediately upon submission. |
scheduler SchedulePolicy | Identifies the preferred scheduler for allocating resources to replicas. Defaults to cluster default scheduler. Use k8s default scheduler by default. |
mpiConfig MPIConfig | Describes how to start the mpi job. |
replicaSpecs ReplicaSpec array | List of replica specs belonging to the job. There must be at least one replica defined for a Job. |
MPIJobStatus
MPIJobStatus represents the observed state of a MPIJob.
Appears in:
| Field | Description |
|---|---|
tasks Tasks array | Individual task status details of the job. |
aggregate Aggregate | |
phase JobPhase | Provides a simple, high-level summary of where the Job is in its lifecycle. Note that this is NOT indended to be a comprehensive state machine. |
conditions JobCondition array | The latest available observations of an object's current state. |
MPIReplicaType
Underlying type: string
Appears in:
ReplicaSpec
ReplicaSpec defines the desired state of replicas.
Appears in:
| Field | Description |
|---|---|
type MPIReplicaType | Replica type. |
replicas integer | The desired number of replicas of this replica type. Defaults to 1. |
restartPolicy RestartPolicy | Restart policy for replicas of this replica type. One of Always, OnFailure, Never. Optional: Default to OnFailure. |
template PodTemplateSpec | Defines the template used to create pods. |
RestartPolicy
RestartPolicy describes how the replica should be restarted.
Appears in:
| Field | Description |
|---|---|
policy RestartPolicyType | The policy to restart finished replica. |
limit integer | The maximum number of restarts. Optional: Default to 0. |
RestartPolicyType
Underlying type: string
Appears in:
RunPolicy
RunPolicy encapsulates various runtime policies of the MPI job, for example how to clean up resources.
Appears in:
| Field | Description |
|---|---|
cleanUpWorkers boolean | If worker replicas should be cleand up after they finish. Defaults false. |
SSHConfig
SSHConfig specifies various configurations for running the SSH daemon (sshd).
Appears in:
| Field | Description |
|---|---|
sshAuthMountPath string | SSHAuthMountPath is the directory where SSH keys are mounted. Defaults to "/root/.ssh". |
sshdPath string |