Skip to content

Commit

Permalink
release: 0.7.0 download links and release note
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Buchanan committed May 11, 2018
1 parent e243148 commit b5909a0
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 30 deletions.
18 changes: 5 additions & 13 deletions docs/docs/compute/deployment/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -330,19 +330,16 @@ <h3 id="usage">Usage</h3>

Scheduler:
# How often to run a scheduler iteration.
# In nanoseconds.
ScheduleRate: 1000000000 # 1 second
ScheduleRate: 1s

# How many tasks to schedule in one iteration.
ScheduleChunk: 10

# How long to wait between updates before marking a node dead.
# In nanoseconds.
NodePingTimeout: 60000000000 # 1 minute
NodePingTimeout: 1m

# How long to wait for a node to start, before marking the node dead.
# In nanoseconds.
NodeInitTimeout: 300000000000 # 5 minutes
NodeInitTimeout: 5m


Node:
Expand All @@ -351,7 +348,7 @@ <h3 id="usage">Usage</h3>

# If the node has been idle for longer than the timeout, it will shut down.
# -1 means there is no timeout. 0 means timeout immediately after the first task.
Timeout: -1
Timeout: -1s

# A Node will automatically try to detect what resources are available to it.
# Defining Resources in the Node configuration overrides this behavior.
Expand All @@ -365,8 +362,7 @@ <h3 id="usage">Usage</h3>

# For low-level tuning.
# How often to sync with the Funnel server.
# In nanoseconds.
UpdateRate: 5000000000 # 5 seconds
UpdateRate: 5s

Logger:
# Logging levels: debug, info, error
Expand All @@ -375,10 +371,6 @@ <h3 id="usage">Usage</h3>
OutputFile: &quot;&quot;
</code></pre>

<h3 id="known-issues">Known issues</h3>

<p>The config uses nanoseconds for duration values. See <a href="https://github.com/ohsu-comp-bio/funnel/issues/342">issue #342</a>.</p>

</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Compute: htcondor HTCondor: |universe = vanilla getenv = True executable = {{.Ex
<guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/http/</guid>
<description>HTTP(S) Funnel supports downloading files from public URLs via GET reqests. No authentication mechanism is allowed. This backend can be used to fetch objects from cloud storage providers exposed using presigned URLs.
The HTTP storage client is enabled by default, but may be explicitly disabled in the worker config:
HTTPStorage: Disabled: false # Timeout for http(s) GET requests. # In nanoseconds. Timeout: 60000000000 # 60 seconds 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;http://fakedomain.</description>
HTTPStorage: Disabled: false # Timeout for http(s) GET requests. Timeout: 30s 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;http://fakedomain.</description>
</item>

<item>
Expand Down Expand Up @@ -218,7 +218,7 @@ Database: mongodb MongoDB: # Addresses for the seed servers. Addrs: - &amp;quot;
<guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/</guid>
<description>OpenStack Swift Funnel supports using OpenStack Swift for file storage.
The Swift storage client is enabled by default, and will try to automatically load credentials from the environment. Alternatively, you may explicitly set the credentials in the worker config:
Swift: Disabled: false UserName: &amp;quot;&amp;quot; Password: &amp;quot;&amp;quot; AuthURL: &amp;quot;&amp;quot; TenantName: &amp;quot;&amp;quot; TenantID: &amp;quot;&amp;quot; RegionName: &amp;quot;&amp;quot; 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;swift://funnel-bucket/hello.txt&amp;quot;, &amp;quot;path&amp;quot;: &amp;quot;/inputs/hello.txt&amp;quot; }], &amp;quot;outputs&amp;quot;: [{ &amp;quot;url&amp;quot;: &amp;quot;swift://funnel-bucket/output.</description>
Swift: Disabled: false UserName: &amp;quot;&amp;quot; Password: &amp;quot;&amp;quot; AuthURL: &amp;quot;&amp;quot; TenantName: &amp;quot;&amp;quot; TenantID: &amp;quot;&amp;quot; RegionName: &amp;quot;&amp;quot; # 500 MB ChunkSizeBytes: 500000000 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;swift://funnel-bucket/hello.</description>
</item>

<item>
Expand Down
3 changes: 1 addition & 2 deletions docs/docs/storage/http/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -311,8 +311,7 @@ <h1 id="http-s">HTTP(S)</h1>
<pre><code>HTTPStorage:
Disabled: false
# Timeout for http(s) GET requests.
# In nanoseconds.
Timeout: 60000000000 # 60 seconds
Timeout: 30s
</code></pre>

<h3 id="example-task">Example task</h3>
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/storage/swift/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ <h1 id="openstack-swift">OpenStack Swift</h1>
TenantName: &quot;&quot;
TenantID: &quot;&quot;
RegionName: &quot;&quot;
# 500 MB
ChunkSizeBytes: 500000000
</code></pre>

<h3 id="example-task">Example task</h3>
Expand Down
6 changes: 3 additions & 3 deletions docs/download/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,8 @@
<h3 id="download">Download</h3>

<ul>
<li><a href="https://github.com/ohsu-comp-bio/funnel/releases/download/0.6.0/funnel-linux-amd64-0.6.0.tar.gz">linux <small>[funnel-linux-amd64-0.6.0.tar.gz]</small></a></li>
<li><a href="https://github.com/ohsu-comp-bio/funnel/releases/download/0.6.0/funnel-darwin-amd64-0.6.0.tar.gz">mac <small>[funnel-darwin-amd64-0.6.0.tar.gz]</small></a></li>
<li><a href="https://github.com/ohsu-comp-bio/funnel/releases/download/0.7.0/funnel-linux-amd64-0.7.0.tar.gz">linux <small>[funnel-linux-amd64-0.7.0.tar.gz]</small></a></li>
<li><a href="https://github.com/ohsu-comp-bio/funnel/releases/download/0.7.0/funnel-darwin-amd64-0.7.0.tar.gz">mac <small>[funnel-darwin-amd64-0.7.0.tar.gz]</small></a></li>
<li><small>Windows is not supported (yet), sorry!</small></li>
</ul>

Expand All @@ -324,7 +324,7 @@ <h3>Build the lastest development version <i class="optional">optional</i></h3>
<pre><code class="language-shell">$ go get github.com/ohsu-comp-bio/funnel
</code></pre>

<p>Funnel requires Go 1.8+. Check out the <a href="https://ohsu-comp-bio.github.io/funnel/docs/development/developers/">development docs</a> for more detail.</p>
<p>Funnel requires Go 1.10+. Check out the <a href="https://ohsu-comp-bio.github.io/funnel/docs/development/developers/">development docs</a> for more detail.</p>

<h3 id="release-history">Release History</h3>

Expand Down
8 changes: 4 additions & 4 deletions docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@ A node is a service which runs on each machine in a cluster. The node connects t
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

<guid>https://ohsu-comp-bio.github.io/funnel/download/</guid>
<description>Download linux [funnel-linux-amd64-0.6.0.tar.gz] mac [funnel-darwin-amd64-0.6.0.tar.gz] Windows is not supported (yet), sorry! Funnel is a single binary.
<description>Download linux [funnel-linux-amd64-0.7.0.tar.gz] mac [funnel-darwin-amd64-0.7.0.tar.gz] Windows is not supported (yet), sorry! Funnel is a single binary.
Funnel requires Docker.
Funnel is beta quality. APIs might break, bugs exist, data might be lost.
Homebrew brew tap ohsu-comp-bio/formula brew install funnel Build the lastest development version optional In order to build the latest code, run:
$ go get github.com/ohsu-comp-bio/funnel Funnel requires Go 1.8+. Check out the development docs for more detail.</description>
$ go get github.com/ohsu-comp-bio/funnel Funnel requires Go 1.10+. Check out the development docs for more detail.</description>
</item>

<item>
Expand Down Expand Up @@ -186,7 +186,7 @@ Compute: htcondor HTCondor: |universe = vanilla getenv = True executable = {{.Ex
<guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/http/</guid>
<description>HTTP(S) Funnel supports downloading files from public URLs via GET reqests. No authentication mechanism is allowed. This backend can be used to fetch objects from cloud storage providers exposed using presigned URLs.
The HTTP storage client is enabled by default, but may be explicitly disabled in the worker config:
HTTPStorage: Disabled: false # Timeout for http(s) GET requests. # In nanoseconds. Timeout: 60000000000 # 60 seconds 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;http://fakedomain.</description>
HTTPStorage: Disabled: false # Timeout for http(s) GET requests. Timeout: 30s 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;http://fakedomain.</description>
</item>

<item>
Expand Down Expand Up @@ -231,7 +231,7 @@ Database: mongodb MongoDB: # Addresses for the seed servers. Addrs: - &amp;quot;
<guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/</guid>
<description>OpenStack Swift Funnel supports using OpenStack Swift for file storage.
The Swift storage client is enabled by default, and will try to automatically load credentials from the environment. Alternatively, you may explicitly set the credentials in the worker config:
Swift: Disabled: false UserName: &amp;quot;&amp;quot; Password: &amp;quot;&amp;quot; AuthURL: &amp;quot;&amp;quot; TenantName: &amp;quot;&amp;quot; TenantID: &amp;quot;&amp;quot; RegionName: &amp;quot;&amp;quot; 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;swift://funnel-bucket/hello.txt&amp;quot;, &amp;quot;path&amp;quot;: &amp;quot;/inputs/hello.txt&amp;quot; }], &amp;quot;outputs&amp;quot;: [{ &amp;quot;url&amp;quot;: &amp;quot;swift://funnel-bucket/output.</description>
Swift: Disabled: false UserName: &amp;quot;&amp;quot; Password: &amp;quot;&amp;quot; AuthURL: &amp;quot;&amp;quot; TenantName: &amp;quot;&amp;quot; TenantID: &amp;quot;&amp;quot; RegionName: &amp;quot;&amp;quot; # 500 MB ChunkSizeBytes: 500000000 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;swift://funnel-bucket/hello.</description>
</item>

<item>
Expand Down
2 changes: 1 addition & 1 deletion util/github-release-notes/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func main() {
}

// Stop at this PR number
stopAt := 428
stopAt := 521
includeCommits := false //true

// Iterate over all PRs
Expand Down
10 changes: 5 additions & 5 deletions website/content/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ menu:

### Download

- [linux <small>[funnel-linux-amd64-0.6.0.tar.gz]</small>][linux-64-bin]
- [mac <small>[funnel-darwin-amd64-0.6.0.tar.gz]</small>][mac-64-bin]
- [linux <small>[funnel-linux-amd64-0.7.0.tar.gz]</small>][linux-64-bin]
- [mac <small>[funnel-darwin-amd64-0.7.0.tar.gz]</small>][mac-64-bin]
- <small>Windows is not supported (yet), sorry!</small>

[linux-64-bin]: https://github.com/ohsu-comp-bio/funnel/releases/download/0.6.0/funnel-linux-amd64-0.6.0.tar.gz
[mac-64-bin]: https://github.com/ohsu-comp-bio/funnel/releases/download/0.6.0/funnel-darwin-amd64-0.6.0.tar.gz
[linux-64-bin]: https://github.com/ohsu-comp-bio/funnel/releases/download/0.7.0/funnel-linux-amd64-0.7.0.tar.gz
[mac-64-bin]: https://github.com/ohsu-comp-bio/funnel/releases/download/0.7.0/funnel-darwin-amd64-0.7.0.tar.gz

Funnel is a single binary.
Funnel requires [Docker][docker].
Expand All @@ -32,7 +32,7 @@ In order to build the latest code, run:
$ go get github.com/ohsu-comp-bio/funnel
```

Funnel requires Go 1.8+. Check out the [development docs][dev] for more detail.
Funnel requires Go 1.10+. Check out the [development docs][dev] for more detail.

### Release History

Expand Down

0 comments on commit b5909a0

Please sign in to comment.