summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrtkapiper <andy.piper@arcticwolf.com>2023-07-14 14:37:03 +0000
committerLars Wirzenius <liw@liw.fi>2023-07-14 15:00:46 +0000
commit072472c4107ee3c6e81962038c0d77da16d0d931 (patch)
tree23b8b4c551c5103d824f5454ba03ffdbad8ac267
parent85fa0750c5b6720d45c8d34d95c91894ac7bf2cc (diff)
downloadvmdb2-072472c4107ee3c6e81962038c0d77da16d0d931.tar.gz
Add use-case to plugin documentation
-rw-r--r--vmdb/plugins/kpartx.mdwn11
1 files changed, 9 insertions, 2 deletions
diff --git a/vmdb/plugins/kpartx.mdwn b/vmdb/plugins/kpartx.mdwn
index 0074f38..65724df 100644
--- a/vmdb/plugins/kpartx.mdwn
+++ b/vmdb/plugins/kpartx.mdwn
@@ -8,8 +8,15 @@ Step keys:
* `kpartx` &mdash; REQUIRED; filename of block device with partitions.
-* `tags` &mdash; OPTIONAL; list of tags to apply to partitions when re-using
- an existing image that has already been populated with formatted partitions
+* `tags` &mdash; OPTIONAL; list of tags to apply to partitions when re-using an existing
+ image that has already been populated with formatted partitions. This can be useful in
+ scenarios where an appliance disk image is being built: There needs to be a "debug"
+ version of the appliance that provides direct SSH access, the use of `sudo`, etc., and
+ also a "production" version that does not. Otherwise the disk images need to be
+ identical to aid in diagnosing issues found in production environments. The production
+ and debug images can be produced by first creating the "release" version using
+ `vmdb2`, and then passing the production disk image to a second `vmdb` where developer
+ access is configured.
Example (in the .vmdb file):