Machine parameters

Note

One can load, modify, and export the input file by using our effective web-based tool DP-GUI. All parameters below can be set in DP-GUI. By clicking “SAVE JSON”, one can download the input file.

machine:
type: dict
argument path: machine
batch_type:
type: str
argument path: machine/batch_type

The batch job system type. Option: Shell, Lebesgue, SlurmJobArray, LSF, DpCloudServer, Torque, DistributedShell, Slurm, PBS

local_root:
type: str
argument path: machine/local_root

The dir where the tasks and relating files locate. Typically the project dir.

remote_root:
type: str, optional
argument path: machine/remote_root

The dir where the tasks are executed on the remote machine. Only needed when context is not lazy-local.

clean_asynchronously:
type: bool, optional, default: False
argument path: machine/clean_asynchronously

Clean the remote directory asynchronously after the job finishes.

Depending on the value of context_type, different sub args are accepted.

context_type:
type: str (flag key)
argument path: machine/context_type
possible choices: LocalContext, LazyLocalContext, DpCloudServerContext, LebesgueContext, SSHContext, HDFSContext

The connection used to remote machine. Option: LazyLocalContext, LocalContext, SSHContext, LebesgueContext, HDFSContext, DpCloudServerContext

When context_type is set to LocalContext (or its aliases localcontext, Local, local):

remote_profile:
type: dict, optional
argument path: machine[LocalContext]/remote_profile

The information used to maintain the connection with remote machine. This field is empty for this context.

When context_type is set to LazyLocalContext (or its aliases lazylocalcontext, LazyLocal, lazylocal):

remote_profile:
type: dict, optional
argument path: machine[LazyLocalContext]/remote_profile

The information used to maintain the connection with remote machine. This field is empty for this context.

When context_type is set to DpCloudServerContext (or its aliases dpcloudservercontext, DpCloudServer, dpcloudserver):

remote_profile:
type: dict
argument path: machine[DpCloudServerContext]/remote_profile

The information used to maintain the connection with remote machine.

email:
type: str
argument path: machine[DpCloudServerContext]/remote_profile/email

Email

password:
type: str
argument path: machine[DpCloudServerContext]/remote_profile/password

Password

program_id:
type: int
argument path: machine[DpCloudServerContext]/remote_profile/program_id

Program ID

input_data:
type: dict
argument path: machine[DpCloudServerContext]/remote_profile/input_data

Configuration of job

When context_type is set to LebesgueContext (or its aliases lebesguecontext, Lebesgue, lebesgue):

remote_profile:
type: dict
argument path: machine[LebesgueContext]/remote_profile

The information used to maintain the connection with remote machine.

email:
type: str
argument path: machine[LebesgueContext]/remote_profile/email

Email

password:
type: str
argument path: machine[LebesgueContext]/remote_profile/password

Password

program_id:
type: int
argument path: machine[LebesgueContext]/remote_profile/program_id

Program ID

input_data:
type: dict
argument path: machine[LebesgueContext]/remote_profile/input_data

Configuration of job

When context_type is set to SSHContext (or its aliases sshcontext, SSH, ssh):

remote_profile:
type: dict
argument path: machine[SSHContext]/remote_profile

The information used to maintain the connection with remote machine.

hostname:
type: str
argument path: machine[SSHContext]/remote_profile/hostname

hostname or ip of ssh connection.

username:
type: str
argument path: machine[SSHContext]/remote_profile/username

username of target linux system

password:
type: str, optional
argument path: machine[SSHContext]/remote_profile/password

(deprecated) password of linux system. Please use SSH keys instead to improve security.

port:
type: int, optional, default: 22
argument path: machine[SSHContext]/remote_profile/port

ssh connection port.

key_filename:
type: NoneType | str, optional, default: None
argument path: machine[SSHContext]/remote_profile/key_filename

key filename used by ssh connection. If left None, find key in ~/.ssh or use password for login

passphrase:
type: NoneType | str, optional, default: None
argument path: machine[SSHContext]/remote_profile/passphrase

passphrase of key used by ssh connection

timeout:
type: int, optional, default: 10
argument path: machine[SSHContext]/remote_profile/timeout

timeout of ssh connection

totp_secret:
type: NoneType | str, optional, default: None
argument path: machine[SSHContext]/remote_profile/totp_secret

Time-based one time password secret. It should be a base32-encoded string extracted from the 2D code.

When context_type is set to HDFSContext (or its aliases hdfscontext, HDFS, hdfs):

remote_profile:
type: dict, optional
argument path: machine[HDFSContext]/remote_profile

The information used to maintain the connection with remote machine. This field is empty for this context.