docs (SE): revamp StorageElement docs

dirac.cfg

@@ -846,6 +846,11 @@ Resources
   StorageElementGroups
   {
     CERN-Storages = CERN-DST-EOS, CERN-USER
+    # Default SEs to be used when uploading output data from Payloads
+    SE-USER = CERN-USER
+    # Default SEs to be used as failover SEs uploading output data from Payloads.
+    # This option is used in the Job Wrapper and, if set, requires the RequestManagementSystem to be installed
+    Tier1-Failover = CERN-FAILOVER,CNAF-FAILOVER
   }
 }
 Operations

docs/source/AdministratorGuide/Configuration/ConfReference/Resources/index.rst

@@ -11,5 +11,3 @@ In this section all the physical resources than can be used by DIRAC users are d
 
    FileCatalogs/index
    Sites/index
-   StorageElements/index
-   StorageElementsGroups/index

docs/source/AdministratorGuide/Configuration/ConfReference/Systems/DataManagement/Services/index.rst

@@ -32,5 +32,4 @@ DataManagement services are:
    :maxdepth: 2
 
    FileCatalog/index
-   StorageElement/index
    StorageElementProxy/index

docs/source/AdministratorGuide/Configuration/ConfReference/Systems/DataManagement/index.rst

@@ -8,4 +8,3 @@ In this subsection are described the databases, services and URLs related with t
 
    Databases/index
    Services/index
-   URLs/index

src/DIRAC/Resources/Storage/GFAL2_SRM2Storage.py

@@ -51,7 +51,7 @@ def __init__(self, storageName, parameters):
         self.gfal2requestLifetime = gConfig.getValue("/Resources/StorageElements/RequestLifeTime", 100)
 
         self.protocolsList = self.protocolParameters["OutputProtocols"]
-        self.log.debug("GFAL2_SRM2Storage: protocolsList = %s" % self.protocolsList)
+        self.log.debug(f"GFAL2_SRM2Storage: protocolsList = {self.protocolsList}")
 
         self.__setSRMOptionsToDefault()
 

src/DIRAC/Resources/Storage/StorageElement.py

@@ -1,4 +1,4 @@
-""" This is the StorageElement class.
+""" This is the StorageElement module. It implements The StorageElementItem as well as the caching system
 """
 # # custom duty
 
@@ -41,6 +41,11 @@
 
 
 class StorageElementCache(object):
+    """
+    The StorageElementCache keeps StorageElementItem instances in a cache to save on initialization cost.
+    It keeps one instance per tuple (thread ID, seName, protocolSections, VO, proxy )
+    """
+
     def __init__(self):
         self.seCache = DictCache()
 
@@ -77,18 +82,26 @@ def __call__(self, name, protocolSections=None, vo=None, hideExceptions=False):
 
 class StorageElementItem(object):
     """
-    .. class:: StorageElement
+    .. class:: StorageElementItem
+
+    This class implements all the necessary logic to interact with the GRID storage Elements. Actual interaction with storages are delegated to ``StoragePlugins``.
+
+    The role of the StorageElementItem is to:
 
-    common interface to the grid storage element
+    * Provide a single interface to all the grid storages
+    * Ensure the status of the Storage in RSS
+    * Select multiple protocols for various operations
+    * Support multiple protocols as failover
+    * Negociate protocols with other StorageElement for Third Party Copy
 
 
 
-      self.name is the resolved name of the StorageElement i.e CERN-tape
-      self.options is dictionary containing the general options defined in the CS e.g. self.options['Backend] = 'Castor2'
-      self.storages is a dict of the stub objects created by StorageFactory for the protocols found in the CS. Index by the protocol section name.
-      self.localProtocolSections is a list of the local protocols that were created by StorageFactory
-      self.remoteProtocolSections is a list of the remote protocols that were created by StorageFactory
-      self.protocolOptions is a list of dictionaries containing the options found in the CS. (should be removed)
+    :ivar str name: Resolved name of the StorageElement
+    :ivar dict options: dictionary containing the general options defined in the CS
+    :ivar dict storages: dict of the stub objects created by StorageFactory for the protocols found in the CS. Index by the protocol section name.
+    :ivar list localProtocolSections: list of the local protocols that were created by StorageFactory
+    :ivar list remoteProtocolSections: list of the remote protocols that were created by StorageFactory
+    :ivar list protocolOptions: list of dictionaries containing the options found in the CS. (should be removed)