update docs

ohsu-comp-bio · Jan 29, 2019 · a1d836c · a1d836c
1 parent a630947
commit a1d836c
Show file tree

Hide file tree

Showing 35 changed files with 663 additions and 5 deletions.
diff --git a/docs/docs/compute/aws-batch/index.html b/docs/docs/compute/aws-batch/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/deployment/index.html b/docs/docs/compute/deployment/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/grid-engine/index.html b/docs/docs/compute/grid-engine/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/htcondor/index.html b/docs/docs/compute/htcondor/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/index.html b/docs/docs/compute/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/pbs-torque/index.html b/docs/docs/compute/pbs-torque/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/compute/slurm/index.html b/docs/docs/compute/slurm/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/boltdb/index.html b/docs/docs/databases/boltdb/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/datastore/index.html b/docs/docs/databases/datastore/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/dynamodb/index.html b/docs/docs/databases/dynamodb/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/elasticsearch/index.html b/docs/docs/databases/elasticsearch/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/index.html b/docs/docs/databases/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/databases/mongodb/index.html b/docs/docs/databases/mongodb/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/development/developers/index.html b/docs/docs/development/developers/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/development/index.html b/docs/docs/development/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/events/index.html b/docs/docs/events/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/events/kafka/index.html b/docs/docs/events/kafka/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/index.html b/docs/docs/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/index.xml b/docs/docs/index.xml
@@ -121,6 +121,18 @@ Database: boltdb BoltDB: # Path to database file Path: ./funnel-work-dir/funnel.
       <description> Events </description>
     </item>
 
+    <item>
+      <title>FTP</title>
+      <link>https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+
+      <guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/</guid>
+      <description>FTP Funnel supports download and uploading files via FTP.
+Currently authentication credentials are take from the URL, e.g. ftp://username:password@ftp.host.tld. This will be improved soon to allow credentials to be added to the configuration file.
+The FTP storage client is enabled by default, but may be explicitly disabled in the worker config:
+FTPStorage: Disabled: false  Example task { &amp;quot;name&amp;quot;: &amp;quot;Hello world&amp;quot;, &amp;quot;inputs&amp;quot;: [{ &amp;quot;url&amp;quot;: &amp;quot;ftp://my.ftpserver.xyz/hello.txt&amp;quot;, &amp;quot;path&amp;quot;: &amp;quot;/inputs/hello.txt&amp;quot; }, { &amp;quot;url&amp;quot;: &amp;quot;ftp://user:mypassword123@my.</description>
+    </item>
+
     <item>
       <title>Funnel Developers</title>
       <link>https://ohsu-comp-bio.github.io/funnel/docs/development/developers/</link>

diff --git a/docs/docs/metrics/index.html b/docs/docs/metrics/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/metrics/prometheus/index.html b/docs/docs/metrics/prometheus/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/security/basic/index.html b/docs/docs/security/basic/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>

diff --git a/docs/docs/security/index.html b/docs/docs/security/index.html
@@ -88,6 +88,15 @@
             </ul>
           </li>
 
+          <li>
+            <ul class="sidebar-nav sidebar-nav-nested">
+              <li>
+                <a href="https://ohsu-comp-bio.github.io/funnel/docs/storage/ftp/"
+                   class="sidebar-nav-item "
+                >FTP</a></li>
+            </ul>
+          </li>
+
           <li>
             <ul class="sidebar-nav sidebar-nav-nested">
               <li>