summaryrefslogtreecommitdiff
path: root/vmdb/plugins/cryptsetup.mdwn
blob: 1f374d129b3db162ed6301b5204741c9038623d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Step: cryptsetup
-----------------------------------------------------------------------------

Set up disk encryption using LUKS with the `cryptsetup` utility. The
encryption passphrase is read from a file or from the output of a
command. The encrypted disk gets opened and can be mounted using a
separate tag for the cleartext view.

Step keys:

* `cryptsetup` — REQUIRED; the tag for the encrypted block
  device. This is not directly useable by users, or mountable.

* `name` — REQUIRED; the tag for the de-crypted block device.
  This is what gets mounted and visible to users.

* `password` — OPTIONAL; the encryption password

* `key-file` — OPTIONAL; file from where passphrase is read.

* `key-cmd` — OPTIONAL; command to run, passphrase is the first
  line of its standard output.

One of `password`, `key-file`, or `key-cmd` is REQUIRED.

Example (in the .vmdb file):

    - cryptsetup: cleartext_pv0
      password: hunter2
      name: pv0