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

OPTIONS

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

EXIT STATUS

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

EXAMPLES

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

AUTHOR

253       HTCondor Team
254
256       1990-2020, Center for  High  Throughput  Computing,  Computer  Sciences
257       Department,  University of Wisconsin-Madison, Madison, WI, US. Licensed
258       under the Apache License, Version 2.0.
259
260
261
262
2638.8                              Aug 06, 2020                CONDOR_INSTALL(1)
Impressum