- OGF GLUE2 Enumerations procedures and best practices
OGF GLUE2 Enumerations procedures and best practices¶
Author: Florido Paganelli florido.paganelli_REMOVE!THIS_@hep.lu.se
version:1.0
Document Status: Work in Progress
Last revision: 2014-06-17
Introduction¶
This work is an attempt to summarize and generalize the usage of Open Enumerations in GLUE2, and an attempt to set some rules on how the management of these should be carried on.
The key words ‘MUST,” “MUST NOT,” “REQUIRED,” “SHALL,” “SHALL NOT,” “SHOULD,” “SHOULD NOT,” “RECOMMENDED,” “MAY,” and “OPTIONAL” are to be interpreted as described in RFC 2119 (see [http://www.ietf.org/rfc/rfc2119.txt http://www.ietf.org/rfc/rfc2119.txt]).
Acknowledgements¶
Thanks to Stephen Burke, David Meredith, Paul Millar and Balazs Konya for kickstart of these ideas and their further development. Thanks to John-Paul Navarro and Shiraz Memon for coordinating this work within the OGF GLUE2 Working Group. Thanks to Andre Merzky for comments.
Naming Schemes¶
The following rules apply:
1) Every string is RECOMMENDED to be lowercase.
2) Clients MUST consider these strings case-sensitive as defined in GFD.147.
3) Case MUST NOT be used as a way to distinguish strings; in practice, the group will not accept names that only differ in case.
Services¶
This applies to the GLUE2 Open Enumeration <tt>ServiceType_t.</tt>
See also GFD.147, Appendix B.31
<center><nowiki><organization_name>.<product_name>.<service_detail></nowiki></center>
where
<tt><nowiki><organization_name> </nowiki></tt>is the reversed domain name of the organization which provides or maintains the service or a reversed domain name associated with the project.Presence: '''RECOMMENDED''' for '''new''' names. Exceptions MUST be justified.
<tt><nowiki><product_name> </nowiki></tt>free form string for product names Presence: '''MANDATORY'''
<tt><nowiki><service_detail> </nowiki></tt>free form string that SHOULD identify a subservice or a service implementation. It can contain dots.Presence: '''OPTIONAL'''
'''Decision: minimum''' requirement is
<center><nowiki><organization_name>.<product_name></nowiki></center>
Examples: <tt>org.nordugrid.arex, org.glite.ce.cream</tt>
Existing names not following the above rules can be kept, but MAY be Deprecated to be consistent with recommendations. (see Section 2.4 and Section 4.1)
Interfaces¶
This applies to the GLUE2 Open Enumeration <tt>InterfaceName_t.</tt>
GFD.147 Appendix B.18 does not define any clear format. The following is RECOMMENDED:
<center><nowiki><organization_name>.<interface_name></nowiki></center>
where:
<tt><nowiki><organization_name> </nowiki></tt>is the reversed domain name of the organization which provides or maintains the service or a reversed domain name associated with the project.Presence: '''RECOMMENDED''' for '''new''' names. Exceptions MUST be justified.
<tt><nowiki><interface_name></nowiki></tt>free form string for product namesPresence: '''MANDATORY'''
'''Examples: '''<tt>org.nordugrid.xbes, org.ogf.glue.emies.activitycreation, org.glite.voms</tt>
Capabilities¶
See GFD.147, appendix B.5, on ''Capability_t''.
Sorting out special classes of names¶
h4,
Use the reserved prefix:
org.ogf.glue.org.ogf.glue.* SHOULD be used if the proposed domain name is not applicable. Examples are expired/nonexistent/unregistered domains, domains that have been used for other purposes than the proposed product, and so on. The group can decide case by case.
Example:For EMIR, developed during EMI project that now is over, ''ServiceType_t ''is:'' ''<tt>org.ogf.glue.emir</tt>
If a project ends and the product has an orphaned reverse domain name, the name can be kept.
Simplified naming for Services with only one Interface
se the reserved prefix:¶
org.ogf.glue.org.ogf.glue.* SHOULD be used if the proposed domain name is not applicable. Examples are expired/nonexistent/unregistered domains, domains that have been used for other purposes than the proposed product, and so on. The group can decide case by case.
Example:For EMIR, developed during EMI project that now is over, ''ServiceType_t ''is:'' ''<tt>org.ogf.glue.emir</tt>
If a project ends and the product has an orphaned reverse domain name, the name can be kept.