Skip to content

Commit d763351

Browse files
committed
Tweaks; mention which file is where in the section titles
1 parent 2e8ab91 commit d763351

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

README.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,12 @@ This is useful, if you have a complex configuration for a given that can't be se
134134
Configuration sections
135135
----------------------
136136

137-
The OSG configuration is divided into sections with each section starting with a section name in square brackets (e.g. `[Section 1]`). The configuration is split in multiple files and options form one section can be in more than one files.
137+
The OSG configuration is divided into sections with each section starting with a section name in square brackets (e.g. `[Section 1]`).
138+
The configuration is split in multiple files and options form one section can be in more than one files.
139+
All of the configuration files listed below are in `/etc/osg/config.d/`.
138140

139-
The following sections give an overview of the options for each of the sections of the configuration files that `osg-configure` uses.
140141

141-
142-
143-
### Bosco ###
142+
### 20-bosco.ini / [Bosco] section ###
144143

145144
This section is contained in `/etc/osg/config.d/20-bosco.ini` which is provided by the `osg-configure-bosco` RPM.
146145

@@ -153,9 +152,10 @@ This section is contained in `/etc/osg/config.d/20-bosco.ini` which is provided
153152
| **ssh\_key** | String | The location of the ssh key, as created above. |
154153

155154

156-
### Condor ###
155+
### 20-condor.ini / [Condor] section ###
157156

158-
This section describes the parameters for a Condor jobmanager if it's being used in the current CE installation. If Condor is not being used, the `enabled` setting should be set to `False`.
157+
This section describes the parameters for a Condor jobmanager if it's being used in the current CE installation.
158+
If Condor is not being used, the `enabled` setting should be set to `False`.
159159

160160
This section is contained in `/etc/osg/config.d/20-condor.ini` which is provided by the `osg-configure-condor` RPM.
161161

@@ -166,7 +166,7 @@ This section is contained in `/etc/osg/config.d/20-condor.ini` which is provided
166166
| condor\_config | String | This should be set to be path where the condor\_config file is located. If this is set to a blank variable, DEFAULT or UNAVAILABLE, the `osg-configure` script will try to get this from the CONDOR\_CONFIG environment variable if available otherwise it will use `/etc/condor/condor_config`, the default for the RPM installation. |
167167

168168

169-
### LSF ###
169+
### 20-lsf.ini / [LSF] section ###
170170

171171
This section describes the parameters for a LSF jobmanager if it's being used in the current CE installation. If LSF is not being used, the `enabled` setting should be set to `False`.
172172

@@ -178,7 +178,7 @@ This section is contained in `/etc/osg/config.d/20-lsf.ini` which is provided by
178178
| lsf\_location | String | This should be set to be directory where lsf is installed |
179179

180180

181-
### PBS ###
181+
### 20-pbs.ini / [PBS] section ###
182182

183183
This section describes the parameters for a pbs jobmanager if it's being used in the current CE installation. If PBS is not being used, the `enabled` setting should be set to `False`.
184184

@@ -192,7 +192,7 @@ This section is contained in `/etc/osg/config.d/20-pbs.ini` which is provided by
192192
| pbs\_server | String | This setting is optional and should point to your PBS server node if it is different from your OSG CE |
193193

194194

195-
### SGE ###
195+
### 20-sge.ini / [SGE] section ###
196196

197197
This section describes the parameters for a SGE jobmanager if it's being used in the current CE installation. If SGE is not being used, the `enabled` setting should be set to `False`.
198198

@@ -212,7 +212,7 @@ If `available_queues` is set, that list of queues will be used for
212212
validation, otherwise SGE will be queried for available queues.
213213

214214

215-
### Slurm ###
215+
### 20-slurm.ini / [Slurm] section ###
216216

217217
This section describes the parameters for a Slurm jobmanager if it's being used in the current CE installation. If Slurm is not being used, the `enabled` setting should be set to `False`.
218218

@@ -230,7 +230,7 @@ This section is contained in `/etc/osg/config.d/20-slurm.ini` which is provided
230230
| slurm\_cluster | String | The name of the Slurm cluster |
231231

232232

233-
### Gratia ###
233+
### 30-gratia.ini / [Gratia] section ###
234234

235235
This section configures Gratia. If `probes` is set to `UNAVAILABLE`, then `osg-configure` will use appropriate default values. If you need to specify custom reporting (e.g. a local gratia collector) in addition to the default probes, `%(osg-jobmanager-gratia)s`, `%(osg-gridftp-gratia)s`, `%(osg-metric-gratia)s`, `%(itb-jobmanager-gratia)s`, `%(itb-gridftp-gratia)s`, `%(itb-metric-gratia)s` are defined in the default configuration files to make it easier to specify the standard osg reporting.
236236

@@ -250,7 +250,7 @@ Legal values for the `probe_type` part are:
250250
- `gridftp` (for the GridFTP transfer probe)
251251

252252

253-
### Info Services ###
253+
### 30-infoservices.ini / [Info Services] section ###
254254

255255
Reporting to the central CE Collectors is configured in this section. In the majority of cases, this file can be left untouched; you only need to configure this section if you wish to report to your own CE Collector instead of the ones run by OSG Operations.
256256

@@ -268,7 +268,7 @@ This section is contained in `/etc/osg/config.d/30-infoservices.ini`, which is p
268268
- Otherwise, set this to the `hostname:port` of a host running a `condor-ce-collector` daemon
269269

270270

271-
### RSV ###
271+
### 30-rsv.ini / [RSV] section ###
272272

273273
This section handles the configuration and setup of the RSV services.
274274

@@ -302,7 +302,7 @@ value (for example: `srm/v2/server`) for the SRM probes to pass on their
302302
SE.
303303

304304

305-
### Subcluster / Resource Entry ###
305+
### 30-gip.ini / [Subcluster] and [Resource Entry] sections ###
306306

307307
Subcluster and Resource Entry configuration is for reporting about the worker resources on your site. A **subcluster** is a homogeneous set of worker node hardware; a **resource** is a set of subcluster(s) with common capabilities that will be reported to the ATLAS AGIS system.
308308

@@ -366,7 +366,7 @@ The following attributes are optional:
366366

367367

368368

369-
### Gateway ###
369+
### 10-gateway.ini / [Gateway] section ###
370370

371371
This section gives information about the options in the Gateway section of the configuration files. These options control the behavior of job gateways on the CE. CEs are based on HTCondor-CE, which uses `condor-ce` as the gateway.
372372

@@ -378,7 +378,7 @@ This section is contained in `/etc/osg/config.d/10-gateway.ini` which is provide
378378
| **job\_envvar\_path** | String | The value of the PATH environment variable to put into HTCondor jobs running with HTCondor-CE. This value is ignored if not using that batch system/gateway combination. |
379379

380380

381-
### Local Settings ###
381+
### 40-localsettings.ini / [Local Settings] ###
382382

383383
This section differs from other sections in that there are no set options in this section. Rather, the options set in this section will be placed in the `osg-local-job-environment.conf` verbatim. The options in this section are case sensitive and the case will be preserved when they are converted to environment variables. The `osg-local-job-environment.conf` file gets sourced by jobs run on your cluster so any variables set in this section will appear in the environment of jobs run on your system.
384384

@@ -393,7 +393,7 @@ MY_PATH = /usr/local/myapp
393393
This section is contained in `/etc/osg/config.d/40-localsettings.ini` which is provided by the `osg-configure-ce` RPM.
394394

395395

396-
### Misc Services ###
396+
### 10-misc.ini / [Misc Services] section ###
397397

398398
This section handles the configuration of services that do not have a dedicated section for their configuration.
399399

@@ -408,7 +408,7 @@ This section primarily deals with authentication/authorization. For information
408408
| all\_fqans | `True`, `False` | (Optional, default False) If true, vomsmap auth will use all VOMS FQANs of a proxy for mapping -- see [documentation](../security/lcmaps-voms-authentication#mapping-using-all-fqans) |
409409

410410

411-
### Site Information ###
411+
### 40-siteinfo.ini / [Site Information] section ###
412412

413413
The settings found in the `Site Information` section are described below. This section is used to give information about a resource such as resource name, site sponsors, administrators, etc.
414414

@@ -430,14 +430,13 @@ This section is contained in `/etc/osg/config.d/40-siteinfo.ini` which is provid
430430
| **latitude** | Number | This should be the latitude of the resource. It should be a number between -90 and 90. |
431431

432432
**Note for sponsor:**<br>
433-
If your resource has multiple sponsors, you can separate them using commas
434-
or specify the percentage using the following format 'osg, atlas, cms' or
435-
'osg:10, atlas:45, cms:45'. The percentages must add up to 100 if multiple
436-
sponsors are used. If you have a sponsor that is not an OSG VO, you can
437-
indicate this by using 'local' as the VO.
433+
If your resource has multiple sponsors, you can separate them using commas or specify the percentage using the following format:
434+
`osg, atlas, cms` or `osg:10, atlas:45, cms:45`.
435+
The percentages must add up to 100 if multiple sponsors are used.
436+
If you have a sponsor that is not an OSG VO, you can indicate this by using 'local' as the VO.
438437

439438

440-
### Squid ###
439+
### 01-squid.ini / [Squid] section ###
441440

442441
This section handles the configuration and setup of the squid web caching and proxy service.
443442

@@ -449,7 +448,7 @@ This section is contained in `/etc/osg/config.d/01-squid.ini` which is provided
449448
| location | String | This should be set to the `hostname:port` of the squid server. |
450449

451450

452-
### Storage ###
451+
### 10-storage.ini / [Storage] section ###
453452

454453
This section gives information about the options in the Storage section of the configuration file.
455454
Several of these values are constrained and need to be set in a way that is consistent with one of the OSG storage models.

0 commit comments

Comments
 (0)