idnits 2.17.1 draft-birrane-dtn-adm-ion-ipnadmin-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. ** There are 3 instances of too long lines in the document, the longest one being 4 characters in excess of 72. ** The abstract seems to contain references ([I-D.birrane-dtn-adm]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 2, 2018) is 2124 days in the past. Is this intentional? Checking references for intended status: Experimental ---------------------------------------------------------------------------- == Outdated reference: A later version (-06) exists of draft-birrane-dtn-adm-02 == Outdated reference: A later version (-08) exists of draft-birrane-dtn-amp-04 Summary: 3 errors (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Delay-Tolerant Networking E. Birrane 3 Internet-Draft E. DiPietro 4 Intended status: Experimental D. Linko 5 Expires: January 3, 2019 Johns Hopkins Applied Physics Laboratory 6 July 2, 2018 8 ION Application Data Model 9 draft-birrane-dtn-adm-ion-ipnadmin-00 11 Abstract 13 This document describes the Application Data Model (ADM) for the 14 configuration of the routing of bundles to ipn endpoint ID scheme 15 conformant endpoints from a local ION node. provided by 16 [I-D.birrane-dtn-adm]. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at https://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on January 3, 2019. 35 Copyright Notice 37 Copyright (c) 2018 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (https://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 53 1.1. Technical Notes . . . . . . . . . . . . . . . . . . . . . 2 54 1.2. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 3 55 1.3. Requirements Language . . . . . . . . . . . . . . . . . . 3 56 2. Structure and Design of this ADM . . . . . . . . . . . . . . 3 57 3. Naming and Identification . . . . . . . . . . . . . . . . . . 4 58 3.1. Namespace and Nicknames . . . . . . . . . . . . . . . . . 4 59 4. ION IPN Admin ADM JSON Encoding . . . . . . . . . . . . . . . 5 60 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 61 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 62 6.1. Informative References . . . . . . . . . . . . . . . . . 8 63 6.2. Normative References . . . . . . . . . . . . . . . . . . 8 64 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 8 66 1. Introduction 68 An Application Data Model (ADM) provides a guaranteed interface for 69 the management of an application or protocol in accordance with the 70 Asynchronous Management Architecture (AMA) defined in 71 [I-D.birrane-dtn-ama]. The ADM described in this document complies 72 with the ADM Template provided in [I-D.birrane-dtn-adm] as encoded 73 using the JSON syntax. 75 The ION IPN (Interplanetary Internet) Scheme Administration ADM 76 contains all of the functionality that is required to configure the 77 routing of bundles from a local node to an endpoint that conforms to 78 the IPN scheme. 80 1.1. Technical Notes 82 o This document describes Version 0.0 of the ION IPN Admin ADM. 84 o The Asynchronous Resource Identifier (ARI) for this ADM is NOT 85 correctly set. A sample ARI is used in this version of the 86 specification and MAY change in future versions of this ADM until 87 an ARI registry is established. This notice will be removed at 88 that time. 90 o Agent applications MAY choose to ignore the name, description, or 91 other annotative information associated with the component 92 definitions within this ADM where such items are only used to 93 provide human-readable information or are otherwise not necessary 94 to manage a device. 96 1.2. Scope 98 This ADM specifies those components of the Asynchronous Management 99 Model (AMM) common to the configuration of the IPN scheme in ION. 101 Any Manager software implementing this ADM MUST perform the 102 responsibilities of an AMA Manager as outlined in 103 [I-D.birrane-dtn-adm] as they relate to the objects included in this 104 document. 106 Any Agent software implementing this ADM MUST perform the 107 responsibilities of an AMA Agent as outlined in [I-D.birrane-dtn-adm] 108 as they relate to the objects included in this document. 110 1.3. Requirements Language 112 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 113 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 114 document are to be interpreted as described in RFC 2119 [RFC2119]. 116 2. Structure and Design of this ADM 118 The IPN Admin ADM's structure is in accordance to 119 [I-D.birrane-dtn-adm]. This ADM contains metadata, edd, table 120 templates, and controls. Externally Defined Data (EDD) are values 121 that are calculated external to the ADM system. Table Templates are 122 column templates that will be followed by any instance of this table 123 available in the network. They may not be created dynamically within 124 the network by Managers. Controls are predefined and sometimes 125 parameterized opcodes that can be run on an Agent. Controls are 126 preconfigured in Agents and Managers as part of ADM support.There are 127 no variables, report templates, macros, constants, or operators in 128 this ADM at this time. The contents of this ADM are derived from the 129 main functions and data that are needed for configuration in 130 accordance with the IPN scheme. 132 There are two categories of functions in IPN. They are ones that 133 deal with egress plans (plans for unobstructed and continuous ways of 134 exit travel) and ones that deal with exits for static default 135 routing. These plans and exits are discussed throughout the ADM. 137 All ADMs have metadata that includes the name, namespace, and version 138 of the ADM as well as the name of the organization that is issuing 139 that particular ADM. This is important for identification purposes 140 of the ADMs and to ensure version control. All of the functions that 141 are related to the configuration of IPN in ION are present in this 142 document. 144 3. Naming and Identification 146 This section outlines the namespaces used to uniquely identify ADM 147 objects in this specification. 149 3.1. Namespace and Nicknames 151 In accordance with [I-D.birrane-dtn-adm], every ADM is assigned a 152 moderated Namespace. In accordance with [I-D.birrane-dtn-amp], these 153 namespaces may be enumerated for compactness. The namespace and ADM 154 identification for these objects is defined as follows. 156 +-----------------+------------------+ 157 | Identifier | Value | 158 +-----------------+------------------+ 159 | Namespace | DTN/ION/ipnadmin | 160 | | | 161 | ADM Enumeration | 6 | 162 +-----------------+------------------+ 164 Table 1: Namespace Information 166 Given the above ADM enumeration, in accordance with 167 [I-D.birrane-dtn-amp], the following AMP nicknames are defined. 169 +----------+------------------------------+ 170 | Nickname | Collection | 171 +----------+------------------------------+ 172 | 120 | DTN/ION/ipnadmin/Const | 173 | | | 174 | 121 | DTN/ION/ipnadmin/Ctrl | 175 | | | 176 | 122 | DTN/ION/ipnadmin/Edd | 177 | | | 178 | 123 | DTN/ION/ipnadmin/Mac | 179 | | | 180 | 124 | DTN/ION/ipnadmin/Oper | 181 | | | 182 | 125 | DTN/ION/ipnadmin/Rptt | 183 | | | 184 | 127 | DTN/ION/ipnadmin/Tblt | 185 | | | 186 | 129 | DTN/ION/ipnadmin/Var | 187 | | | 188 | 130 | DTN/ION/ipnadmin/Mdat | 189 | | | 190 | 131-139 | DTN/ION/ipnadmin/Reserved | 191 +----------+------------------------------+ 193 Table 2: ION IPN Admin ADM Nicknames 195 4. ION IPN Admin ADM JSON Encoding 197 { 198 "Mdat": [ 199 { 200 "name": "name", 201 "type": "STR", 202 "value": "ion_ipn_admin", 203 "description": "The human-readable name of the ADM." 204 }, 205 { 206 "name": "namespace", 207 "type": "STR", 208 "value": "DTN/ION/ipnadmin/", 209 "description": "The namespace of the ADM" 210 }, 211 { 212 "name": "version", 213 "type": "STR", 214 "value": "v0.0", 215 "description": "The version of the ADM" 216 }, 217 { 218 "name": "organization", 219 "type": "STR", 220 "value": "JHUAPL", 221 "description": "The name of the issuing organization of the ADM" 222 } 223 ], 224 "Edd": [ 225 { 226 "name": "ion_version", 227 "type": "STR", 228 "description": "This is the version of ion is that currently 229 installed." 230 } 231 ], 232 "Tblt": [ 233 { 234 "name": "exits", 235 "columns": [ 236 {"type":"UINT","name":"first_node_nbr"}, 237 {"type":"UINT","name":"last_node_nbr"}, 238 {"type":"STR","name":"gateway_endpoint_id"} 239 ], 240 "description": "This table lists all of the exits that are defined in 241 the IPN database for the local node." 242 }, 243 { 244 "name": "plans", 245 "columns": [ 246 {"type":"UINT","name":"node_nbr"}, 247 {"type":"STR","name":"default_duct_expression"} 248 ], 249 "description": "This table lists all of the egress plans that are 250 established in the IPN database for the local node." 251 } 252 ], 253 "Ctrl": [ 254 { 255 "name": "exit_add", 256 "parmspec": [ 257 {"type":"UINT","name":"first_node_nbr"}, 258 {"type":"UINT","name":"last_node_nbr"}, 259 {"type":"STR","name":"gateway_endpoint_id"} 260 ], 261 "description": "This control establishes an \"exit\" for static 262 default routing." 263 }, 264 { 265 "name": "exit_change", 266 "parmspec": [ 267 {"type":"UINT","name":"first_node_nbr"}, 268 {"type":"UINT","name":"last_node_nbr"}, 269 {"type":"STR","name":"gatewayEndpointId"} 270 ], 271 "description": "This control changes the gateway node number for the 272 exit identified by firstNodeNbr and lastNodeNbr." 273 }, 274 { 275 "name": "exit_del", 276 "parmspec":[ 277 {"type":"UINT","name":"first_node_nbr"}, 278 {"type":"UINT","name":"last_node_nbr"} 279 ], 280 "description": "This control deletes the exit identified by 281 firstNodeNbr and lastNodeNbr." 282 }, 283 { 284 "name": "plan_add", 285 "parmspec": [ 286 {"type":"UINT","name":"node_nbr"}, 287 {"type":"STR","name":"default_duct_expression"} 288 ], 289 "description": "This control establishes an egress plan for the 290 bundles that must be transmitted to the neighboring node that is 291 identified by it's nodeNbr." 292 }, 293 { 294 "name": "plan_change", 295 "parmspec": [ 296 {"type":"UINT","name":"node_nbr"}, 297 {"type":"STR","name":"default_duct_expression"} 298 ], 299 "description": "This control changes the duct expression for the 300 indicated plan." 301 }, 302 { 303 "name": "plan_del", 304 "parmspec": [ 305 {"type":"UINT","name":"node_nbr"} 306 ], 307 "description": "This control deletes the egress plan for the node that 308 is identified by it's nodeNbr." 309 } 310 ] 311 } 312 5. IANA Considerations 314 At this time, this protocol has no fields registered by IANA. 316 6. References 318 6.1. Informative References 320 [I-D.birrane-dtn-ama] 321 Birrane, E., "Asynchronous Management Architecture", 322 draft-birrane-dtn-ama-07 (work in progress), June 2018. 324 6.2. Normative References 326 [I-D.birrane-dtn-adm] 327 Birrane, E., DiPietro, E., and D. Linko, "AMA Application 328 Data Model", draft-birrane-dtn-adm-02 (work in progress), 329 June 2018. 331 [I-D.birrane-dtn-amp] 332 Birrane, E., "Asynchronous Management Protocol", draft- 333 birrane-dtn-amp-04 (work in progress), June 2018. 335 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 336 Requirement Levels", BCP 14, RFC 2119, 337 DOI 10.17487/RFC2119, March 1997, 338 . 340 Authors' Addresses 342 Edward J. Birrane 343 Johns Hopkins Applied Physics Laboratory 345 Email: Edward.Birrane@jhuapl.edu 347 Evana DiPietro 348 Johns Hopkins Applied Physics Laboratory 350 Email: Evana.DiPietro@jhuapl.edu 352 David Linko 353 Johns Hopkins Applied Physics Laboratory 355 Email: David.Linko@jhuapl.edu