This is an outdated version of the HTCondor Manual. You can find current documentation at http://htcondor.org/manual.

Next: condor_check_userlogs Up: 12. Command Reference Manual Previous: condor_advertise Contents Index

Subsections

condor_annex

Add cloud resources to the pool.

Synopsis

condor_annex -help

condor_annex -setup [/full/path/to/access/key/file [/full/path/to/secret/key/file]]

condor_annex [-aws-on-demand] -annex-name name of the annex -count integer number of instances [-aws-on-demand-*] [common options]

condor_annex [-aws-spot-fleet] -annex-name name of the annex -slots integer weight [-aws-spot-fleet-*] [common options]

condor_annex -annex-name name of the annex -duration hours

condor_annex -annex-name name of the annex -status [-classad]

condor_annex -check-setup

condor_annex adds clouds resources to the pool. (``The pool'' is determined in the usual manner for HTCondor daemons and tools.) Version 8.7.2 supports only Amazon Web Services (`AWS'). To add ``on-demand'' instances, use the third form listed above; to add ``spot'' instances, use the fourth. For an explanation of terms, consult either the HTCondor manual (chapter 6) or the AWS documentation.

Using condor_annex with AWS requires a one-time setup procedure performed by invoking condor_annex with the -setup flag (the second form listed above). You may check if this procedure has been performed with the -check-setup flag (the seventh form listed above).

To reset the lease on an existing annex, invoke condor_annex with only the -annex-name option and -duration flag (the fifth form listed above).

To determine which of the instances previously requested for a particular annex are not currently in the pool, invoke condor_annex with the -status flag and the -annex-name option (the sixth form listed above). The output of this command is intended to be human-readable; specifying the -classad flag will produce the same information in ClassAd format.

Common options are listed first, followed by options specific to AWS, followed by options specific to AWS' on-demand instances, followed by options specific to AWS' spot instances, followed by options intended for use by experts.

Options

-help: Print a usage reminder.
-setup [/full/path/to/access/key/file /full/path/to/secret/key/file]: Do the first-time setup.
-duration hours: Set the maximum lease duration in decimal hours. After this amount of time, all instances will terminated, regardless of their idleness. Defaults to 50 minutes.
-idle hours: Set the maximum idle duration in decimal hours. An instance idle for longer than this duration will terminate itself. Defaults to 15 minutes.
-config-dir /full/path/to/directory: Copy the contents of /full/path/to/directory to each instance's configuration directory.
-owner owner[, owner]*: Configure the annex so that only owner may start jobs there. By default, configure the annex so that only the user running condor_annex may start jobs there.
-no-owner: Configure the annex so that anyone in the pool may use the annex.
-aws-user-data user-data: Set the instance user data to user-data.
-aws-user-data-file /full/path/to/file: Set the instance user data to the contents of the file /full/path/to/file.
-aws-default-user-data user-data: Set the instance user data to user-data, if it's not already set. Only applies to spot fleet requests.
-aws-default-user-data-file /full/path/to/file: Set the instance user data to the contents of the file /full/path/to/file, if it's not already set. Only applies to spot fleet requests.
-aws-on-demand-instance-type instance-type: This annex will requests instances of type instance-type. The default for v8.7.1 is `m4.large'.
-aws-on-demand-ami-id ami-id: This annex will start instances of the AMI ami-id. The default for v8.7.1 is `ami-35b13223', a GPU-compatible Amazon Linux image with HTCondor pre-installed.
-aws-on-demand-security-group-ids group-id[,group-id]: This annex will start instances with the listed security group IDs. The default is the security group created by -setup.
-aws-on-demand-key-name key-name: This annex will start instances with the key pair named key-name. The default is the key pair created by -setup.
-aws-spot-fleet-config-file /full/path/to/file: Use the JSON blob in /full/path/to/file for the spot fleet request.
-aws-access-key-file /full/path/to/access-key-file: Experts only.
-aws-secret-key-file /full/path/to/secret-key-file: Experts only.
-aws-ec2-url https://ec2.<region>.amazonaws.com: Experts only.
-aws-events-url https://events.<region>.amazonaws.com: Experts only.
-aws-lambda-url https://lambda.<region>.amazonaws.com: Experts only.
-aws-s3-url https://s3.<region>.amazonaws.com: Experts only.
-aws-spot-fleet-lease-function-arn sfr-lease-function-arn: Developers only.
-aws-on-demand-lease-function-arn odi-lease-function-arn: Developers only.
-aws-on-demand-instance-profile-arn instance-profile-arn: Developers only.

General Remarks

As of v8.7.1, only AWS is supported. The AMI configured by setup runs HTCondor v8.6.0 on Amazon Linux 2016.09, and the default instance type is ``m4.large''. The default AMI has the appropriate software for AWS' ``p2'' family of GPU instance types.

Examples

To start an on-demand annex named `MyFirstAnnex' with one core, using the default AMI and instance type, run

  condor_annex -count 1 -annex-name MyFirstAnnex

You will be asked to confirm that the defaults are what you want.

As of 2017-04-17, the following example will cost a minimum of $90.

To start an on-demand annex with 100 GPUs that job owners `big' and `little' may use (be sure to include yourself!), run

  condor_annex -count 100 -annex-name MySecondAnnex \
    -aws-on-demand-instance-type p2.xlarge -owner "big, little"

condor_annex

Synopsis

Description

Options

General Remarks

Examples

Exit Status

Author

Copyright