Skip to content

Commit 2e2c6ff

Browse files
committed
man: Add entries for encryption on, off, and re-encrypt
Signed-off-by: mulhern <amulhern@redhat.com>
1 parent 0665881 commit 2e2c6ff

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/stratis.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,18 @@ pool unbind <(clevis|keyring)> <pool name> [--token-slot <token slot>]::
117117
mechanism. MOVE NOTICE: The "unbind" subcommand can also be found under
118118
the "pool encryption" subcommand. The "pool unbind" subcommand that you
119119
are using now is deprecated and will be removed in stratis 3.10.0.
120+
pool encryption on --in-place <(--uuid <uuid> |--name <name>)> [--key-desc <key_desc>] [--clevis <(nbde|tang|tpm2)> [--tang-url <tang_url>] [<(--thumbprint <thp> | --trust-url)>]::
121+
Turn encryption on for the specified pool. This operation must encrypt
122+
every block in the pool and takes time proportional to the size of the
123+
pool.
124+
pool encryption off --in-place <(--uuid <uuid> |--name <name>)>::
125+
Turn encryption off for the specified pool. This operation must write
126+
the plain text of every block in the pool and takes time proportional to
127+
the size of the pool.
128+
pool encryption reencrypt --in-place <(--uuid <uuid> |--name <name>)>::
129+
Reencrypt the pool with a new master key. This operation must overwrite
130+
every block in the pool with re-encrypted data and takes time
131+
proportional to the size of the pool.
120132
pool encryption bind <(nbde|tang)> <(--uuid <uuid> |--name <name>)> <(--thumbprint <thp> | --trust-url)> <url>::
121133
Bind the devices in the specified pool to a supplementary encryption
122134
mechanism that uses NBDE (Network-Bound Disc Encryption). *tang* is
@@ -262,6 +274,20 @@ OPTIONS
262274
--token-slot <token slot> ::
263275
For V2 pools only. Use the token slot number to select among
264276
different bindings that use the same encryption method.
277+
--in-place ::
278+
This is a mandatory option that must be set when requesting
279+
a long-running in-place encryption operation. These operations are
280+
a kind that must read and write every block in the pool. Hence these
281+
operations take a time that is linear in the size of the pool.
282+
Additionally, these operations are run in place, that is, the
283+
pool's data blocks are directly modified while it is in use. While
284+
the operation is taking place, automatic administrative actions,
285+
for example, extending filesystems, can not be taken on the pool.
286+
Furthermore, user-initiated actions, such as adding a new device to
287+
a pool are also disabled. The pool administrator should therefore
288+
ensure that no administrative operations will become urgently
289+
necessary while the encryption operation is running. Consider
290+
backing up your data before initiating this operation.
265291

266292

267293
SIZE SPECIFICATION FORMAT FOR INPUT

0 commit comments

Comments
 (0)