API Reference¶
Packages¶
batch.tensorstack.dev/v1beta1¶
Package v1beta1 contains API Schema definitions for the batch v1beta1 API group
Resource Types¶
MPIJob¶
MPIJob is the Schema for the mpijobs API
Appears in: - MPIJobList
| 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: - MPIJob
| Field | Description |
|---|---|
worker WorkerConfig |
Specifications for the worker replicas. |
mca object (keys:string, values:string) |
Open MPI uses Modular Component Architecture (MCA) parameters to provide a way to tune your runtime environment. |
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. |
mpiHome string |
Open MPI installation path. |
scheduler SchedulePolicy |
Identifies the preferred scheduler for allocating resources to replicas. Defaults to cluster default scheduler. Use k8s default scheduler by default. |
MPIJobStatus¶
MPIJobStatus represents the observed state of a MPIJob.
Appears in: - MPIJob
| 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. |
RunPolicy¶
RunPolicy encapsulates various runtime policies of the MPI job, for example how to clean up resources.
Appears in: - MPIJobSpec
| 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: - MPIJobSpec
| Field | Description |
|---|---|
sshAuthMountPath string |
SSHAuthMountPath is the directory where SSH keys are mounted. Defaults to "/root/.ssh". |
sshdPath string |
WorkerConfig¶
WorkerConfig defines the configurations for MPI worker replicas.
Appears in: - MPIJobSpec
| Field | Description |
|---|---|
replicas integer |
The number of workers to launch. Default 1. |
extraMPIArgs string array |
Extra args for mpirun. |
cmd 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. |
template PodTemplateSpec |
Defines the pod template used to create workers. Users are responsible for ensuring that container images and configurations are properly set to guarantee the worker operates in the state anticipated by the launcher. |