Author: buildbot Date: Thu Aug 17 15:51:19 2017 New Revision: 1016939 Log: Staging update by buildbot for sling
Modified: websites/staging/sling/trunk/content/ (props changed) websites/staging/sling/trunk/content/documentation/bundles/content-distribution.html Propchange: websites/staging/sling/trunk/content/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Thu Aug 17 15:51:19 2017 @@ -1 +1 @@ -1805273 +1805305 Modified: websites/staging/sling/trunk/content/documentation/bundles/content-distribution.html ============================================================================== --- websites/staging/sling/trunk/content/documentation/bundles/content-distribution.html (original) +++ websites/staging/sling/trunk/content/documentation/bundles/content-distribution.html Thu Aug 17 15:51:19 2017 @@ -122,11 +122,13 @@ h2:hover > .headerlink, h3:hover > .head <li><a href="#forward-distribution">Forward distribution</a><ul> <li><a href="#setup-overview">Setup overview</a></li> <li><a href="#sample-configuration">Sample configuration</a></li> +<li><a href="#trigger-forward-distribution">Trigger forward distribution</a></li> </ul> </li> <li><a href="#reverse-distribution">Reverse distribution</a><ul> <li><a href="#setup-overview_1">Setup overview</a></li> <li><a href="#sample-configuration_1">Sample configuration</a></li> +<li><a href="#trigger-reverse-distribution">Trigger reverse distribution</a></li> </ul> </li> <li><a href="#sync-distribution">Sync distribution</a><ul> @@ -142,10 +144,9 @@ h2:hover > .headerlink, h3:hover > .head </ul> </li> <li><a href="#additional-options">Additional options</a><ul> -<li><a href="#how-to-trigger-distribution-over-http">How to trigger distribution over HTTP?</a></li> <li><a href="#how-to-configure-binary-less-distribution">How to configure binary-less distribution?</a></li> -<li><a href="#how-to-configure-priority-paths">How to configure priority paths?</a></li> -<li><a href="#how-to-configure-error-queues">How to configure error queues?</a></li> +<li><a href="#how-to-configure-priority-queue">How to configure priority queue?</a></li> +<li><a href="#how-to-configure-retry-strategy">How to configure retry strategy?</a></li> </ul> </li> </ul> @@ -187,6 +188,13 @@ h2:hover > .headerlink, h3:hover > .head </li> </ul> +<h4 id="trigger-forward-distribution">Trigger forward distribution<a class="headerlink" href="#trigger-forward-distribution" title="Permanent link">¶</a></h4> +<p>Forward distribution can be triggered by sending a <code>POST</code> HTTP request to the agent resource on the source instance with the parameter <code>action=ADD</code> and parameters <code>path=<resourcePath></code>.</p> +<p>The example below distributes the path <code>/content/sample1</code></p> +<div class="codehilite"><pre>$ <span class="n">curl</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">u</span> <span class="n">admin</span><span class="p">:</span><span class="n">admin</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span>8080<span class="o">/</span><span class="n">libs</span><span class="o">/</span><span class="n">sling</span><span class="o">/</span><span class="n">distribution</span><span class="o">/</span><span class="n">services</span><span class="o">/</span><span class="n">agents</span><span class="o">/</span><span class="n">publish</span> <span class="o">-</span><span class="n">d</span> <span class="s">'action=ADD'</span> <span class="o">-</span><span class="n">d</span> <span class="s">'path=/content/sample1'</span> +</pre></div> + + <h3 id="reverse-distribution">Reverse distribution<a class="headerlink" href="#reverse-distribution" title="Permanent link">¶</a></h3> <p>A reverse distribution setup allows one to transfer content from a farm of source instances to a target instance. That is done by pulling the content from source instances into the target instance.</p> <h4 id="setup-overview_1">Setup overview<a class="headerlink" href="#setup-overview_1" title="Permanent link">¶</a></h4> @@ -225,6 +233,13 @@ h2:hover > .headerlink, h3:hover > .head </li> </ul> +<h4 id="trigger-reverse-distribution">Trigger reverse distribution<a class="headerlink" href="#trigger-reverse-distribution" title="Permanent link">¶</a></h4> +<p>Reverse distribution can be triggered by sending a <code>POST</code> HTTP request to the agent resource on the target instance with the parameter <code>action=PULL</code>.</p> +<p>The example below adds the the path <code>/content/sample1</code> and then reverse distribute it.</p> +<div class="codehilite"><pre>$ <span class="n">curl</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">u</span> <span class="n">admin</span><span class="p">:</span><span class="n">admin</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span>8081<span class="o">/</span><span class="n">libs</span><span class="o">/</span><span class="n">sling</span><span class="o">/</span><span class="n">distribution</span><span class="o">/</span><span class="n">services</span><span class="o">/</span><span class="n">agents</span><span class="o">/</span><span class="n">publish</span> <span class="o">-</span><span class="n">d</span> <span class="s">'action=PULL'</span> <span class="o">-</span><span class="n">d</span> <span class="s">'path=/content/sample1'</span> +</pre></div> + + <h3 id="sync-distribution">Sync distribution<a class="headerlink" href="#sync-distribution" title="Permanent link">¶</a></h3> <p>A sync distribution setup allows one to synchronize content in a farm of instances. That is done by using a coordinator instance (typically an author instance) that pulls content from all instances in a farm and pushes it back to all.</p> <h4 id="setup-overview_2">Setup overview:<a class="headerlink" href="#setup-overview_2" title="Permanent link">¶</a></h4> @@ -331,12 +346,34 @@ h2:hover > .headerlink, h3:hover > .head </li> </ul> <h2 id="additional-options">Additional options<a class="headerlink" href="#additional-options" title="Permanent link">¶</a></h2> -<h3 id="how-to-trigger-distribution-over-http">How to trigger distribution over HTTP?<a class="headerlink" href="#how-to-trigger-distribution-over-http" title="Permanent link">¶</a></h3> <h3 id="how-to-configure-binary-less-distribution">How to configure binary-less distribution?<a class="headerlink" href="#how-to-configure-binary-less-distribution" title="Permanent link">¶</a></h3> -<h3 id="how-to-configure-priority-paths">How to configure priority paths?<a class="headerlink" href="#how-to-configure-priority-paths" title="Permanent link">¶</a></h3> -<h3 id="how-to-configure-error-queues">How to configure error queues?<a class="headerlink" href="#how-to-configure-error-queues" title="Permanent link">¶</a></h3> +<p>Binary-less distribution is supported for deployments over a shared data store and involving agents that leverage the +Vault based Distribution package exporter (Factory PID: +org.apache.sling.distribution.serialization.impl.vlt.VaultDistributionPackageBuilderFactory) package builder.</p> +<p>With binary-less mode enabled, the content packages distributed contain references to binaries rather than +the actual binaries.</p> +<p>SCD does not explicitly deal with binary references. Instead, it configures Apache Jackrabbit FileVault +export options in order to assemble/import binary references.</p> +<p>Upon import, if a referenced binary is not visible on the destination instance, SCD will retry distributing the content package +after a delay has elapsed.</p> +<p>Binary-less is configured by setting the 'useReferences' to true on the VaultDistributionPackageBuilderFactory.</p> +<h3 id="how-to-configure-priority-queue">How to configure priority queue?<a class="headerlink" href="#how-to-configure-priority-queue" title="Permanent link">¶</a></h3> +<p>SCD agents allow to prioritize the distribution of content depending on its path. +This feature improves the delays in use cases where a subset of the content to be distributed must meet tighter delay +than the remaining one (e.g. news flash).</p> +<p>Each agent can be configured with one or more priority queues.</p> +<p>In order to setup the priority queues, configure the 'priorityQueues' agent property by providing the queuePrefix and path regular expression.</p> +<h3 id="how-to-configure-retry-strategy">How to configure retry strategy?<a class="headerlink" href="#how-to-configure-retry-strategy" title="Permanent link">¶</a></h3> +<p>The agent behaviour upon failed distribution request can be configured via the Retry Strategy 'retry.strategy' and +'retry.attempts' properties.</p> +<p>With the 'none' strategy, an agent will retry distributing an item forever, blocking the queue until the distribution succeeds. +The 'none' strategy guarantees the distribution order but may block the queue until someone resolves the situation.</p> +<p>With the 'errorQueue' strategy, an agent will automatically create an additional error queue. The agent will +retry up to 'retry.attempts' attempts then move the failed item to the error queue. The error queue is passive and allow +to keep track of the failed distribution item for post analysis. +The 'errorQueue' strategy does not guarantee the distribution order, but it guarantee that the queue is stuck for a bounded number of retries.</p> <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;"> - Rev. 1731078 by mpetria on Thu, 18 Feb 2016 14:25:18 +0000 + Rev. 1805305 by tmaret on Thu, 17 Aug 2017 15:50:56 +0000 </div> <div class="trademarkFooter"> Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project