Skip to content
This repository was archived by the owner on May 23, 2022. It is now read-only.

Commit 20919fd

Browse files
committed
Remove pre-OSG-3.6 info from "Configuration with OSG-Configure" doc (SOFTWARE-5164)
1 parent b4f8b04 commit 20919fd

File tree

1 file changed

+8
-71
lines changed

1 file changed

+8
-71
lines changed

docs/other/configuration-with-osg-configure.md

Lines changed: 8 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ In the tables below:
7979
Syntax and layout
8080
-----------------
8181

82-
The configuration files used by `osg-configure` are the one supported by Python's [SafeConfigParser](https://docs.python.org/library/configparser.html), similar in format to the [INI configuration file](https://en.wikipedia.org/wiki/INI_file) used by MS Windows:
82+
The configuration files used by `osg-configure` are the one supported by Python's [configparser](https://docs.python.org/library/configparser.html), similar in format to the [INI configuration file](https://en.wikipedia.org/wiki/INI_file) used by MS Windows:
8383

8484
- Config files are separated into sections, specified by a section name in square brackets (e.g. `[Section 1]`)
8585
- Options should be set using `name = value` pairs
@@ -254,54 +254,19 @@ This section is contained in `/etc/osg/config.d/30-infoservices.ini`, which is p
254254
- Otherwise, set this to the `hostname:port` of a host running a `condor-ce-collector` daemon
255255

256256

257-
### RSV ###
258-
259-
This section handles the configuration and setup of the RSV services.
260-
261-
This section is contained in `/etc/osg/config.d/30-rsv.ini` which is provided by the `osg-configure-rsv` RPM.
262-
263-
| Option | Values Accepted | Explanation |
264-
|----------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
265-
| **enabled** | `True`, `False`, `Ignore` | This indicates whether the rsv service is being used or not. |
266-
| **rsv_user** | String | This gives username that rsv will run under. If this is blank or set to `UNAVAILABLE`, it will default to rsv. |
267-
| **gratia_probes** | String | This settings indicates which rsv gratia probes should be used. It is a list of probes separated by a comma. Valid probes are metric, condor, pbs, lsf, sge, managedfork, hadoop-transfer, and gridftp-transfer |
268-
| ce_hosts | String | This option lists the serviceURI of the CEs that generic RSV CE probes should check. This should be a list of serviceURIs (`hostname[:port/service]`) separated by a comma (e.g. `my.host,my.host2,my.host3:2812`). |
269-
| htcondor_ce_hosts | String | This option lists the serviceURI of the HTCondor-CE-based CEs that the RSV HTCondor-CE probes should check. This should be a list of serviceURIs (`hostname[:port/service]`) separated by a comma (e.g. `my.host,my.host2,my.host3:2812`). | |
270-
| gridftp_hosts | String | This option lists the serviceURI of the GridFTP servers that the RSV GridFTP probes should check. This should be a list of serviceURIs (`hostname[:port/service]`) separated by a comma (e.g. `my.host.iu.edu:2812,my.host2,my.host3`). |
271-
| gridftp_dir | String | This should be the directory that the GridFTP probes should use during testing. This defaults to `/tmp` if left blank or set to `UNAVAILABLE`. |
272-
| **srm_hosts** | String | This option lists the serviceURI of the srm servers that the RSV srm probes should check. This should be a list of serviceURIs (`hostname[:port/service]`) separated by a comma (e.g. `my.host,my.host2,my.host3:8444`). |
273-
| srm_dir | String | This should be the directory that the srm probes should use during testing. |
274-
| srm_webservice_path | String | This option gives the webservice path that SRM probes need to use along with the host:port. See note. |
275-
| service_cert | String | This option should point to the public key file (pem) for your service certificate. If this is left blank or set to `UNAVAILABLE` and the `user_proxy` setting is set, it will default to `/etc/grid-security/rsvcert.pem` |
276-
| service_key | String | This option should point to the private key file (pem) for your service certificate. If this is left blank or set to `UNAVAILABLE` and the `service_cert` setting is enabled, it will default to `/etc/grid-security/rsvkey.pem` . |
277-
| service_proxy | String | This should point to the location of the rsv proxy file. If this is left blank or set to `UNAVAILABLE` and the use_service_cert setting is enabled, it will default to `/tmp/rsvproxy`. |
278-
| user_proxy | String | If you don't use a service certificate for rsv, you will need to specify a proxy file that RSV should use in the proxy_file setting. If this is set, then service_cert, service_key, and service_proxy should be left blank, or set to `UNAVAILABE` or `DEFAULT`. |
279-
| **setup_rsv_nagios** | `True`, `False` | This option indicates whether rsv should upload results to a local nagios server instance. This should be set to True or False.<br> This plugin is provided as an experimental component, and admins are recommend *not to enable* it on production resources. |
280-
| rsv_nagios_conf_file | String | This option indicates the location of the rsv nagios file to use for configuration details. This file *needs to be configured locally for RSV-Nagios forwarding to work* -- see inline comments in file for more information. |
281-
| condor_location | String | If you installed Condor in a non-standard location (somewhere other than /usr, which is where the RPM puts it) you must specify the path to the install dir here. |
282-
283-
!!! note
284-
**srm_webservice_path**:<br/>
285-
For dcache installations, this should work if left blank. However
286-
Bestman-xrootd SEs normally use `srm/v2/server` as web service path, and so
287-
Bestman-xrootd admins will have to pass this option with the appropriate
288-
value (for example: `srm/v2/server`) for the SRM probes to pass on their
289-
SE.
290-
291-
292257
### Subcluster / Resource Entry for AGIS / GlideinWMS Entry ###
293258

294259
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.
295260

296261
**At least one Subcluster or Resource Entry section** is required on a CE; please populate the information for all your subclusters. This information will be reported to a central collector and will be used to send GlideIns / pilot jobs to your site; having accurate information is necessary for OSG jobs to effectively use your resources.
297262

298-
This section is contained in `/etc/osg/config.d/30-gip.ini` which is provided by the `osg-configure-gip` RPM. (This is for historical reasons.)
263+
These configuration files are provided by the `osg-configure-cluster` RPM.
299264

300265
This configuration uses multiple sections of the OSG configuration files:
301266

302-
- [Subcluster\*](#subcluster-configuration): options about homogeneous subclusters
303-
- [Resource Entry\*](#resource-entry-configuration-atlas-only): options for specifying ATLAS queues for AGIS
304-
- [GlideinWMS Entry\*](#glideinwms-entry-cms-and-osg-pilot-factories): options for specifying queues for the CMS and OSG GlideinWMS factories
267+
- [Subcluster\*](#subcluster-configuration) in `/etc/osg/config.d/31-cluster.ini`: options about homogeneous subclusters
268+
- [Resource Entry\*](#resource-entry-configuration-atlas-only) in `/etc/osg/config.d/31-cluster.ini`: options for specifying ATLAS queues for AGIS
269+
- [GlideinWMS Entry\*](#glideinwms-entry-cms-and-osg-pilot-factories) in `/etc/osg/config.d/35-pilot.ini`: options for specifying queues for the CMS and OSG GlideinWMS factories
305270

306271
#### Notes for multi-CE sites. ####
307272

@@ -320,7 +285,7 @@ Each homogeneous set of worker node hardware is called a **subcluster**. For eac
320285
| **name** | String | The same name that is in the Section label; it should be **globally unique** |
321286
| **ram\_mb** | Positive Integer | Megabytes of RAM per node |
322287
| **cores\_per\_node** | Positive Integer | Number of cores per node |
323-
| **allowed\_vos** | Comma-separated List or `*` | The VOs that are allowed to run jobs on this subcluster (autodetected if `*`). Optional on OSG 3.3 |
288+
| **allowed\_vos** | Comma-separated List or `*` | The collaborations that are allowed to run jobs on this subcluster |
324289

325290
The following attributes are optional:
326291

@@ -330,10 +295,6 @@ The following attributes are optional:
330295
| queue | String | The queue to which jobs should be submitted in order to run on this subcluster |
331296
| extra\_transforms | Classad | Transformation attributes which the HTCondor Job Router should apply to incoming jobs so they can run on this subcluster |
332297

333-
**OSG 3.4 changes:**
334-
335-
- `allowed_vos` is mandatory
336-
337298

338299
#### Resource Entry Configuration (ATLAS only) ####
339300

@@ -346,7 +307,7 @@ If you are configuring a CE for the ATLAS VO, you must provide hardware informat
346307
| **queue** | String | The queue to which jobs should be submitted to run on this resource |
347308
| **cpucount** (alias **cores\_per\_node**) | Positive Integer | Number of cores that a job using this resource can get |
348309
| **maxmemory** (alias **ram\_mb**) | Positive Integer | Maximum amount of memory (in MB) that a job using this resource can get |
349-
| **allowed\_vos** | Comma-separated List or `*` | The VOs that are allowed to run jobs on this resource (autodetected if `*`). Optional on OSG 3.3 |
310+
| **allowed\_vos** | Comma-separated List or `*` | The collaborations that are allowed to run jobs on this resource |
350311

351312
The following attributes are optional:
352313

@@ -355,10 +316,6 @@ The following attributes are optional:
355316
| subclusters | Comma-separated List | The physical subclusters the resource entry refers to; must be defined as Subcluster sections elsewhere in the file |
356317
| vo\_tag | String | An arbitrary label that is added to jobs routed through this resource |
357318

358-
**OSG 3.4 changes:**
359-
360-
- `allowed_vos` is mandatory
361-
362319

363320
#### GlideinWMS Entry (CMS and OSG pilot factories) ####
364321

@@ -378,7 +335,7 @@ This section is contained in `/etc/osg/config.d/35-pilot.ini`
378335
| **require\_singularity** | true, false | True if the pilot should require singularity on the workers. |
379336
| **os** | Comma-separated List | The OS of the workers; allowed values are `rhel6`, `rhel7`, `rhel8`, or `ubuntu18`. This is required unless require_singularity = true |
380337
| **send\_tests* | true, false | Send test pilots? Currently not working, placeholder |
381-
| **allowed\_vos** | Comma-separated List or `*` | A comma-separated list of VOs that are allowed to submit to this subcluster; If `*`, uses VOs that have accounts on this CE |
338+
| **allowed\_vos** | Comma-separated List or `*` | A comma-separated list of collaborations that are allowed to submit to this subcluster |
382339

383340

384341
### Gateway ###
@@ -408,26 +365,6 @@ MY_PATH = /usr/local/myapp
408365
This section is contained in `/etc/osg/config.d/40-localsettings.ini` which is provided by the `osg-configure-ce` RPM.
409366

410367

411-
### Misc Services ###
412-
413-
This section handles the configuration of services that do not have a dedicated section for their configuration.
414-
415-
This section is contained in `/etc/osg/config.d/10-misc.ini` which is provided by the `osg-configure-misc` RPM.
416-
417-
This section primarily deals with authentication/authorization. For information on suggested settings for your CE, see the [authentication section of the HTCondor-CE install documents](../compute-element/install-htcondor-ce.md#configuring-authentication).
418-
419-
| Option | Values Accepted | Explanation |
420-
|---------------------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
421-
| **authorization\_method** | `gridmap`, `xacml`, `local-gridmap`, `vomsmap` | This indicates which authorization method your site uses. **`xacml`** **is deprecated in OSG 3.4** |
422-
| edit\_lcmaps\_db | `True`, `False` | (Optional, default True) If true, osg-configure will overwrite `/etc/lcmaps.db` to set your authorization method. The previous version will be backed up to `/etc/lcmaps.db.pre-configure` |
423-
| 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.md#mapping-using-all-fqans) |
424-
425-
**OSG 3.4 changes:**
426-
427-
- `authorization_method` defaults to `vomsmap`
428-
- `authorization_method` will raise a warning if set to `xacml`
429-
430-
431368
### Site Information ###
432369

433370
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.

0 commit comments

Comments
 (0)