Merge pull request #1185 from mulkieran/issue-stratisd-3796

Supporting starting a pool without its cache

Author: mulkieran

docs/stratis.txt

@@ -43,7 +43,7 @@ pool create [--key-desc <key_desc>] [--clevis <(nbde|tang|tpm2)> [--tang-url <ta
 pool stop <(--uuid <uuid> |--name <name>)>::
      Stop a pool, specifying the pool by its UUID or by its name. Tear down
      the storage stack but leave all metadata intact.
-pool start [--keyfile-path KEYFILE_PATH | --capture-key] --unlock-method <(any | clevis | keyring)> <(--uuid <uuid> |--name <name>)>::
+pool start [--remove-cache] [--keyfile-path KEYFILE_PATH | --capture-key] --unlock-method <(any | clevis | keyring)> <(--uuid <uuid> |--name <name>)>::
      Start a pool, specifying the pool by its UUID or by its name. Use the
      --unlock-method option to specify a method of unlocking the pool if it
      is encrypted. If an unlock method of any is specified the pool will be
@@ -54,7 +54,9 @@ pool start [--keyfile-path KEYFILE_PATH | --capture-key] --unlock-method <(any |
      option is required if --keyfile-path or --capture-key is used. If the
      value is any, the specified passphrase will be tried for all keyslots;
      otherwise the specified passphrase will be tried only for the keyslot
-     corresponding to the specified method.
+     corresponding to the specified method. If --remove-cache is specified,
+     the pool's cache, if there is one, will not be set up and the Stratis
+     metadata on each of the pool's cache devices, if any, will be removed.
 pool list [--stopped] [(--uuid <uuid> |--name <name>)]::
      List pools. If the --stopped option is used, list only stopped pools.
      Otherwise, list only started pools. If a UUID or name is specified, print

src/stratis_cli/_actions/_introspect.py

@@ -52,6 +52,7 @@
       <arg name="id_type" type="s" direction="in" />
       <arg name="unlock_method" type="(b(bu))" direction="in" />
       <arg name="key_fd" type="(bh)" direction="in" />
+      <arg name="remove_cache" type="b" direction="in" />
       <arg name="result" type="(b(oaoao))" direction="out" />
       <arg name="return_code" type="q" direction="out" />
       <arg name="return_string" type="s" direction="out" />

src/stratis_cli/_actions/_pool.py

@@ -342,6 +342,7 @@ def start_pool(namespace):
             | {
                 "unlock_method": unlock_method,
                 "key_fd": key_fd_arg,
+                "remove_cache": namespace.remove_cache,
             },
         )
 

src/stratis_cli/_parser/_pool.py

@@ -262,6 +262,15 @@ def verify(self, namespace, parser):
         "start",
         {
             "help": "Start a pool.",
+            "args": [
+                (
+                    "--remove-cache",
+                    {
+                        "action": "store_true",
+                        "help": "While starting the pool, remove its cache",
+                    },
+                )
+            ],
             "groups": [
                 (
                     "Pool Identifier",