This is a static archive of the previous Open Grid Forum Redmine content management system saved from host redmine.ogf.org file /projects/glue-wg/wiki/Enumerations_procedures_and_best_practices_v10/annotate/15 at Fri, 04 Nov 2022 15:14:29 GMT GLUE WG - Open Grid Forum

Enumerations procedures and best practices v10

Version 15 (Florido Paganelli, 06/18/2014 06:15 AM)

1 1 Shiraz Memon
{{>toc}}
2 1 Shiraz Memon
3 2 Florido Paganelli
h1. OGF GLUE2 Enumerations procedures and best practices
4 1 Shiraz Memon
5 2 Florido Paganelli
Author: Florido Paganelli florido.paganelli_REMOVE!THIS_@hep.lu.se
6 1 Shiraz Memon
7 2 Florido Paganelli
version:1.0
8 1 Shiraz Memon
9 2 Florido Paganelli
Document Status: Work in Progress
10 1 Shiraz Memon
11 2 Florido Paganelli
Last revision: 2014-06-17
12 1 Shiraz Memon
13 2 Florido Paganelli
h2. Introduction
14 1 Shiraz Memon
15 2 Florido Paganelli
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.
16 1 Shiraz Memon
17 7 Florido Paganelli
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).
18 1 Shiraz Memon
19 2 Florido Paganelli
h3. Acknowledgements
20 1 Shiraz Memon
21 2 Florido Paganelli
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.
22 1 Shiraz Memon
23 2 Florido Paganelli
h2. Naming Schemes
24 1 Shiraz Memon
25 2 Florido Paganelli
The following rules apply:
26 1 Shiraz Memon
27 2 Florido Paganelli
1) Every string is RECOMMENDED to be lowercase.
28 1 Shiraz Memon
29 2 Florido Paganelli
2) Clients MUST consider these strings case-sensitive as defined in GFD.147.
30 2 Florido Paganelli
31 2 Florido Paganelli
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.
32 2 Florido Paganelli
33 2 Florido Paganelli
h3. Services
34 2 Florido Paganelli
35 4 Florido Paganelli
This applies to the GLUE2 Open Enumeration @ServiceType_t.@
36 2 Florido Paganelli
37 2 Florido Paganelli
See also GFD.147, Appendix B.31
38 2 Florido Paganelli
39 3 Florido Paganelli
   <pre><organization_name>.<product_name>.<service_detail></pre>
40 2 Florido Paganelli
41 2 Florido Paganelli
where
42 1 Shiraz Memon
43 5 Florido Paganelli
@<organization_name>@ 
44 5 Florido Paganelli
is the reversed domain name of the organization which provides or maintains the service or a reversed domain name associated with the project.
45 1 Shiraz Memon
Presence: *RECOMMENDED* for *new* names. Exceptions MUST be justified.
46 1 Shiraz Memon
47 5 Florido Paganelli
@<product_name>@ 
48 5 Florido Paganelli
free form string for product names
49 1 Shiraz Memon
Presence: *MANDATORY*
50 3 Florido Paganelli
51 5 Florido Paganelli
@<service_detail>@ 
52 5 Florido Paganelli
free form string that SHOULD identify a subservice or a service implementation. It can contain dots.
53 3 Florido Paganelli
Presence: *OPTIONAL*
54 2 Florido Paganelli
55 12 Florido Paganelli
Decision: *RECOMMENDED* requirement is 
56 2 Florido Paganelli
57 3 Florido Paganelli
<pre><organization_name>.<product_name></pre>
58 2 Florido Paganelli
59 3 Florido Paganelli
Examples: @org.nordugrid.arex, org.glite.ce.cream@
60 2 Florido Paganelli
61 2 Florido Paganelli
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)
62 2 Florido Paganelli
63 2 Florido Paganelli
h3. Interfaces
64 2 Florido Paganelli
65 8 Florido Paganelli
This applies to the GLUE2 Open Enumeration @InterfaceName_t.@
66 2 Florido Paganelli
GFD.147 Appendix B.18 does not define any clear format. The following is RECOMMENDED:
67 8 Florido Paganelli
<pre><organization_name>.<interface_name></pre>
68 1 Shiraz Memon
69 2 Florido Paganelli
where:
70 1 Shiraz Memon
71 8 Florido Paganelli
@<organization_name>@
72 8 Florido Paganelli
is the reversed domain name of the organization which provides or maintains the service or a reversed domain name associated with the project.
73 8 Florido Paganelli
Presence: *RECOMMENDED* for *new* names. Exceptions MUST be justified.
74 2 Florido Paganelli
75 8 Florido Paganelli
@<interface_name>@
76 8 Florido Paganelli
free form string for product names
77 8 Florido Paganelli
Presence: *MANDATORY*
78 2 Florido Paganelli
79 8 Florido Paganelli
Examples: @org.nordugrid.xbes, org.ogf.glue.emies.activitycreation, org.glite.voms@
80 2 Florido Paganelli
81 2 Florido Paganelli
h3. Capabilities
82 2 Florido Paganelli
83 9 Florido Paganelli
See GFD.147, appendix B.5, on @Capability_t@.
84 2 Florido Paganelli
85 2 Florido Paganelli
h3. Sorting out special classes of names
86 2 Florido Paganelli
87 10 Florido Paganelli
h4. In case the organization name is unknown/undefined/short-lived 
88 2 Florido Paganelli
89 2 Florido Paganelli
Use the reserved prefix:
90 2 Florido Paganelli
91 2 Florido Paganelli
    org.ogf.glue.
92 2 Florido Paganelli
93 10 Florido Paganelli
@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.
94 2 Florido Paganelli
95 10 Florido Paganelli
Example:For EMIR, developed during EMI project that now is over, @ServiceType_t@ is: @org.ogf.glue.emir@
96 2 Florido Paganelli
97 2 Florido Paganelli
If a project ends and the product has an orphaned reverse domain name, the name can be kept.
98 2 Florido Paganelli
99 2 Florido Paganelli
h4. Simplified naming for Services with only one Interface
100 1 Shiraz Memon
101 11 Florido Paganelli
A specific Endpoint interface can be bound to a specific Service. In such case, to simplify name creation, @InterfaceName_t@ MAY be the same of a corresponding @ServiceType_t.@
102 2 Florido Paganelli
103 2 Florido Paganelli
h2. Requesting new Open Enumerations
104 2 Florido Paganelli
105 13 Florido Paganelli
A community willing to submit new open enumeration MUST:
106 13 Florido Paganelli
107 13 Florido Paganelli
* Provide the following information about the enumeration to be submitted:
108 13 Florido Paganelli
** *Type* of the enumeration to be added (i.e. one of the types described in GFD.147, Appendix B )
109 13 Florido Paganelli
** *Name* of the enumeration as in the guidelines in Section 2;
110 13 Florido Paganelli
** *Description* of the enumeration. This description is a textual, human readable summary of what the object described by the open enumeration does. It SHOULD be provided in two parts: a concise description that will be stored as part of the definition of the enumerated types, and a (usually) longer description that will explain to the WG what the new type is for.
111 13 Florido Paganelli
** *Reference email* to be contacted by the OGF group during evaluation of the proposed strings. This email will not be published and will be internal to the group.
112 13 Florido Paganelli
* Send the above information to the OGF group at the address glue-wg@ogf.org with subject “[Enumerations] Request for addition/</nowiki>obsoletion/modification”
113 13 Florido Paganelli
114 13 Florido Paganelli
*NOTE:* Requests that are missing the information listed in 1 will be automatically rejected. The proposer will be asked to provide missing information.
115 13 Florido Paganelli
116 2 Florido Paganelli
h2. Management of Open Enumerations
117 1 Shiraz Memon
118 14 Florido Paganelli
The group preserves the current list of Open Enumerations in the git repository at the link
119 14 Florido Paganelli
120 14 Florido Paganelli
> https://github.com/OGF-GLUE/Enumerations
121 14 Florido Paganelli
122 14 Florido Paganelli
in the form of CSV files. Section 4.1 contains a description of the content of the CSV files.
123 14 Florido Paganelli
124 14 Florido Paganelli
The groups keeps them updated using the procedures listed in this document, defined in Section 4.3.
125 14 Florido Paganelli
126 1 Shiraz Memon
h3. Description of Open Enumerations CSV files
127 14 Florido Paganelli
128 14 Florido Paganelli
CSV filenames in git-hub are of the form:
129 15 Florido Paganelli
|_.Filename |_.Purpose |_.Example | 
130 14 Florido Paganelli
| @<EnumerationName_t>.csv@ |  Contains Open Enumerations officially approved by the group. | @ServiceType_t.csv@ |
131 14 Florido Paganelli
| @<EnumerationName_t>-draft.csv@ | Contains Open Enumerations approved by the group AND Open Enumerations pending approval from the group | @ServiceType_t-draft.csv@ |
132 2 Florido Paganelli
133 2 Florido Paganelli
h3. Statuses
134 2 Florido Paganelli
135 2 Florido Paganelli
h3. GLUE2 Working Group Procedures
136 2 Florido Paganelli
137 2 Florido Paganelli
h2. References
This is a static archive of the previous Open Grid Forum Redmine content management system saved from host redmine.ogf.org file /projects/glue-wg/wiki/Enumerations_procedures_and_best_practices_v10/annotate/15 at Fri, 04 Nov 2022 15:14:29 GMT