1CONDOR_INSTALL(1)               HTCondor Manual              CONDOR_INSTALL(1)
2
3
4

NAME

6       condor_install - HTCondor Manual
7
8       Configure or install HTCondor
9
10
11
12
13

SYNOPSIS

15       condor_configure or condor_install [--help] [--usage]
16
17       condor_configure   or   condor_install  [--install[=<path/to/release>]]
18       [--install-dir=<path>]      [--prefix=<path>]      [--local-dir=<path>]
19       [--make-personal-condor] [--bosco] [--type = < submit, execute, manager
20       >]  [--central-manager  =  <  hostname>]  [--owner  =  <  ownername  >]
21       [--maybe-daemon-owner]  [--install-log = < file >] [--overwrite] [--ig‐
22       nore-missing-libs] [--force] [--no-env-scripts] [--env-scripts-dir =  <
23       directory >] [--backup] [--credd] [--verbose]
24

DESCRIPTION

26       condor_configure  and  condor_install refer to a single script that in‐
27       stalls and/or configures HTCondor on Unix machines. As the names imply,
28       condor_install is intended to perform a HTCondor installation, and con‐
29       dor_configure is intended to configure (or reconfigure) an existing in‐
30       stallation. Both will run with Perl 5.6.0 or more recent versions.
31
32       condor_configure  (and condor_install) are designed to be run more than
33       one time where required. It can install HTCondor when  invoked  with  a
34       correct configuration via
35
36          condor_install
37
38       or
39
40          condor_configure --install
41
42       or, it can change the configuration files when invoked via
43
44          condor_configure
45
46       Note  that  changes in the configuration files do not result in changes
47       while HTCondor is running. To effect changes while HTCondor is running,
48       it  is  necessary  to further use the condor_reconfig or condor_restart
49       command. condor_reconfig is required where the currently executing dae‐
50       mons  need  to  be informed of configuration changes. condor_restart is
51       required where the options --make-personal-condor or --type  are  used,
52       since these affect which daemons are running.
53
54       Running condor_configure or condor_install with no options results in a
55       usage screen being printed. The --help option can be used to display  a
56       full help screen.
57
58       Within  the  options given below, the phrase release directories is the
59       list of directories that are released  with  HTCondor.  This  list  in‐
60       cludes:  bin,  etc, examples, include, lib, libexec, man, sbin, sql and
61       src.
62

OPTIONS

64          -help  Print help screen and exit
65
66          -usage Print short usage and exit
67
68          -install
69                 Perform installation, assuming that the current  working  di‐
70                 rectory contains the release directories. Without further op‐
71                 tions, the configuration is that of a  Personal  HTCondor,  a
72                 complete  one-machine  pool.  If used as an upgrade within an
73                 existing installation directory, existing configuration files
74                 and local directory are preserved. This is the default behav‐
75                 ior of condor_install.
76
77          -install-dir=<path>
78                 Specifies the path where HTCondor should be installed or  the
79                 path  where  it already is installed. The default is the cur‐
80                 rent working directory.
81
82          -prefix=<path>
83                 This is an alias for -install-dir.
84
85          -local-dir=<path>
86                 Specifies the location of the local directory, which  is  the
87                 directory  that  generally  contains  the local (machine-spe‐
88                 cific) configuration file as well as  the  directories  where
89                 HTCondor  daemons  write  their  run-time information (spool,
90                 log, execute).  This location is indicated by  the  LOCAL_DIR
91                 variable in the configuration file. When installing (that is,
92                 if -install is  specified),  condor_configure  will  properly
93                 create the local directory in the location specified. If none
94                 is specified, the default value is given by the evaluation of
95                 $(RELEASE_DIR)/local.$(HOSTNAME).
96
97                 During  subsequent  invocations of condor_configure (that is,
98                 without the -install option), if  the  -local-dir  option  is
99                 specified,  the  new  directory  will be created and the log,
100                 spool and execute directories will be moved there from  their
101                 current location.
102
103          -make-personal-condor
104                 Installs  and configures for Personal HTCondor, a fully-func‐
105                 tional, one-machine pool.
106
107          -bosco Installs and configures Bosco, a personal HTCondor that  sub‐
108                 mits jobs to remote batch systems.
109
110          -type= < submit, execute, manager >
111                 One  or  more of the types may be listed. This determines the
112                 roles that a machine may play in a pool. In general, any  ma‐
113                 chine  can  be  a submit and/or execute machine, and there is
114                 one central manager per pool. In the case of a  Personal  HT‐
115                 Condor, the machine fulfills all three of these roles.
116
117          -central-manager=<hostname>
118                 Instructs the current HTCondor installation to use the speci‐
119                 fied machine as the central manager. This modifies  the  con‐
120                 figuration variable COLLECTOR_HOST to point to the given host
121                 name. The central manager  machine's  HTCondor  configuration
122                 needs  to be independently configured to act as a manager us‐
123                 ing the option -type=manager.
124
125          -owner=<ownername>
126                 Set configuration such that HTCondor daemons will be executed
127                 as  the  given owner. This modifies the ownership on the log,
128                 spool and execute directories and sets the  CONDOR_IDS  value
129                 in  the  configuration  file, to ensure that HTCondor daemons
130                 start up as the specified effective user. This is only appli‐
131                 cable  when  condor_configure  is  run by root. If not run as
132                 root, the owner is the user running the condor_configure com‐
133                 mand.
134
135          -maybe-daemon-owner
136                 If  -owner  is  not  specified and no appropriate user can be
137                 found to run Condor, then this option will allow  the  daemon
138                 user  to  be  selected. This option is rarely needed by users
139                 but can be useful for scripts that invoke condor_configure to
140                 install Condor.
141
142          -install-log=<file>
143                 Save  information  about  the  installation  in the specified
144                 file. This is normally only needed when  condor_configure  is
145                 called  by  a higher-level script, not when invoked by a per‐
146                 son.
147
148          -overwrite
149                 Always overwrite the contents of the sbin  directory  in  the
150                 installation  directory.  By default, condor_install will not
151                 install if it finds an existing sbin directory with  HTCondor
152                 programs  in  it. In this case, condor_install will exit with
153                 an error message. Specify -overwrite or -backup to tell  con‐
154                 dor_install what to do.
155
156                 This  prevents  condor_install  from moving an sbin directory
157                 out of the way that it should not move. This is  particularly
158                 useful  when trying to install HTCondor in a location used by
159                 other things (/usr, /usr/local, etc.) For example: condor_in‐
160                 stall -prefix=/usr will not move /usr/sbin out of the way un‐
161                 less you specify the -backup option.
162
163                 The -backup behavior is used to prevent  condor_install  from
164                 overwriting  running  daemons  - Unix semantics will keep the
165                 existing binaries running, even if they have been moved to  a
166                 new directory.
167
168          -backup
169                 Always  backup  the sbin directory in the installation direc‐
170                 tory.  By default, condor_install  will  not  install  if  it
171                 finds  an  existing  sbin directory with HTCondor programs in
172                 it. In this case, condor_install with exit with an error mes‐
173                 sage.  You  must  specify  -overwrite or -backup to tell con‐
174                 dor_install what to do.
175
176                 This prevents condor_install from moving  an  sbin  directory
177                 out  of the way that it should not move. This is particularly
178                 useful if you're trying to install  HTCondor  in  a  location
179                 used  by  other  things (/usr, /usr/local, etc.) For example:
180                 condor_install -prefix=/usr will not move  /usr/sbin  out  of
181                 the way unless you specify the -backup option.
182
183                 The  -backup  behavior is used to prevent condor_install from
184                 overwriting running daemons - Unix semantics  will  keep  the
185                 existing  binaries running, even if they have been moved to a
186                 new directory.
187
188          -ignore-missing-libs
189                 Ignore missing shared libraries that  are  detected  by  con‐
190                 dor_install.  By  default, condor_install will detect missing
191                 shared libraries such as libstdc++.so.5  on  Linux;  it  will
192                 print  messages  and  exit if missing libraries are detected.
193                 The -ignore-missing-libs will  cause  condor_install  to  not
194                 exit,  and  to  proceed  with the installation if missing li‐
195                 braries are detected.
196
197          -force This is equivalent to enabling both the -overwrite  and  -ig‐
198                 nore-missing-libs command line options.
199
200          -no-env-scripts
201                 By  default,  condor_configure writes simple sh and csh shell
202                 scripts which can be sourced by their  respective  shells  to
203                 set  the user's PATH and CONDOR_CONFIG environment variables.
204                 This option prevents condor_configure from  generating  these
205                 scripts.
206
207          -env-scripts-dir=<directory>
208                 By  default,  the  simple  sh  and  csh  shell  scripts  (see
209                 -no-env-scripts for details) are created in the  root  direc‐
210                 tory  of  the  HTCondor installation. This option causes con‐
211                 dor_configure to generate these scripts in the specified  di‐
212                 rectory.
213
214          -credd Configure  the  the  condor_credd  daemon (credential manager
215                 daemon).
216
217          -verbose
218                 Print information about changes to configuration variables as
219                 they occur.
220

EXIT STATUS

222       condor_configure  will  exit  with a status value of 0 (zero) upon suc‐
223       cess, and it will exit with a nonzero value upon failure.
224

EXAMPLES

226       Install HTCondor on the machine (machine1@cs.wisc.edu) to be the pool's
227       central  manager.  On  machine1, within the directory that contains the
228       unzipped HTCondor distribution directories:
229
230          % condor_install --type=submit,execute,manager
231
232       This will allow the machine to submit and execute HTCondor jobs, in ad‐
233       dition to being the central manager of the pool.
234
235       To  change  the configuration such that machine2@cs.wisc.edu is an exe‐
236       cute-only machine (that is, a dedicated computing node) within  a  pool
237       with central manager on machine1@cs.wisc.edu, issue the command on that
238       machine2@cs.wisc.edu from within the directory where  HTCondor  is  in‐
239       stalled:
240
241          % condor_configure --central-manager=machine1@cs.wisc.edu --type=execute
242
243       To  change the location of the LOCAL_DIR directory in the configuration
244       file, do (from the directory where HTCondor is installed):
245
246          % condor_configure --local-dir=/path/to/new/local/directory
247
248       This will move the log,spool,execute  directories  to  /path/to/new/lo‐
249       cal/directory from the current local directory.
250

AUTHOR

252       HTCondor Team
253
255       1990-2022,  Center for High Throughput Computing, Computer Sciences De‐
256       partment, University of Wisconsin-Madison, Madison,  WI,  US.  Licensed
257       under the Apache License, Version 2.0.
258
259
260
261
2628.8                              Jun 13, 2022                CONDOR_INSTALL(1)
Impressum