Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.0] docs: updates for setup removals #7991

Merged
merged 1 commit into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Job Scheduling
=========================================

The */Operations/<vo>/<setup>/JobScheduling* section contains all parameters that define DIRAC's behaviour when deciding what job has to be
The */Operations/<vo>/JobScheduling* section contains all parameters that define DIRAC's behaviour when deciding what job has to be
executed. Here's a list of parameters that can be defined:

========================= ======================================================== ===============================================================================================
Expand Down Expand Up @@ -46,7 +46,7 @@ Example
========

An example with all the options under *JobScheduling* follows. Remember that JobScheduling is defined under
*/Operations/<vo>/<setup>/JobScheduling* for multi-VO installations, and */Operations/<setup>/JobScheduling* for single-VO ones::
*/Operations/<vo>/JobScheduling* for multi-VO installations, and */Operations/JobScheduling* for single-VO ones::

JobScheduling
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Pilot version
=========================================

The */Operations/<vo>/<setup>/Pilot* section define What version of DIRAC will be used to submit pilot jobs to the resources.
The */Operations/<vo>/Pilot* section define What version of DIRAC will be used to submit pilot jobs to the resources.

================== ======================================================== ===============================================================================================
Parameter Description Default value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ For this reason, there is the possibility to define a entry in the Operation sec

.. code-block:: guess

Operations/<Setup>/MainServers = server1, server2
Operations/MainServers = server1, server2


There should be no port, no protocol. In the system configuration, one can then write:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/AdministratorGuide/HowTo/dedicateddfc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Prepare the CS for the new Database
------------------------------------

First the information for the new database is added to the Configuration System. All the parameters in the
``Systems/DataManagement/<SETUP>/Databases/NFCDB`` section can be copied from the ``FileCatalogDB`` section, except that
``Systems/DataManagement/Databases/NFCDB`` section can be copied from the ``FileCatalogDB`` section, except that
the ``DBName`` has to be pointing to the soon to be created database::

DBName = NFCDB
Expand Down
2 changes: 1 addition & 1 deletion docs/source/AdministratorGuide/HowTo/multiVO.rst
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Option value could be different, it depends on UI
installed on server
::

Systems/WorkloadManagement/<setup>/Agents/PilotStatusAgent/GridEnv = /etc/profile.d/grid-env
Systems/WorkloadManagement/Agents/PilotStatusAgent/GridEnv = /etc/profile.d/grid-env



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Solutions seen in the previous section cannot work in an environment without ext
The well-known Pilot-Job paradigm on which the DIRAC WMS is based does not apply in these circumstances: the Pilot-Jobs cannot fetch jobs from DIRAC.
Thus, such supercomputers require slightly changes in the WMS: we reintroduced the push model.

To leverage the Push model, one has to add the :mod:`~DIRAC.WorkloadManagementSystem.Agent.PushJobAgent` to the ``Systems/WorkloadManagement/<Setup>/Agents`` CS section, such as::
To leverage the Push model, one has to add the :mod:`~DIRAC.WorkloadManagementSystem.Agent.PushJobAgent` to the ``Systems/WorkloadManagement/Agents`` CS section, such as::

Systems
PushJobAgent_<Name>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For example::
}


The following option can be set in `Systems/Monitoring/<Setup>/Databases/MonitoringDB`:
The following option can be set in `Systems/Monitoring/Databases/MonitoringDB`:

*IndexPrefix*: Prefix used to prepend to indexes created in the ES instance. If this
is not present in the CS, the indices are prefixed with the setup name.
Expand Down Expand Up @@ -93,7 +93,7 @@ This can be done either via the CS or directly in the web app in the Configurati

Operations
{
<VO|Setup|Defaults>
<VO|Defaults>
{
MonitoringBackends
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ DIRAC includes a priority correction mechanism. The idea behind it is to look at
the past history and alter the priorities assigned based on it. It can have
multiple plugins but currently it only has one. All correctors have a CS section
to configure themselves under
`/Operations/<vo>/<setup>/JobScheduling/ShareCorrections`. The option
`/Operations/<vo>/<setup>/JobScheduling/ShareCorrections/ShareCorrectorsToStart`
`/Operations/<vo>/JobScheduling/ShareCorrections`. The option
`/Operations/<vo>/JobScheduling/ShareCorrections/ShareCorrectorsToStart`
defines witch correctors will be used in each iteration.

WMSHistory corrector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ All the DBs above are MySQL DBs, and should be installed using the :ref:`system
The JobDB MySQL table *JobParameters* can be replaced by an JobParameters backend built in Elastic/OpenSearch.
To enable it, set the following flag::

/Operations/[Defaults | Setup]/Services/JobMonitoring/useESForJobParametersFlag=True
/Operations/Defaults/Services/JobMonitoring/useESForJobParametersFlag=True

If you decide to make use of this Elastic/OpenSearch backend for storing job parameters, you would be in charge of setting
the index policies, as Job Parameters stored in Elastic/OpenSearch are not deleted together with the jobs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Helper for accessing /Operations

*/Operations* section is *VO* and *setup* aware. That means that configuration for different *VO/setup* will have a different CS path:

* For multi-VO installations */Operations/<vo>/<setup>* should be used.
* For single-VO installations */Operations/<setup>* should be used.
* For multi-VO installations */Operations/<vo>* should be used.
* For single-VO installations */Operations* should be used.

In any case, there is the possibility to define a default configuration, that is valid for all the *setups*. The *Defaults* keyword can be used instead of the setup. For instance */Operations/myvo/Defaults*.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ for authentication and authorization purposes.
Components can be instructed to use a "shifter proxy" for authN and authZ of their service calls.
A shifter proxy is proxy certificate, which should be:

- specified in the "Operations/<setup>/Shifter" section of the CS
- specified in the "Operations/Shifter" section of the CS
- uploaded to the ProxyManager (i.e. using "--upload" option of dirac-proxy-init)

Within an agent, in the "initialize" method, we can specify::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1088,7 +1088,7 @@ def do_update(self, args):
else:
gLogger.notice("Software successfully updated.")
gLogger.notice("You should restart the services to use the new software version.")
gLogger.notice("Think of updating /Operations/<vo>/<setup>/Pilot/Versions section in the CS")
gLogger.notice("Think of updating /Operations/<vo>/Pilot/Versions section in the CS")

def do_revert(self, args):
"""
Expand Down
2 changes: 1 addition & 1 deletion src/DIRAC/MonitoringSystem/DB/MonitoringDB.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Configuration Parameters**:

The following option can be set in `Systems/Monitoring/<Setup>/Databases/MonitoringDB`
The following option can be set in `Systems/Monitoring/Databases/MonitoringDB`

* *IndexPrefix*: Prefix used to prepend to indexes created in the ES instance. If this
is not present in the CS, the indexes are prefixed with the setup name.
Expand Down
2 changes: 1 addition & 1 deletion src/DIRAC/Resources/Storage/CTAStorage.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class CTAStorage(GFAL2_XROOTStorage):

It basically is XROOT with added tape capabilities.
Since CTA supports ONLY xroot, do not forget to add
xroot in your `Operations/<Setup>/DataManagement/RegistrationProtocols` list
xroot in your `Operations/DataManagement/RegistrationProtocols` list

Configuration example::

Expand Down
2 changes: 1 addition & 1 deletion src/DIRAC/WorkloadManagementSystem/DB/JobDB.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

**Configuration Parameters**:

The following options can be set in ``Systems/WorkloadManagement/<Setup>/Databases/JobDB``
The following options can be set in ``Systems/WorkloadManagement/Databases/JobDB``

* *MaxRescheduling*: Set the maximum number of times a job can be rescheduled, default *3*.
* *CompressJDLs*: Enable compression of JDLs when they are stored in the database, default *False*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ def syncScripts(self):
for fileVO in glob.glob(scriptDir):
tarFiles.append(fileVO)
else:
self.log.info("The /Operations/<Setup>/Pilot/pilotVORepo option is not defined, using Vanilla DIRAC pilot")
self.log.info("The /Operations/Pilot/pilotVORepo option is not defined, using Vanilla DIRAC pilot")

# DIRAC repo
pilotLocalRepo = os.path.join(self.workDir, "pilotLocalRepo")
Expand Down
Loading