summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2017-03-09 13:23:06 +0200
committerLars Wirzenius <liw@liw.fi>2017-03-09 13:23:06 +0200
commitf0b83e3125066c660b0f835f94576c072129adca (patch)
treee89804109427a6c330e79e956347e6f9154373bf
parent1c1f35a12890dceb847d515b53f5aa9412f165b2 (diff)
downloadvmdb2-f0b83e3125066c660b0f835f94576c072129adca.tar.gz
Add note about teardowns
-rw-r--r--yarns/100-mvp.yarn7
1 files changed, 7 insertions, 0 deletions
diff --git a/yarns/100-mvp.yarn b/yarns/100-mvp.yarn
index afaf6e9..d2e2399 100644
--- a/yarns/100-mvp.yarn
+++ b/yarns/100-mvp.yarn
@@ -76,6 +76,13 @@ raw disk image file, as opposed to some other format. The image is 4
gigabytes in size. `mkfs` creates an ext4 filesystem in the image
file; in thie example there are no partitions. And so on.
+Steps may need to clean up after themselves. For example, a step that
+mounts a filesystem will need to unmount it at the end of the image
+creation. Also, if a later step fails, then the unmount needs to
+happen as well. This is called a "teardown". Some steps are provided
+by a plugin that handles the teardown automatically, others may need
+to provide instructions for the teardown in the specification file.
+
By providing well-defined steps that the user may combine as they
wish, vmdb2 gives great flexibility without much complexity, but at
the cost of forcing the user to write a longer specification file than