Skip to content

Commit

Permalink
Deploy preview for PR 2303 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
seth-shaw-asu committed May 17, 2024
1 parent 391beb1 commit 7886b28
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 55 deletions.
86 changes: 31 additions & 55 deletions pr-preview/pr-2303/installation/manual/installing-alpaca/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -965,17 +965,16 @@
In this section, we will install:
</a>

<nav class="md-nav" aria-label="In this section, we will install:">
<ul class="md-nav__list">

<li class="md-nav__item">
</li>

<li class="md-nav__item">
<a href="#installing-activemq" class="md-nav__link">
Installing ActiveMQ
</a>

</li>
<li class="md-nav__item">

<li class="md-nav__item">
<a href="#installing-alpaca" class="md-nav__link">
Installing Alpaca
</a>
Expand Down Expand Up @@ -1003,25 +1002,14 @@
islandora-indexing-triplestore
</a>

</li>

</ul>
</nav>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#islandora-connector-derivative" class="md-nav__link">
islandora-connector-derivative
</a>

<nav class="md-nav" aria-label="islandora-connector-derivative">
<ul class="md-nav__list">
</li>

<li class="md-nav__item">
<a href="#customizing-http-client-timeouts" class="md-nav__link">
Expand All @@ -1035,6 +1023,11 @@
Alter HTTP options
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand All @@ -1047,11 +1040,6 @@
</ul>
</nav>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -2521,17 +2509,16 @@
In this section, we will install:
</a>

<nav class="md-nav" aria-label="In this section, we will install:">
<ul class="md-nav__list">

<li class="md-nav__item">
</li>

<li class="md-nav__item">
<a href="#installing-activemq" class="md-nav__link">
Installing ActiveMQ
</a>

</li>
<li class="md-nav__item">

<li class="md-nav__item">
<a href="#installing-alpaca" class="md-nav__link">
Installing Alpaca
</a>
Expand Down Expand Up @@ -2559,25 +2546,14 @@
islandora-indexing-triplestore
</a>

</li>

</ul>
</nav>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#islandora-connector-derivative" class="md-nav__link">
islandora-connector-derivative
</a>

<nav class="md-nav" aria-label="islandora-connector-derivative">
<ul class="md-nav__list">
</li>

<li class="md-nav__item">
<a href="#customizing-http-client-timeouts" class="md-nav__link">
Expand All @@ -2591,6 +2567,11 @@
Alter HTTP options
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand All @@ -2603,11 +2584,6 @@
</ul>
</nav>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -2644,7 +2620,7 @@ <h2 id="in-this-section-we-will-install">In this section, we will install:<a cla
<li><a href="https://activemq.apache.org/">Apache ActiveMQ</a>, a messaging server that will be used to handle communication between Alpaca and other components</li>
<li><a href="https://github.com/Islandora/Alpaca">Islandora/Alpaca</a>, Java middleware that handle communication between various components of Islandora.</li>
</ul>
<h3 id="installing-activemq">Installing ActiveMQ<a class="headerlink" href="#installing-activemq" title="Permanent link">&para;</a></h3>
<h2 id="installing-activemq">Installing ActiveMQ<a class="headerlink" href="#installing-activemq" title="Permanent link">&para;</a></h2>
<p>In our case, the default installation method for ActiveMQ via <code>apt-get</code> will suffice.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>activemq
</span></code></pre></div>
Expand All @@ -2660,14 +2636,14 @@ <h3 id="installing-activemq">Installing ActiveMQ<a class="headerlink" href="#ins
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>sudo<span class="w"> </span>apt-cache<span class="w"> </span>policy<span class="w"> </span>activemq
</span></code></pre></div>
<p>Write down the version listed under <code>Installed:</code>.</p>
<h3 id="installing-alpaca">Installing Alpaca<a class="headerlink" href="#installing-alpaca" title="Permanent link">&para;</a></h3>
<h2 id="installing-alpaca">Installing Alpaca<a class="headerlink" href="#installing-alpaca" title="Permanent link">&para;</a></h2>
<p>Install Java 11+ if you haven't already.</p>
<p>Make a directory for Alpaca and download the latest version of Alpaca from the <a href="https://repo1.maven.org/maven2/ca/islandora/alpaca/islandora-alpaca-app">Maven repository</a>. E.g.
<div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>mkdir /opt/alpaca
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>cd /opt/alpaca
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>curl -L https://repo1.maven.org/maven2/ca/islandora/alpaca/islandora-alpaca-app/2.2.0/islandora-alpaca-app-2.2.0-all.jar -o alpaca.jar
</span></code></pre></div></p>
<h4 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h4>
<h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h3>
<p>Alpaca is made up of several services, each of these can be enabled or disabled individually.</p>
<p>Alpaca takes an external file to configure its behaviour.</p>
<p>Look at the <a href="https://github.com/Islandora/Alpaca/blob/2.x/example.properties"><code>example.properties</code></a> file to see some example settings.</p>
Expand All @@ -2691,7 +2667,7 @@ <h4 id="configuration">Configuration<a class="headerlink" href="#configuration"
<p><div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>jms.concurrent-consumers=1
</span></code></pre></div>
This defines how many messages to process simultaneously.</p>
<h5 id="islandora-indexing-fcrepo">islandora-indexing-fcrepo<a class="headerlink" href="#islandora-indexing-fcrepo" title="Permanent link">&para;</a></h5>
<h4 id="islandora-indexing-fcrepo">islandora-indexing-fcrepo<a class="headerlink" href="#islandora-indexing-fcrepo" title="Permanent link">&para;</a></h4>
<p>This service manages a Drupal node into a corresponding Fedora resource.</p>
<p>It's properties are:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a># Fcrepo indexer options
Expand All @@ -2717,7 +2693,7 @@ <h5 id="islandora-indexing-fcrepo">islandora-indexing-fcrepo<a class="headerlink
<div class="language-text highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>fcrepo.indexer.async-consumer=true
</span></code></pre></div>
<p>This property allows the concurrent consumers to process concurrently; otherwise, the consumers will wait to the previous message has been processed before executing.</p>
<h5 id="islandora-indexing-triplestore">islandora-indexing-triplestore<a class="headerlink" href="#islandora-indexing-triplestore" title="Permanent link">&para;</a></h5>
<h4 id="islandora-indexing-triplestore">islandora-indexing-triplestore<a class="headerlink" href="#islandora-indexing-triplestore" title="Permanent link">&para;</a></h4>
<p>This service indexes the Drupal node into the configured triplestore</p>
<p>It's properties are:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a># Triplestore indexer options
Expand All @@ -2741,7 +2717,7 @@ <h5 id="islandora-indexing-triplestore">islandora-indexing-triplestore<a class="
<div class="language-text highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>triplestore.indexer.async-consumer=true
</span></code></pre></div>
<p>This property allows the concurrent consumers to process concurrently; otherwise, the consumers will wait to the previous message has been processed before executing.</p>
<h3 id="islandora-connector-derivative">islandora-connector-derivative<a class="headerlink" href="#islandora-connector-derivative" title="Permanent link">&para;</a></h3>
<h4 id="islandora-connector-derivative">islandora-connector-derivative<a class="headerlink" href="#islandora-connector-derivative" title="Permanent link">&para;</a></h4>
<p>This service is used to configure an external microservice. This service will deploy multiple copies of its routes
with different configured inputs and outputs based on properties.</p>
<p>The routes to be configured are defined with the property <code>derivative.systems.installed</code> which expects
Expand Down Expand Up @@ -2782,7 +2758,7 @@ <h3 id="islandora-connector-derivative">islandora-connector-derivative<a class="
</span><span id="__span-23-14"><a id="__codelineno-23-14" name="__codelineno-23-14" href="#__codelineno-23-14"></a>derivative.fits.max-concurrent-consumers=2
</span><span id="__span-23-15"><a id="__codelineno-23-15" name="__codelineno-23-15" href="#__codelineno-23-15"></a>derivative.fits.async-consumer=false
</span></code></pre></div>
<h5 id="customizing-http-client-timeouts">Customizing HTTP client timeouts<a class="headerlink" href="#customizing-http-client-timeouts" title="Permanent link">&para;</a></h5>
<h4 id="customizing-http-client-timeouts">Customizing HTTP client timeouts<a class="headerlink" href="#customizing-http-client-timeouts" title="Permanent link">&para;</a></h4>
<p>You can alter the HTTP client from the defaults for its request, connection and socket timeouts.
To do this you want to enable the request configurer.</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>request.configurer.enabled<span class="o">=</span><span class="nb">true</span>
Expand All @@ -2793,7 +2769,7 @@ <h5 id="customizing-http-client-timeouts">Customizing HTTP client timeouts<a cla
</span><span id="__span-25-3"><a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>socket.timeout<span class="o">=</span>-1
</span></code></pre></div>
<p>The default for all three is <code>-1</code> which indicates no timeout.</p>
<h5 id="alter-http-options">Alter HTTP options<a class="headerlink" href="#alter-http-options" title="Permanent link">&para;</a></h5>
<h4 id="alter-http-options">Alter HTTP options<a class="headerlink" href="#alter-http-options" title="Permanent link">&para;</a></h4>
<p>By default, Alpaca uses two settings for the HTTP component, these are
* disableStreamCache=true
* connectionClose=true</p>
Expand All @@ -2804,7 +2780,7 @@ <h5 id="alter-http-options">Alter HTTP options<a class="headerlink" href="#alter
</span></code></pre></div></p>
<p>These will be added to ALL http endpoint requests.</p>
<p><strong>Note</strong>: We are currently running Camel 3.7.6, some configuration parameters on the above linked page might not be supported.</p>
<h4 id="deployingrunning">Deploying/Running<a class="headerlink" href="#deployingrunning" title="Permanent link">&para;</a></h4>
<h3 id="deployingrunning">Deploying/Running<a class="headerlink" href="#deployingrunning" title="Permanent link">&para;</a></h3>
<p>You can see the options by passing the <code>-h|--help</code> flag</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-27-1"><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>&gt;<span class="w"> </span>java<span class="w"> </span>-jar<span class="w"> </span>islandora-alpaca-app/build/libs/islandora-alpaca-app-2.0.0-all.jar<span class="w"> </span>-h
</span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a>Usage:<span class="w"> </span>alpaca<span class="w"> </span><span class="o">[</span>-hV<span class="o">]</span><span class="w"> </span><span class="o">[</span>-c<span class="o">=</span>&lt;configurationFilePath&gt;<span class="o">]</span>
Expand Down
Binary file modified pr-preview/pr-2303/sitemap.xml.gz
Binary file not shown.

0 comments on commit 7886b28

Please sign in to comment.