idnits 2.17.1 draft-birrane-dtn-adm-ionadmin-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 is 1 instance of too long lines in the document, the longest one being 2 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 == Line 508 has weird spacing: '...lt heap limit...' -- 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 (~~), 4 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 Administration Application Data Model 9 draft-birrane-dtn-adm-ionadmin-00 11 Abstract 13 This document describes the Application Data Model (ADM) for the 14 administration of ION in compliance with the template provided by 15 [I-D.birrane-dtn-adm]. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at https://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on January 3, 2019. 34 Copyright Notice 36 Copyright (c) 2018 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (https://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 52 1.1. Technical Notes . . . . . . . . . . . . . . . . . . . . . 2 53 1.2. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 3 54 1.3. Requirements Language . . . . . . . . . . . . . . . . . . 3 55 2. Structure and Design of this ADM . . . . . . . . . . . . . . 3 56 3. Naming and Identification . . . . . . . . . . . . . . . . . . 4 57 3.1. Namespace and Nicknames . . . . . . . . . . . . . . . . . 4 58 4. ION Admin ADM JSON Encoding . . . . . . . . . . . . . . . . . 5 59 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13 60 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 13 61 6.1. Informative References . . . . . . . . . . . . . . . . . 14 62 6.2. Normative References . . . . . . . . . . . . . . . . . . 14 63 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14 65 1. Introduction 67 An Application Data Model (ADM) provides a guaranteed interface for 68 the management of an application or protocol in accordance with the 69 Asynchronous Management Architecture (AMA) defined in 70 [I-D.birrane-dtn-ama]. The ADM described in this document complies 71 with the ADM Template provided in [I-D.birrane-dtn-adm] as encoded 72 using the JSON syntax. 74 The ION Administration ADM contains all of the functionality that is 75 required for the proper configuration and management of ION nodes. 77 1.1. Technical Notes 79 o This document describes Version 0.0 of the ION Admin ADM. 81 o The AMM Resource Identifier (ARI) for this ADM is NOT correctly 82 set. A sample ARI is used in this version of the specification 83 and MAY change in future versions of this ADM until an ARI 84 registry is established. This notice will be removed at that 85 time. 87 o Agent applications MAY choose to ignore the name, description, or 88 other annotative information associated with the component 89 definitions within this ADM where such items are only used to 90 provide human-readable information or are otherwise not necessary 91 to manage a device. 93 1.2. Scope 95 This ADM specifies those components of the Asynchronous Management 96 Model (AMM) common to the administration of ION. 98 Any Manager software implementing this ADM MUST perform the 99 responsibilities of an AMA Manager as outlined in 100 [I-D.birrane-dtn-adm] as they relate to the objects included in this 101 document. 103 Any Agent software implementing this ADM MUST perform the 104 responsibilities of an AMA Agent as outlined in [I-D.birrane-dtn-adm] 105 as they relate to the objects included in this document. 107 1.3. Requirements Language 109 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 110 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 111 document are to be interpreted as described in RFC 2119 [RFC2119]. 113 2. Structure and Design of this ADM 115 The ION Admin ADM's structure is in accordance with 116 [I-D.birrane-dtn-adm]. This ADM contains metadata, edd, table 117 templates, and controls. Externally Defined Data (EDD) are values 118 that are calculated external to the ADM system. Table Templates are 119 column templates that will be followed by any instance of this table 120 available in the network. They may not be created dynamically within 121 the network by Managers. Controls are predefined and sometimes 122 parameterized opcodes that can be run on an Agent. Controls are 123 preconfigured in Agents and Managers as part of ADM support. There 124 are no variables, report templates, macros, constants, or operators 125 in this ADM at this time. 127 The contents of this ADM are derived from the main functions and data 128 that are needed to configure and manage the node on the local 129 computer that is running ION. The core functions of the 130 administration of ION nodes that are included in this ADM deal with 131 contacts (information about periods of data transmission), ranges 132 (periods of time when the distance between two nodes is constant), 133 occupancy limits (the maximum amount of megabytes of storage space in 134 ION's SDR non volatile heap and/or local file system), rates of data 135 production, congestion, consumption (rate of continuous data delivery 136 to local BP applications), and time. 138 All ADMs have metadata that includes the name, namespace, and version 139 of the ADM, as well as the name of the organization that is issuing 140 that particular ADM. This is important for identification purposes 141 of the ADMs and to ensure version control of the encoding. 143 3. Naming and Identification 145 This section outlines the namespaces used to uniquely identify ADM 146 objects in this specification. 148 3.1. Namespace and Nicknames 150 In accordance with [I-D.birrane-dtn-adm], every ADM is assigned a 151 moderated Namespace. In accordance with [I-D.birrane-dtn-amp], these 152 namespaces may be enumerated for compactness. The namespace and ADM 153 identification for these objects is defined as follows. 155 +-----------------+------------------+ 156 | Identifier | Value | 157 +-----------------+------------------+ 158 | Namespace | DTN/ION/ionadmin | 159 | | | 160 | ADM Enumeration | 7 | 161 +-----------------+------------------+ 163 Table 1: Namespace Information 165 Given the above ADM enumeration, in accordance with 166 [I-D.birrane-dtn-amp], the following AMP nicknames are defined. 168 +----------+------------------------------+ 169 | Nickname | Collection | 170 +----------+------------------------------+ 171 | 140 | DTN/ION/ionadmin/Const | 172 | | | 173 | 141 | DTN/ION/ionadmin/Ctrl | 174 | | | 175 | 142 | DTN/ION/ionadmin/Edd | 176 | | | 177 | 143 | DTN/ION/ionadmin/Mac | 178 | | | 179 | 144 | DTN/ION/ionadmin/Oper | 180 | | | 181 | 145 | DTN/ION/ionadmin/Rptt | 182 | | | 183 | 147 | DTN/ION/ionadmin/Tblt | 184 | | | 185 | 149 | DTN/ION/ionadmin/Var | 186 | | | 187 | 150 | DTN/ION/ionadmin/Mdat | 188 | | | 189 | 151-159 | DTN/ION/ionadmin/Reserved | 190 +----------+------------------------------+ 192 Table 2: ION Admin ADM Nicknames 194 4. ION Admin ADM JSON Encoding 196 The following is the JSON encoding of the ION Administration 197 Application Data Model: 199 { 200 "Mdat": [ 201 { 202 "name": "name", 203 "type": "STR", 204 "value": "ion_admin", 205 "description": "The human-readable name of the ADM." 206 }, 207 { 208 "name": "namespace", 209 "type": "STR", 210 "value": "DTN/ION/ionadmin", 211 "description": "The namespace of the ADM." 212 }, 213 { 214 "name": "version", 215 "type": "STR", 216 "value": "v0.0", 217 "description": "The version of the ADM." 218 }, 219 { 220 "name": "organization", 221 "type": "STR", 222 "value": "JHUAPL", 223 "description": "The name of the issuing organization of the ADM." 224 } 225 ], 227 "Edd": [ 228 { 229 "name": "clock_error", 230 "type": "UINT", 231 "description": "This is how accurate the ION Agent's clock is." 232 }, 233 { 234 "name": "clock_sync", 235 "type": "UINT", 236 "description": "This is whether or not the the computer on which 237 the local ION node is running has a synchronized clock." 238 }, 239 { 240 "name": "congestion_alarm_control", 241 "type": "UINT", 242 "description": "This is whether or not the node has a control 243 that will set off alarm if it will become congested at some 244 future time." 245 }, 246 { 247 "name": "congestion_end_time_forecasts", 248 "type": "UINT", 249 "description": "This is when the node will be predicted to be no 250 longer congested." 251 }, 252 { 253 "name": "consumption_rate", 254 "type": "UINT", 255 "description": "This is the mean rate of continuous data delivery 256 to local BP applications." 257 }, 258 { 259 "name": "inbound_file_system_occupancy_limit", 260 "type": "UINT", 261 "description": "This is the maximum number of megabytes of 262 storage space in ION's local file system that can be used for 263 the storage of inbound zero-copy objects. The default heap 264 limit is 1 Terabyte." 265 }, 266 { 267 "name": "inbound_heap_occupancy_limit", 268 "type": "UINT", 269 "description":"This is the maximum number of megabytes of storage 270 space in ION's SDR non-volatile heap that can be used for the 271 storage of inbound zero-copy objects. The default heap limit is 272 30% of the SDR data space's total heap size." 273 }, 274 { 275 "name": "number", 276 "type": "UINT", 277 "description": "This is a CBHE node number which uniquely 278 identifies the node in the delay-tolerant network." 279 }, 280 { 281 "name": "outbound_file_system_occupancy_limit", 282 "type": "UINT", 283 "description":"This is the maximum number of megabytes of storage 284 space in ION's local file system that can be used for the 285 storage of outbound zero-copy objects. The default heap 286 limit is 1 Terabyte." 287 }, 288 { 289 "name": "outbound_heap_occupancy_limit", 290 "type": "UINT", 291 "description":"This is the maximum number of megabytes of storage 292 space in ION's SDR non-volatile heap that can be used for the 293 storage of outbound zero-copy objects. The default heap limit 294 is 30% of the SDR data space's total heap size." 295 }, 296 { 297 "name": "production_rate", 298 "type": "UINT", 299 "description": "This is the rate of local data production." 300 }, 301 { 302 "name": "ref_time", 303 "type": "TV", 304 "description": "This is the reference time that will be used for 305 interpreting relative time values from now until the next revision 306 of reference time." 307 }, 308 { 309 "name": "utc_delta", 310 "type": "UINT", 311 "description": "The UTC delta is used to compensate for error 312 (drift) in clocks, particularly spacecraft clocks. The hardware 313 clock on a spacecraft might gain or lose a few seconds every 314 month, to the point at which its understanding of the current 315 time - as reported out by the operating system - might differ 316 significantly from the actual value of UTC as reported by 317 authoritative clocks on Earth. To compensate for this 318 difference without correcting the clock itself (which can be 319 difficult and dangerous), ION simply adds the UTC 320 delta to the UTC reported by the operating system." 321 }, 322 { 323 "name": "version", 324 "type": "STR", 325 "description": "This is the version of ION that is currently 326 installed." 327 } 328 ], 330 "Tblt": [ 331 { 332 "name": "contacts", 333 "columns": [ 334 {"type":"TV","name":"start_time"}, 335 {"type":"TV","name":"stop_time"}, 336 {"type":"UINT","name":"source_node"}, 337 {"type":"STR","name":"dest_node"}, 338 {"type":"REAL32","name":"xmit_data"}, 339 {"type":"REAL32","name":"prob"} 340 ], 341 "description": "This table shows all scheduled periods of data 342 transmission." 343 }, 344 { 345 "name": "describe_usage", 346 "columns": [ 347 {"type":"UINT","name":"current_data_space_occupancy"}, 348 {"type":"UINT","name":"total_zcp_space_occupancy"}, 349 {"type":"UINT","name":"max_lvl_occupancy"} 350 ], 351 "description": "This table shows ION's current data space 352 occupancy (the number of megabytes of space in the SDR 353 non-volatile heap and file system that are occupied by 354 inbound and outbound zero-copy objects), the total 355 zero-copy-object space occupancy ceiling, and the maximum level 356 of occupancy predicted by the most recent ionadmin 357 congestion forecast computation." 358 }, 359 { 360 "name": "ranges", 361 "columns": [ 362 {"type":"TV","name":"start"}, 363 {"type":"TV","name":"stop"}, 364 {"type":"UINT","name":"node"}, 365 {"type":"UINT","name":"other_node"}, 366 {"type":"UINT","name":"distance"} 367 ], 368 "description": "This table shows all predicted periods of 369 constant distance between nodes." 370 } 371 ], 373 "Ctrl": [ 374 { 375 "name": "node_init", 376 "parmspec": [ 377 {"type":"UINT","name":"node_nbr"}, 378 {"type":"STR","name":"config_file"} 379 ], 380 "description":"Until this control is executed, the local ION node 381 does not exist and most ionadmin controls will fail. The 382 control configures the local node to be identified by 383 node_number, a CBHE node number which uniquely identifies the 384 node in the delay-tolerant network. It also configures ION's 385 data space (SDR) and shared working-memory region. For this 386 purpose it uses a set of default settings if no argument 387 follows node_number or if the argument following node_number is 388 ''; otherwise it uses the configuration settings found in a 389 configuration file. If configuration file name is provided, 390 then the configuration file's name is implicitly 391 'hostname.ionconfig'; otherwise, ion_config_filename is taken 392 to be the explicit configuration file name." 393 }, 394 { 395 "name": "node_clock_error_set", 396 "parmspec": [ 397 {"type":"UINT","name":"known_maximum_clock_error"} 398 ], 399 "description": "This management control sets ION's understanding 400 of the accuracy of the scheduled start and stop times of 401 planned contacts, in seconds. The default value is 1." 402 }, 403 { 404 "name": "node_clock_sync_set", 405 "parmspec": [ 406 {"type":"BOOL","name":"new_state"} 407 ], 408 "description": "This management control reports whether or not 409 the computer on which the local ION node is running has a 410 synchronized clock." 411 }, 412 { 413 "name": "node_congestion_alarm_control_set", 414 "parmspec": [ 415 {"type":"STR","name":"congestion_alarm_control"} 416 ], 417 "description": "This management control establishes a control 418 which will automatically be executed whenever ionadmin 419 predicts that the node will become congested at some 420 future time." 421 }, 422 { 423 "name": "node_congestion_end_time_forecasts_set", 424 "parmspec": [ 425 {"type":"UINT","name":"end_time_for_congestion_forcasts"} 426 ], 427 "description": "This management control sets the end time for 428 computed congestion forecasts. Setting congestion forecast 429 horizon to zero sets the congestion forecast end time to 430 infinite time in the future: if there is any predicted net 431 growth in bundle storage space occupancy at all, following the 432 end of the last scheduled contact, then eventual congestion 433 will be predicted. The default value is zero, i.e., 434 no end time." 435 }, 436 { 437 "name": "node_consumption_rate_set", 438 "parmspec": [ 439 {"type":"UINT","name":"planned_data_consumption_rate"} 440 ], 441 "description": "This management control sets ION's expectation of 442 the mean rate of continuous data delivery to local BP 443 applications throughout the period of time over which 444 congestion forecasts are computed. For nodes that function only 445 as routers this variable will normally be zero. 446 A value of -1, which is the default, indicates that the rate of 447 local data consumption is unknown; in that case 448 local data consumption is not considered in the computation of 449 congestion forecasts." 450 }, 451 { 452 "name": "node_contact_add", 453 "parmspec": [ 454 {"type":"TV","name":"start"}, 455 {"type":"TV","name":"stop"}, 456 {"type":"UINT","name":"node_id"}, 457 {"type":"STR","name":"dest"}, 458 {"type":"FLOAT32","name":"data_rate"}, 459 {"type":"FLOAT32","name":"prob"} 460 ], 461 "description": "This control schedules a period of data 462 transmission from source_node to dest_node. The period of 463 transmission will begin at start_time and end at stop_time, and 464 the rate of data transmission will be xmit_data_rate 465 bytes/second. Our confidence in the contact defaults to 1.0, 466 indicating that the contact is scheduled - not that 467 non-occurrence of the contact is impossible, just that 468 occurrence of the contact is planned and scheduled rather than 469 merely imputed from past node behavior. In the latter case, 470 confidence indicates our estimation of the likelihood of this 471 potential contact." 472 }, 473 { 474 "name": "node_contact_del", 475 "parmspec": [ 476 {"type":"TV","name":"start"}, 477 {"type":"UINT","name":"node_id"}, 478 {"type":"STR","name":"dest"} 479 ], 480 "description": "This control deletes the scheduled period of data 481 transmission from source_node to dest_node starting at 482 start_time. To delete all contacts between some pair of nodes, 483 use '*' as start_time." 484 }, 485 { 486 "name": "node_inbound_heap_occupancy_limit_set", 487 "parmspec": [ 488 {"type":"UINT","name":"heap_occupancy_limit"}, 489 {"type":"UINT","name":"file_system_occupancy_limit"} 490 ], 491 "description":"This management control sets the maximum number of 492 megabytes of storage space in ION's SDR non-volatile heap that 493 can be used for the storage of inbound zero-copy objects. A 494 value of -1 for either limit signifies 'leave unchanged'. 495 The default heap limit is 30% of the SDR data space's 496 total heap size." 497 }, 498 { 499 "name": "node_outbound_heap_occupancy_limit_set", 500 "parmspec": [ 501 {"type":"UINT","name":"heap_occupancy_limit"}, 502 {"type":"UINT","name":"file_system_occupancy_limit"} 503 ], 504 "description":"This management control sets the maximum number of 505 megabytes of storage space in ION's SDR non-volatile heap that 506 can be used for the storage of outbound zero-copy objects. 507 A value of -1 for either limit signifies 'leave unchanged'. 508 The default heap limit is 30% of the SDR data space's 509 total heap size." 510 }, 511 { 512 "name": "node_production_rate_set", 513 "parmspec": [ 514 {"type":"UINT","name":"planned_data_production_rate"} 515 ], 516 "description": "This management control sets ION's expectation of 517 the mean rate of continuous data origination by local BP 518 applications throughout the period of time over which 519 congestion forecasts are computed. For nodes that function only 520 as routers this variable will normally be zero. A value of -1, 521 which is the default, indicates that the rate of local data 522 production is unknown; in that case local data production is 523 not considered in the computation of congestion forecasts." 524 }, 525 { 526 "name": "node_range_add", 527 "parmspec": [ 528 {"type":"TV","name":"start"}, 529 {"type":"TV","name":"stop"}, 530 {"type":"UINT","name":"node"}, 531 {"type":"UINT","name":"other_node"}, 532 {"type":"UINT","name":"distance"} 533 ], 534 "description": "This control predicts a period of time during 535 which the distance from node to other_node will be constant to 536 within one light second. The period will begin at start_time 537 and end at stop_time, and the distance between the nodes during 538 that time will be distance light seconds." 539 }, 540 { 541 "name": "node_range_del", 542 "parmspec": [ 543 {"type":"TV","name":"start"}, 544 {"type":"UINT","name":"node"}, 545 {"type":"UINT","name":"other_node"} 546 ], 547 "description": "This control deletes the predicted period of 548 constant distance between node and other_node starting at 549 start_time. To delete all ranges between some pair of nodes, 550 use '*' as start_time." 551 }, 552 { 553 "name": "node_ref_time_set", 554 "parmspec": [ 555 {"type":"TV","name":"time"} 556 ], 557 "description": "This is used to set the reference time that will 558 be used for interpreting relative time values from now until 559 the next revision of reference time. Note that the new 560 reference time can be a relative time, i.e., an offset beyond 561 the current reference time." 562 }, 563 { 564 "name": "node_utc_delta_set", 565 "parmspec": [ 566 {"type":"UINT","name":"local_time_sec_after_utc"} 567 ], 568 "description": "This management control sets ION's understanding 569 of the current difference between correct UTC time and the time 570 values reported by the clock for the local ION node's computer. 571 This delta is automatically applied to locally obtained time 572 values whenever ION needs to know the current time." 573 }, 574 { 575 "name": "list_contacts", 576 "description": "Lists all schedule periods of data transmission." 577 }, 578 { 579 "name": "list_usage", 580 "description": "Lists ION's current data space occupancy." 581 }, 582 { 583 "name": "list_ranges", 584 "description": "Lists all predefined periods of constant distance 585 between nodes." 586 } 587 ] 588 } 590 5. IANA Considerations 592 At this time, this protocol has no fields registered by IANA. 594 6. References 595 6.1. Informative References 597 [I-D.birrane-dtn-ama] 598 Birrane, E., "Asynchronous Management Architecture", 599 draft-birrane-dtn-ama-07 (work in progress), June 2018. 601 6.2. Normative References 603 [I-D.birrane-dtn-adm] 604 Birrane, E., DiPietro, E., and D. Linko, "AMA Application 605 Data Model", draft-birrane-dtn-adm-02 (work in progress), 606 June 2018. 608 [I-D.birrane-dtn-amp] 609 Birrane, E., "Asynchronous Management Protocol", draft- 610 birrane-dtn-amp-04 (work in progress), June 2018. 612 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 613 Requirement Levels", BCP 14, RFC 2119, 614 DOI 10.17487/RFC2119, March 1997, 615 . 617 Authors' Addresses 619 Edward J. Birrane 620 Johns Hopkins Applied Physics Laboratory 622 Email: Edward.Birrane@jhuapl.edu 624 Evana DiPietro 625 Johns Hopkins Applied Physics Laboratory 627 Email: Evana.DiPietro@jhuapl.edu 629 David Linko 630 Johns Hopkins Applied Physics Laboratory 632 Email: David.Linko@jhuapl.edu