summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFirehose merge bot <firehose@merge.bot>2014-08-07 15:24:49 +0100
committerFirehose merge bot <firehose@merge.bot>2014-08-07 15:24:49 +0100
commit5399e2174f61f0be084c32cae49e17d8c3e200b4 (patch)
treeb662f7c1df2ee57a26201d0d4932169f8e7f3780
parentf61456bca55644b432568f4a57bb01c58243d2de (diff)
downloadfirehose-5399e2174f61f0be084c32cae49e17d8c3e200b4.tar.gz
More readme notes
-rw-r--r--README13
1 files changed, 12 insertions, 1 deletions
diff --git a/README b/README
index 1b89f16..d22719b 100644
--- a/README
+++ b/README
@@ -1,7 +1,18 @@
Firehose
========
-*TODO*: Explain Firehose
+Firehose is a tool which reads yaml files (see the `examples/` directory) which
+instruct the tool in how to perform integrations of upstream changes into a
+Baserock definitions set. It is meant to be used in conjunction with the
+Baserock CD pipeline (Mason) to reduce the cognitive load on the systems
+integration role, freeing brain cycles for more constructive development work.
+
+Currently Firehose is limited to applying all of its inputs in a single
+integration and it only supports the absolute-sha landing method (which assumes
+a zero delta between upstream and what we need for Baserock) but for anything
+where that holds true, Firehose can provide a valuable service pre-integrating
+and running those integrations through a CD pipeline to gain confidence in the
+proposed change.
Debian Version Comparison