Skip to content

Commit

Permalink
Add changes for 9f8111d
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Aug 18, 2023
1 parent 6e561df commit 4cbaaed
Show file tree
Hide file tree
Showing 235 changed files with 4,275 additions and 3,402 deletions.
38 changes: 19 additions & 19 deletions Contribution/AMQPprimer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=88a95e73"></script>
<script src="../_static/documentation_options.js?v=dfb9cee5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand Down Expand Up @@ -135,7 +135,7 @@
}
</style>
<section id="amqp-primer-for-sarracenia">
<h1><a class="toc-backref" href="#id2" role="doc-backlink">AMQP - Primer for Sarracenia</a><a class="headerlink" href="#amqp-primer-for-sarracenia" title="Permalink to this heading"></a></h1>
<h1><a class="toc-backref" href="#id2" role="doc-backlink">AMQP - Primer for Sarracenia</a><a class="headerlink" href="#amqp-primer-for-sarracenia" title="Link to this heading"></a></h1>
<p>This is a short but rather dense briefing to explain
the motivation for the use of AMQP by the MetPX-Sarracenia
data pump. Sarracenia is essentially an AMQP application,
Expand Down Expand Up @@ -178,14 +178,14 @@ <h1><a class="toc-backref" href="#id2" role="doc-backlink">AMQP - Primer for Sar
</ul>
</nav>
<section id="amqp-feature-selection">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">AMQP Feature Selection</a><a class="headerlink" href="#amqp-feature-selection" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id3" role="doc-backlink">AMQP Feature Selection</a><a class="headerlink" href="#amqp-feature-selection" title="Link to this heading"></a></h2>
<p>AMQP is a universal message passing protocol with many different
options to support many different messaging patterns. MetPX-sarracenia specifies and uses a
small subset of AMQP patterns. An important element of Sarracenia development was to
select from the many possibilities a small subset of methods are general and
easily understood, in order to maximize potential for interoperability.</p>
<section id="analogy-ftp">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Analogy FTP</a><a class="headerlink" href="#analogy-ftp" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Analogy FTP</a><a class="headerlink" href="#analogy-ftp" title="Link to this heading"></a></h3>
<p>Specifying the use of a protocol alone may be insufficient to provide enough information for
data exchange and interoperability. For example when exchanging data via FTP, a number of choices
need to be made above and beyond the protocol.</p>
Expand All @@ -203,15 +203,15 @@ <h3><a class="toc-backref" href="#id4" role="doc-backlink">Analogy FTP</a><a cla
layered on top of AMQP is to be a minimum amount to achieve meaningful data exchange.</p>
</section>
<section id="amqp-not-1-0-but-0-8-or-0-9">
<h3><a class="toc-backref" href="#id5" role="doc-backlink">AMQP: not 1.0, but 0.8 or 0.9</a><a class="headerlink" href="#amqp-not-1-0-but-0-8-or-0-9" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id5" role="doc-backlink">AMQP: not 1.0, but 0.8 or 0.9</a><a class="headerlink" href="#amqp-not-1-0-but-0-8-or-0-9" title="Link to this heading"></a></h3>
<p>AMQP 1.0 standardizes the on-the-wire protocol, but removed all broker standardization.
As the use of brokers is key to Sarracenia´s use of, was a fundamental element of earlier standards,
and as the 1.0 standard is relatively controversial, this protocol assumes a pre 1.0 standard broker,
as is provided by many free brokers, such as rabbitmq and Apache QPid, often referred to as 0.8,
but 0.9 and post 0.9 brokers could inter-operate well.</p>
</section>
<section id="named-exchanges-and-queues">
<h3><a class="toc-backref" href="#id6" role="doc-backlink">Named Exchanges and Queues</a><a class="headerlink" href="#named-exchanges-and-queues" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id6" role="doc-backlink">Named Exchanges and Queues</a><a class="headerlink" href="#named-exchanges-and-queues" title="Link to this heading"></a></h3>
<p>In AMQP prior to 1.0, many different actors can define communication parameters, such as exchanges
to publish to, queues where notification messages accumulate, and bindings between the two. Applications
and users declare and user their exchanges, queues, and bindings. All of this was dropped
Expand All @@ -234,7 +234,7 @@ <h3><a class="toc-backref" href="#id6" role="doc-backlink">Named Exchanges and Q
</div>
</section>
<section id="topic-based-exchanges">
<h3><a class="toc-backref" href="#id7" role="doc-backlink">Topic-based Exchanges</a><a class="headerlink" href="#topic-based-exchanges" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id7" role="doc-backlink">Topic-based Exchanges</a><a class="headerlink" href="#topic-based-exchanges" title="Link to this heading"></a></h3>
<p>Topic-based exchanges are used exclusively. AMQP supports many other types of exchanges,
but sr_post have the topic sent in order to support server side filtering by using topic
based filtering. At AMQP 1.0, topic-based exchanges (indeed all exchanges, are no
Expand All @@ -250,7 +250,7 @@ <h3><a class="toc-backref" href="#id7" role="doc-backlink">Topic-based Exchanges
At the time of writing: v02.post is the topic prefix for current notification messages.</p>
</section>
<section id="little-data">
<h3><a class="toc-backref" href="#id8" role="doc-backlink">Little Data</a><a class="headerlink" href="#little-data" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id8" role="doc-backlink">Little Data</a><a class="headerlink" href="#little-data" title="Link to this heading"></a></h3>
<p>The AMQP messages contain notification messages, no actual file data. AMQP is optimized for and assumes
small messages. Keeping the messages small allows for maximum message throughtput and permits
clients to use priority mechanisms based on transfer of data, rather than the notification messages.
Expand Down Expand Up @@ -284,7 +284,7 @@ <h3><a class="toc-backref" href="#id8" role="doc-backlink">Little Data</a><a cla
to occur.</p>
</section>
<section id="other-parameters">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Other Parameters</a><a class="headerlink" href="#other-parameters" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Other Parameters</a><a class="headerlink" href="#other-parameters" title="Link to this heading"></a></h3>
<p>AMQP has many other settings, and reliability for a particular use case
is assured by making the right choices.</p>
<ul class="simple">
Expand All @@ -301,7 +301,7 @@ <h3><a class="toc-backref" href="#id9" role="doc-backlink">Other Parameters</a><
</section>
</section>
<section id="mapping-amqp-concepts-to-sarracenia">
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Mapping AMQP Concepts to Sarracenia</a><a class="headerlink" href="#mapping-amqp-concepts-to-sarracenia" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Mapping AMQP Concepts to Sarracenia</a><a class="headerlink" href="#mapping-amqp-concepts-to-sarracenia" title="Link to this heading"></a></h2>
<a class="reference internal image-reference" href="../_images/AMQP4Sarra.svg"><img alt="../_images/AMQP4Sarra.svg" class="align-center" height="302" src="../_images/AMQP4Sarra.svg" width="434" /></a>
<p>An AMQP Server is called a Broker. <em>Broker</em> is sometimes used to refer to the software,
other times server running the broker software (same confusion as <em>web server</em>.) In the above diagram, AMQP vocabulary is in Orange, and Sarracenia terms are in blue.</p>
Expand Down Expand Up @@ -358,7 +358,7 @@ <h2><a class="toc-backref" href="#id10" role="doc-backlink">Mapping AMQP Concept
</ul>
</section>
<section id="sarracenia-is-an-mqp-application">
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Sarracenia is an MQP Application</a><a class="headerlink" href="#sarracenia-is-an-mqp-application" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Sarracenia is an MQP Application</a><a class="headerlink" href="#sarracenia-is-an-mqp-application" title="Link to this heading"></a></h2>
<p>in Version 2, MetPX-Sarracenia is only a light wrapper/coating around AMQP.
in Version 3, this was reworked and an MQTT driver was added to make it
less AMQP specific.</p>
Expand Down Expand Up @@ -402,7 +402,7 @@ <h2><a class="toc-backref" href="#id11" role="doc-backlink">Sarracenia is an MQP
</ul>
</section>
<section id="review">
<h2><a class="toc-backref" href="#id12" role="doc-backlink">Review</a><a class="headerlink" href="#review" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id12" role="doc-backlink">Review</a><a class="headerlink" href="#review" title="Link to this heading"></a></h2>
<p>If you understood the rest of the document, this should make sense to you:</p>
<p>An AMQP broker is a server process that houses exchanges and queues used to route notification messages
with very low latency. A publisher sends notification messages to an exchange, while a consumer reads
Expand All @@ -412,9 +412,9 @@ <h2><a class="toc-backref" href="#id12" role="doc-backlink">Review</a><a class="
browse if you visit the corresponding web server.</p>
</section>
<section id="appendix-a-background">
<h2><a class="toc-backref" href="#id13" role="doc-backlink">Appendix A: Background</a><a class="headerlink" href="#appendix-a-background" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id13" role="doc-backlink">Appendix A: Background</a><a class="headerlink" href="#appendix-a-background" title="Link to this heading"></a></h2>
<section id="why-use-amqp">
<h3><a class="toc-backref" href="#id14" role="doc-backlink">Why Use AMQP?</a><a class="headerlink" href="#why-use-amqp" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id14" role="doc-backlink">Why Use AMQP?</a><a class="headerlink" href="#why-use-amqp" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>open standard, multiple free implementations.</p></li>
<li><p>low latency message passing.</p></li>
Expand All @@ -425,7 +425,7 @@ <h3><a class="toc-backref" href="#id14" role="doc-backlink">Why Use AMQP?</a><a
</ul>
</section>
<section id="where-does-amqp-come-from">
<h3><a class="toc-backref" href="#id15" role="doc-backlink">Where does AMQP Come From?</a><a class="headerlink" href="#where-does-amqp-come-from" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id15" role="doc-backlink">Where does AMQP Come From?</a><a class="headerlink" href="#where-does-amqp-come-from" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Open International standard from financial world.</p></li>
<li><p>Many proprietary similar systems exist, AMQP built to get away from lock-in. Standard is built with long experience of vendor messaging systems, and so quite mature.</p></li>
Expand All @@ -435,17 +435,17 @@ <h3><a class="toc-backref" href="#id15" role="doc-backlink">Where does AMQP Come
</ul>
</section>
<section id="intel-cray-hpc-stack">
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Intel/Cray HPC Stack</a><a class="headerlink" href="#intel-cray-hpc-stack" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Intel/Cray HPC Stack</a><a class="headerlink" href="#intel-cray-hpc-stack" title="Link to this heading"></a></h3>
<p><a class="reference external" href="http://www.intel.com/content/www/us/en/high-performance-computing/aurora-fact-sheet.html">Intel/Cray HPC stack</a></p>
<a class="reference internal image-reference" href="../_images/IntelHPCStack.png"><img alt="../_images/IntelHPCStack.png" class="align-center" src="../_images/IntelHPCStack.png" style="width: 505.5px; height: 311.0px;" /></a>
</section>
<section id="openstack">
<h3><a class="toc-backref" href="#id17" role="doc-backlink">OpenStack</a><a class="headerlink" href="#openstack" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id17" role="doc-backlink">OpenStack</a><a class="headerlink" href="#openstack" title="Link to this heading"></a></h3>
<p><a class="reference external" href="http://docs.openstack.org/developer/nova/rpc.html">AMQP is the messaging technology chosen by the OpenStack cloud.</a></p>
<a class="reference internal image-reference" href="../_images/OpenStackArch.png"><img alt="../_images/OpenStackArch.png" class="align-center" src="../_images/OpenStackArch.png" style="width: 436.79999999999995px; height: 349.29999999999995px;" /></a>
</section>
<section id="how-to-adopt-amqp">
<h3><a class="toc-backref" href="#id18" role="doc-backlink">How to Adopt AMQP</a><a class="headerlink" href="#how-to-adopt-amqp" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id18" role="doc-backlink">How to Adopt AMQP</a><a class="headerlink" href="#how-to-adopt-amqp" title="Link to this heading"></a></h3>
<p>Adopting AMQP is more like adopting XML than it is like adopting FTP. FTP interoperability
is easy as choices are limited. With XML, however you get <strong>more palette than painting.</strong> Many
different dialects, schema methods, etc… XML will be valid and parse, but without
Expand Down
6 changes: 3 additions & 3 deletions Contribution/BasicIdea.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=88a95e73"></script>
<script src="../_static/documentation_options.js?v=dfb9cee5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand Down Expand Up @@ -114,7 +114,7 @@
</style>
<p>Status: Approved-Draft1-20150608</p>
<section id="basic-idea">
<h1>Basic Idea<a class="headerlink" href="#basic-idea" title="Permalink to this heading"></a></h1>
<h1>Basic Idea<a class="headerlink" href="#basic-idea" title="Link to this heading"></a></h1>
<p>MetPX-Sarracenia is a data duplication or distribution engine that leverages existing
standard technologies (sftp and web servers and AMQP brokers) to achieve real-time message
delivery and end to end transparency in file transfers. Whereas in Sundew, each
Expand Down
Loading

0 comments on commit 4cbaaed

Please sign in to comment.