PODTools.conf

Back to documentation index

PODTools is controlled by podtools.conf

A global template for podtools.conf is always installed at /opt/scyld/podtools/podtools.conf.template

The template file leaves all options commented out, and set to their default values. So if the option is not un-commented, the value shown will be the one used.

podtools.conf template

# Global Options for POD Tools
[podtools]
#user=
#address=127.0.0.1
#port=443
#logout=false
#ssl=True
#auth_type=cloudauth
#cloudauth_api_key=
#cloudauth_api_secret=
#ssh_auth_address=
#ssh_auth_port=2200
#password=
#loglevel=ERROR

# Options for POD Shell
[podsh]
#overwrite=true
#sched=TRQ
#stageinmaxsize=0
#stageoutmaxsize=0
#hash_algo=md5

Options & Values

podtools section

Option Value Meaning
user <name> The user name to use when communicating with POD. If left commented out, PODTools well send the username that you are logged with on your local machine
address <IP Address> The IP Address of the POD webserver
port <port number> The Port number of the POD webserver
logout false Do not automatically logout after each request
true Automatically logout after reach request
ssl true Encrypt communication with POD using SSL/TLS
false Do not use SSL. Note POD will not accept non-SSL traffic
authtype cloudauth Use API key and secret for token-based auth
password Prompt for a password when authenticating with POD
publickeyUse SSH public/private key-pair for authentication with POD
cloudauth_api_key KEY API key for your POD account
cloudauth_api_secret SECRET API secret for your POD account
ssh_auth_address <IP Address> IP Address of server to use during SSH auth. If not set, value of address above is used. Only valid if authtype is publickey
ssh_auth_port <port number> The Port number to use for SSH auth. Only valid if authtype is publickey
password <your POD password> Your POD password. Note If you place your password in here, you will not be prompted for it. Make sure your .conf file has correct read permissions
loglevel ERROR Only show ERROR messages and higher in podtools.log
WARNING Show WARNING messages and higher
INFO Show INFO messages and higher
DEBUG Show DEBUG messages and higher. This will generate a lot of log messages

podsh section

Option Value Meaning
overwrite true Overwrite job script of same name if it exists
false Do not overwrite existing job scripts
sched TRQ Submit job using the TORQUE scheduler. Job script must be written using TORQUE syntax
SGE Submit job using the SGE scheduler. Job script must be written using SGE syntax
stageinmaxsize <size> Abort job submission if combined size of files to stagein is greater than this number. 0 means unlimited. Suffixes are K (KB) M (MB) G (GB) T (TB)
stageoutmaxsize <size> Abort data stageout if combined size of files to download is greater than this number. 0 means unlimited. Suffixes are K (KB) M (MB) G (GB) T (TB)
hash_algo <algo>

Hash algorithm to use for verifying file integrity. Valid values are md5, sha1, sha224, sha256, sha384, sha512. Should only need adjusting if performance problems arise.