extensions/net.sf.basedb.opengrid/trunk/opengrid-config.xml

Code
Comments
Other
Rev Date Author Line
4254 25 Nov 16 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
4254 25 Nov 16 nicklas 2 <opengrid>
4254 25 Nov 16 nicklas 3   
4294 11 Jan 17 nicklas 4   <!-- 
4294 11 Jan 17 nicklas 5     One or more "cluster" tags, each one should define
5981 07 Jul 20 nicklas 6     a unique user + cluster combination. The 
4294 11 Jan 17 nicklas 7     following attributes are used:
4294 11 Jan 17 nicklas 8     
6688 21 Apr 22 nicklas 9     type: The type of cluster. Valid values are "opengrid", "slurm" and "direct".
5981 07 Jul 20 nicklas 10         "opengrid" is assumed if no value is specified.
4294 11 Jan 17 nicklas 11     name: A readable name intended to be used when interfacing with users
5981 07 Jul 20 nicklas 12     address: Network address or number to the primary cluster host
4294 11 Jan 17 nicklas 13     port: Port number that accepts SSH connections (optional, default=22)
4451 10 Apr 17 nicklas 14     fingerprint: The SSH fingerprint. This can be either the MD5 hash formatted
4451 10 Apr 17 nicklas 15       as 16 two-digit hexadecimal numbers separated with ':' or the SHA-256
4451 10 Apr 17 nicklas 16       hash in Base64 encoding.
5981 07 Jul 20 nicklas 17     user: Username to use when connecting to the cluster
5981 07 Jul 20 nicklas 18     password: Password to use when connecting to the cluster
4750 16 Apr 18 nicklas 19         Required unless private-key authentication is enabled (see below).
4294 11 Jan 17 nicklas 20     
4294 11 Jan 17 nicklas 21     Internally, an ID for each cluster is created using the username,
4294 11 Jan 17 nicklas 22     address and port number (example: smith@server.com:22). The ID can be
5981 07 Jul 20 nicklas 23     used by other extensions to reference and work with clusters.
4294 11 Jan 17 nicklas 24     The ID must be unique.
4294 11 Jan 17 nicklas 25   -->
4254 25 Nov 16 nicklas 26   <cluster
6688 21 Apr 22 nicklas 27     type="opengrid|slurm|direct"
4254 25 Nov 16 nicklas 28     name="Display name of the host"
4254 25 Nov 16 nicklas 29     address="ip-address.to.the.host"
4254 25 Nov 16 nicklas 30     port="22"
4254 25 Nov 16 nicklas 31     fingerprint="Fingerprint of the public key for this server"
4254 25 Nov 16 nicklas 32     user=""
4294 11 Jan 17 nicklas 33     password=""
4254 25 Nov 16 nicklas 34     >
4294 11 Jan 17 nicklas 35     
4750 16 Apr 18 nicklas 36     <!-- [Optional]
4750 16 Apr 18 nicklas 37       A path to a private key file to use when connecting to
5981 07 Jul 20 nicklas 38       the cluster. Takes priority over password-authentication
4750 16 Apr 18 nicklas 39       if specified. If the private key is password-protected the
4750 16 Apr 18 nicklas 40       password should be specified. Auto-detection of the key type
4750 16 Apr 18 nicklas 41       should work in most cases, but a type can be set explictely:
4750 16 Apr 18 nicklas 42       OpenSSH, OpenSSHv1, PuTTY, PKCS5 or PKCS8
4750 16 Apr 18 nicklas 43     -->
4750 16 Apr 18 nicklas 44     <!-- <key-file password="" type="">/path/to/.ssh/private/key</key-file> -->
4750 16 Apr 18 nicklas 45     
4294 11 Jan 17 nicklas 46     <!-- [Required] 
4294 11 Jan 17 nicklas 47       Specify a path that BASE can use to send job scripts and data files
5981 07 Jul 20 nicklas 48       to/from the cluster. This folder must be accessible using the
4294 11 Jan 17 nicklas 49       same path from both the controller and all nodes in the cluster. Subfolders
4294 11 Jan 17 nicklas 50       will be created inside the specified folder and they are NOT automatically
4294 11 Jan 17 nicklas 51       deleted after jobs has finished.
4294 11 Jan 17 nicklas 52     -->
4254 25 Nov 16 nicklas 53     <job-folder>/path/to/folder-for-jobs</job-folder>
4294 11 Jan 17 nicklas 54     
4294 11 Jan 17 nicklas 55     <!-- [Optional]
4294 11 Jan 17 nicklas 56       Specify a folder to use for temporary working data. The default
5981 07 Jul 20 nicklas 57       is to use the folder assigned by the cluster ($TMPDIR).
4294 11 Jan 17 nicklas 58       This folder is typically deleted once the job has finished.
4294 11 Jan 17 nicklas 59     -->
4352 13 Feb 17 nicklas 60     <!-- <tmp-folder>${TMPDIR}</tmp-folder> -->
4294 11 Jan 17 nicklas 61     
4294 11 Jan 17 nicklas 62     
4294 11 Jan 17 nicklas 63     <!-- [Optional]
4294 11 Jan 17 nicklas 64       Specify a folder to use for temporary working data running a job in debug
4294 11 Jan 17 nicklas 65       mode. The default is to use the 'tmp-folder'. A different folder can
4294 11 Jan 17 nicklas 66       be specified to avoid the automatic cleanup.
4294 11 Jan 17 nicklas 67     -->
4264 14 Dec 16 nicklas 68     <!-- <tmp-folder-debug></tmp-folder-debug> -->
4294 11 Jan 17 nicklas 69     
4294 11 Jan 17 nicklas 70     <!-- [Optional]
6688 21 Apr 22 nicklas 71       Specify a command to run on the cluster to get the current
4294 11 Jan 17 nicklas 72       date+time in YYYY-MM-DD hh:mm:ss format. The default setting probably 
4294 11 Jan 17 nicklas 73       works in most cases (date +'%Y-%m-%d %T')
4294 11 Jan 17 nicklas 74     -->
4254 25 Nov 16 nicklas 75     <!-- <date-command></date-command> -->
4294 11 Jan 17 nicklas 76     
4294 11 Jan 17 nicklas 77     <!-- [Optional]
6688 21 Apr 22 nicklas 78       Specify a command to run on the cluster to get information
4294 11 Jan 17 nicklas 79       about the operating system. This is for informational purposes only
4294 11 Jan 17 nicklas 80       and can be changed to something else in case this information is 
4294 11 Jan 17 nicklas 81       considered sensitieve. The default value is (uname -srmo).
4294 11 Jan 17 nicklas 82     -->
4257 30 Nov 16 nicklas 83     <!-- <host-info-command></host-info-command> -->
4294 11 Jan 17 nicklas 84     
4294 11 Jan 17 nicklas 85     <!-- [Optional]
6688 21 Apr 22 nicklas 86       Specify a command to run on the cluster to get information
6688 21 Apr 22 nicklas 87       about the job scheduler software. This is currently for informational
4294 11 Jan 17 nicklas 88       purposes only, but may be needed for feature-detection in the future.
6688 21 Apr 22 nicklas 89       The default value is different depending on the cluster type.
4294 11 Jan 17 nicklas 90     -->
4257 30 Nov 16 nicklas 91     <!-- <opengrid-info-command></opengrid-info-command> -->
4294 11 Jan 17 nicklas 92     
4294 11 Jan 17 nicklas 93     <!-- [Optional]
4294 11 Jan 17 nicklas 94       Specify the external ID of a Job agent that has been defined in BASE.
4294 11 Jan 17 nicklas 95       The job agent is used as a permission proxy for the cluster definition.
4294 11 Jan 17 nicklas 96       Only users that have been given USE permission to the job agent are
4294 11 Jan 17 nicklas 97       allowed to use the cluster. Clusters without a job agent proxy can be
4294 11 Jan 17 nicklas 98       used by all users.
4294 11 Jan 17 nicklas 99     -->
4255 28 Nov 16 nicklas 100     <!-- <job-agent-id></job-agent-id> -->
4275 19 Dec 16 nicklas 101     
6827 31 Aug 22 nicklas 102     <!-- List of custom options for the cluster.  Options are specified -->
6827 31 Aug 22 nicklas 103     <!-- as key=value where the tag name is used as key and tag contents -->
6827 31 Aug 22 nicklas 104     <!-- as the value -->
6827 31 Aug 22 nicklas 105     <options>
6827 31 Aug 22 nicklas 106       <!-- Enable this option to disable the use of 'sacct' command to get -->
6827 31 Aug 22 nicklas 107       <!-- information about finished jobs in Slurm clusters. Instead, a   -->
6827 31 Aug 22 nicklas 108       <!-- custom 'status'-file is used but this may be less reliable. -->
6827 31 Aug 22 nicklas 109       <!-- <slurm-accounting-disabled>1</slurm-accounting-disabled> -->
7380 18 Oct 23 nicklas 110       
7380 18 Oct 23 nicklas 111       <!-- Enable this option to automatically remove job folders -->
7380 18 Oct 23 nicklas 112       <!-- that are older than the specified number of DAYS -->
7380 18 Oct 23 nicklas 113       <!-- auto-remove-job-folders>14</auto-remove-job-folders> -->
6827 31 Aug 22 nicklas 114     </options>
6827 31 Aug 22 nicklas 115     
4294 11 Jan 17 nicklas 116     <!-- 
4294 11 Jan 17 nicklas 117       List of nodes that can be used for some quick actions that is not suitable 
4294 11 Jan 17 nicklas 118       to be executed on the controller node, eg. picard CheckIlluminaDirectory 
4294 11 Jan 17 nicklas 119       The nodes are typically not used by this extension but can be 
4294 11 Jan 17 nicklas 120       programmatically accessed by other extensions.
4294 11 Jan 17 nicklas 121     -->
4275 19 Dec 16 nicklas 122     <nodes>
4275 19 Dec 16 nicklas 123       <node name="name-of-node" />
4275 19 Dec 16 nicklas 124     </nodes>
4275 19 Dec 16 nicklas 125     
4254 25 Nov 16 nicklas 126   </cluster>
4254 25 Nov 16 nicklas 127 </opengrid>

Generated on Tue Nov 21 03:28:43 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)