€cdocutils.nodes document q)q}q(U nametypesq}q(X$use case 30 - mn outage notificationqNXuc30qˆXhistoryqˆuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU"use-case-30-mn-outage-notificationqhUuc30qhUhistoryquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX .. _UC30:UparentqhUsourceqXj/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/30_uc.txtqUtagnameqUtargetqU attributesq }q!(Uidsq"]Ubackrefsq#]Udupnamesq$]Uclassesq%]Unamesq&]Urefidq'huUlineq(KUdocumentq)hh]ubcdocutils.nodes section q*)q+}q,(hUhhhhUexpect_referenced_by_nameq-}q.hhshUsectionq/h }q0(h$]h%]h#]h"]q1(hheh&]q2(hheuh(Kh)hUexpect_referenced_by_idq3}q4hhsh]q5(cdocutils.nodes title q6)q7}q8(hX$Use Case 30 - MN Outage Notificationq9hh+hhhUtitleq:h }q;(h$]h%]h#]h"]h&]uh(Kh)hh]q…q?}q@(hh9hh7ubaubcsphinx.addnodes index qA)qB}qC(hUhh+hhhUindexqDh }qE(h"]h#]h$]h%]h&]UentriesqF]qG((UsingleqHX Use Case 30Uindex-0qIUNtqJ(hHXUC30hIUNtqK(hHX MN outagehIUNtqL(hHXhealthhIUNtqM(hHX notificationhIUNtqNeUinlineqO‰uh(Kh)hh]ubh)qP}qQ(hUhh+hhhhh }qR(h"]h#]h$]h%]h&]h'hIuh(Kh)hh]ubcdocutils.nodes definition_list qS)qT}qU(hUhh+hhh-}hUdefinition_listqVh }qW(h$]h%]h#]h"]qXhIah&]uh(Nh)hh3}qYhIhPsh]qZ(cdocutils.nodes definition_list_item q[)q\}q](hX+Revisions View document revision history_. hhThhhUdefinition_list_itemq^h }q_(h$]h%]h#]h"]h&]uh(K h]q`(cdocutils.nodes term qa)qb}qc(hX Revisionsqdhh\hhhUtermqeh }qf(h$]h%]h#]h"]h&]uh(K h]qgh=X Revisionsqh…qi}qj(hhdhhbubaubcdocutils.nodes definition qk)ql}qm(hUh }qn(h$]h%]h#]h"]h&]uhh\h]qocdocutils.nodes paragraph qp)qq}qr(hX View document revision history_.hhlhhhU paragraphqsh }qt(h$]h%]h#]h"]h&]uh(K h]qu(h=XView document revision qv…qw}qx(hXView document revision hhqubcdocutils.nodes reference qy)qz}q{(hXhistory_Uresolvedq|KhhqhU referenceq}h }q~(UnameXhistoryqUrefuriq€X”https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/30_uc.txtqh"]h#]h$]h%]h&]uh]q‚h=Xhistoryqƒ…q„}q…(hUhhzubaubh=X.…q†}q‡(hX.hhqubeubahU definitionqˆubeubh[)q‰}qŠ(hXGoal MN can notify CN about pending outages, severity, and duration, and CNs may want to act on that knowledge to maintain seamless operation. hhThhhh^h }q‹(h$]h%]h#]h"]h&]uh(K h)hh]qŒ(ha)q}qŽ(hXGoalqhh‰hhhheh }q(h$]h%]h#]h"]h&]uh(K h]q‘h=XGoalq’…q“}q”(hhhhubaubhk)q•}q–(hUh }q—(h$]h%]h#]h"]h&]uhh‰h]q˜hp)q™}qš(hX‰MN can notify CN about pending outages, severity, and duration, and CNs may want to act on that knowledge to maintain seamless operation.q›hh•hhhhsh }qœ(h$]h%]h#]h"]h&]uh(K h]qh=X‰MN can notify CN about pending outages, severity, and duration, and CNs may want to act on that knowledge to maintain seamless operation.qž…qŸ}q (hh›hh™ubaubahhˆubeubh[)q¡}q¢(hX«Summary It is likely that Member Nodes will need to be taken offline from time to time for maintenance or other planned outages. There should be a mechanism for Member Nodes to notify Coordinating Nodes of the impending outage so that the Coordinating Nodes can adjust replication of content to ensure ongoing availability. The migration of content should be tempered with the duration of the outage and the number of existing copies of content available on other node. For short durations outages, the expense of moving the content around may not be justified. However, for lengthy outages, it would be preferable to replicate as much content as practical to ensure ongoing access. hhThhhh^h }q£(h$]h%]h#]h"]h&]uh(Kh)hh]q¤(ha)q¥}q¦(hXSummaryq§hh¡hhhheh }q¨(h$]h%]h#]h"]h&]uh(Kh]q©h=XSummaryqª…q«}q¬(hh§hh¥ubaubhk)q­}q®(hUh }q¯(h$]h%]h#]h"]h&]uhh¡h]q°hp)q±}q²(hX¢It is likely that Member Nodes will need to be taken offline from time to time for maintenance or other planned outages. There should be a mechanism for Member Nodes to notify Coordinating Nodes of the impending outage so that the Coordinating Nodes can adjust replication of content to ensure ongoing availability. The migration of content should be tempered with the duration of the outage and the number of existing copies of content available on other node. For short durations outages, the expense of moving the content around may not be justified. However, for lengthy outages, it would be preferable to replicate as much content as practical to ensure ongoing access.q³hh­hhhhsh }q´(h$]h%]h#]h"]h&]uh(Kh]qµh=X¢It is likely that Member Nodes will need to be taken offline from time to time for maintenance or other planned outages. There should be a mechanism for Member Nodes to notify Coordinating Nodes of the impending outage so that the Coordinating Nodes can adjust replication of content to ensure ongoing availability. The migration of content should be tempered with the duration of the outage and the number of existing copies of content available on other node. For short durations outages, the expense of moving the content around may not be justified. However, for lengthy outages, it would be preferable to replicate as much content as practical to ensure ongoing access.q¶…q·}q¸(hh³hh±ubaubahhˆubeubh[)q¹}qº(hXiActors - Member Node - Member Node administrator - Coordinating Nodes - Coordinating Node administrators hhThhhh^h }q»(h$]h%]h#]h"]h&]uh(Kh)hh]q¼(ha)q½}q¾(hXActorsq¿hh¹hhhheh }qÀ(h$]h%]h#]h"]h&]uh(Kh]qÁh=XActorsqÂ…qÃ}qÄ(hh¿hh½ubaubhk)qÅ}qÆ(hUh }qÇ(h$]h%]h#]h"]h&]uhh¹h]qÈcdocutils.nodes bullet_list qÉ)qÊ}qË(hUh }qÌ(UbulletqÍX-h"]h#]h$]h%]h&]uhhÅh]qÎ(cdocutils.nodes list_item qÏ)qÐ}qÑ(hX Member NodeqÒh }qÓ(h$]h%]h#]h"]h&]uhhÊh]qÔhp)qÕ}qÖ(hhÒhhÐhhhhsh }q×(h$]h%]h#]h"]h&]uh(Kh]qØh=X Member NodeqÙ…qÚ}qÛ(hhÒhhÕubaubahU list_itemqÜubhÏ)qÝ}qÞ(hXMember Node administratorqßh }qà(h$]h%]h#]h"]h&]uhhÊh]qáhp)qâ}qã(hhßhhÝhhhhsh }qä(h$]h%]h#]h"]h&]uh(Kh]qåh=XMember Node administratorqæ…qç}qè(hhßhhâubaubahhÜubhÏ)qé}qê(hXCoordinating Nodesqëh }qì(h$]h%]h#]h"]h&]uhhÊh]qíhp)qî}qï(hhëhhéhhhhsh }qð(h$]h%]h#]h"]h&]uh(Kh]qñh=XCoordinating Nodesqò…qó}qô(hhëhhîubaubahhÜubhÏ)qõ}qö(hX!Coordinating Node administrators h }q÷(h$]h%]h#]h"]h&]uhhÊh]qøhp)qù}qú(hX Coordinating Node administratorsqûhhõhhhhsh }qü(h$]h%]h#]h"]h&]uh(Kh]qýh=X Coordinating Node administratorsqþ…qÿ}r(hhûhhùubaubahhÜubehU bullet_listrubahhˆubeubh[)r}r(hXPreconditions - Member Node is participating in the DataONE federation - Content stored on the Member Node needs to be available while offline hhThhhh^h }r(h$]h%]h#]h"]h&]uh(K#h)hh]r(ha)r}r(hX Preconditionsrhjhhhheh }r (h$]h%]h#]h"]h&]uh(K#h]r h=X Preconditionsr …r }r (hjhjubaubhk)r}r(hUh }r(h$]h%]h#]h"]h&]uhjh]rhÉ)r}r(hUh }r(hÍX-h"]h#]h$]h%]h&]uhjh]r(hÏ)r}r(hX6Member Node is participating in the DataONE federationrh }r(h$]h%]h#]h"]h&]uhjh]rhp)r}r(hjhjhhhhsh }r(h$]h%]h#]h"]h&]uh(K"h]rh=X6Member Node is participating in the DataONE federationr…r }r!(hjhjubaubahhÜubhÏ)r"}r#(hXFContent stored on the Member Node needs to be available while offline h }r$(h$]h%]h#]h"]h&]uhjh]r%hp)r&}r'(hXEContent stored on the Member Node needs to be available while offliner(hj"hhhhsh }r)(h$]h%]h#]h"]h&]uh(K#h]r*h=XEContent stored on the Member Node needs to be available while offliner+…r,}r-(hj(hj&ubaubahhÜubehjubahhˆubeubh[)r.}r/(hX3Triggers - A Member Node needs to be taken offline hhThhhh^h }r0(h$]h%]h#]h"]h&]uh(K&h)hh]r1(ha)r2}r3(hXTriggersr4hj.hhhheh }r5(h$]h%]h#]h"]h&]uh(K&h]r6h=XTriggersr7…r8}r9(hj4hj2ubaubhk)r:}r;(hUh }r<(h$]h%]h#]h"]h&]uhj.h]r=hÉ)r>}r?(hUh }r@(hÍX-h"]h#]h$]h%]h&]uhj:h]rAhÏ)rB}rC(hX(A Member Node needs to be taken offline h }rD(h$]h%]h#]h"]h&]uhj>h]rEhp)rF}rG(hX'A Member Node needs to be taken offlinerHhjBhhhhsh }rI(h$]h%]h#]h"]h&]uh(K&h]rJh=X'A Member Node needs to be taken offlinerK…rL}rM(hjHhjFubaubahhÜubahjubahhˆubeubh[)rN}rO(hXáPost Conditions - A decision has been made on which content to replicate from the Member Node - Content is replicated from the Member Node - Notification to the Member Node operator of replication completion is provided hhThhhh^h }rP(h$]h%]h#]h"]h&]uh(K.h)hh]rQ(ha)rR}rS(hXPost ConditionsrThjNhhhheh }rU(h$]h%]h#]h"]h&]uh(K.h]rVh=XPost ConditionsrW…rX}rY(hjThjRubaubhk)rZ}r[(hUh }r\(h$]h%]h#]h"]h&]uhjNh]r]hÉ)r^}r_(hUh }r`(hÍX-h"]h#]h$]h%]h&]uhjZh]ra(hÏ)rb}rc(hXKA decision has been made on which content to replicate from the Member Nodeh }rd(h$]h%]h#]h"]h&]uhj^h]rehp)rf}rg(hXKA decision has been made on which content to replicate from the Member Noderhhjbhhhhsh }ri(h$]h%]h#]h"]h&]uh(K)h]rjh=XKA decision has been made on which content to replicate from the Member Noderk…rl}rm(hjhhjfubaubahhÜubhÏ)rn}ro(hX*Content is replicated from the Member Noderph }rq(h$]h%]h#]h"]h&]uhj^h]rrhp)rs}rt(hjphjnhhhhsh }ru(h$]h%]h#]h"]h&]uh(K+h]rvh=X*Content is replicated from the Member Noderw…rx}ry(hjphjsubaubahhÜubhÏ)rz}r{(hXPNotification to the Member Node operator of replication completion is provided h }r|(h$]h%]h#]h"]h&]uhj^h]r}hp)r~}r(hXNNotification to the Member Node operator of replication completion is providedr€hjzhhhhsh }r(h$]h%]h#]h"]h&]uh(K,h]r‚h=XNNotification to the Member Node operator of replication completion is providedrƒ…r„}r…(hj€hj~ubaubahhÜubehjubahhˆubeubeubcdocutils.nodes comment r†)r‡}rˆ(hX @startuml images/30_seq.png participant "State of Health API" as c_health << Coordinating Node >> participant "State of Health API" as m_health << Member Node >> m_health -> c_health: reportPendingEvent () m_health <-- c_health: ack c_health -> c_health: actOnPendingEvent (event) @endumlhh+hhhUcommentr‰h }rŠ(U xml:spacer‹UpreserverŒh"]h#]h$]h%]h&]uh(K8h)hh]rh=X @startuml images/30_seq.png participant "State of Health API" as c_health << Coordinating Node >> participant "State of Health API" as m_health << Member Node >> m_health -> c_health: reportPendingEvent () m_health <-- c_health: ack c_health -> c_health: actOnPendingEvent (event) @endumlrŽ…r}r(hUhj‡ubaubcdocutils.nodes image r‘)r’}r“(hX.. image:: images/30_seq.png hh+hhhUimager”h }r•(UuriX!design/UseCases/images/30_seq.pngr–h"]h#]h$]h%]U candidatesr—}r˜U*j–sh&]uh(K:h)hh]ubhp)r™}rš(hX²*Figure 1.* Interactions for use case 30. MN can notify CN about pending outages, severity and duration, and CNs may want to act on that knowledge to maintain seamless operation.hh+hhhhsh }r›(h$]h%]h#]h"]h&]uh(K;h)hh]rœ(cdocutils.nodes emphasis r)rž}rŸ(hX *Figure 1.*h }r (h$]h%]h#]h"]h&]uhj™h]r¡h=X Figure 1.r¢…r£}r¤(hUhjžubahUemphasisr¥ubh=X§ Interactions for use case 30. MN can notify CN about pending outages, severity and duration, and CNs may want to act on that knowledge to maintain seamless operation.r¦…r§}r¨(hX§ Interactions for use case 30. MN can notify CN about pending outages, severity and duration, and CNs may want to act on that knowledge to maintain seamless operation.hj™ubeubh)r©}rª(hX¡.. _history: https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/30_uc.txtU referencedr«Khh+hhhhh }r¬(h€hh"]r­hah#]h$]h%]h&]r®hauh(K?h)hh]ubeubehUU transformerr¯NU footnote_refsr°}r±Urefnamesr²}r³h]r´hzasUsymbol_footnotesrµ]r¶Uautofootnote_refsr·]r¸Usymbol_footnote_refsr¹]rºU citationsr»]r¼h)hU current_liner½NUtransform_messagesr¾]r¿(cdocutils.nodes system_message rÀ)rÁ}rÂ(hUh }rÃ(h$]UlevelKh"]h#]Usourcehh%]h&]UlineKUtypeUINFOrÄuh]rÅhp)rÆ}rÇ(hUh }rÈ(h$]h%]h#]h"]h&]uhjÁh]rÉh=X*Hyperlink target "uc30" is not referenced.rÊ…rË}rÌ(hUhjÆubahhsubahUsystem_messagerÍubjÀ)rÎ}rÏ(hUh }rÐ(h$]UlevelKh"]h#]Usourcehh%]h&]UlineKUtypejÄuh]rÑhp)rÒ}rÓ(hUh }rÔ(h$]h%]h#]h"]h&]uhjÎh]rÕh=X-Hyperlink target "index-0" is not referenced.rÖ…r×}rØ(hUhjÒubahhsubahjÍubeUreporterrÙNUid_startrÚKU autofootnotesrÛ]rÜU citation_refsrÝ}rÞUindirect_targetsrß]ràUsettingsrá(cdocutils.frontend Values râorã}rä(Ufootnote_backlinksråKUrecord_dependenciesræNU rfc_base_urlrçUhttps://tools.ietf.org/html/rèU tracebackréˆUpep_referencesrêNUstrip_commentsrëNU toc_backlinksrìUentryríU language_coderîUenrïU datestamprðNU report_levelrñKU _destinationròNU halt_levelróKU strip_classesrôNh:NUerror_encoding_error_handlerrõUbackslashreplaceröUdebugr÷NUembed_stylesheetrø‰Uoutput_encoding_error_handlerrùUstrictrúU sectnum_xformrûKUdump_transformsrüNU docinfo_xformrýKUwarning_streamrþNUpep_file_url_templaterÿUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrˆUtrim_footnote_reference_spacer‰UenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformr ‰U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerhUgettext_compactrˆU generatorrNUdump_internalsrNU smart_quotesr‰U pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjúUauto_id_prefixr Uidr!Udoctitle_xformr"‰Ustrip_elements_with_classesr#NU _config_filesr$]Ufile_insertion_enabledr%ˆU raw_enabledr&KU dump_settingsr'NubUsymbol_footnote_startr(KUidsr)}r*(hh+hIhThh+hj©uUsubstitution_namesr+}r,hh)h }r-(h$]h"]h#]Usourcehh%]h&]uU footnotesr.]r/Urefidsr0}r1(h]r2hahI]r3hPauub.