github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/volume/delete.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume delete'
     4  description: |
     5    Delete volumes with CSI plugins.
     6  ---
     7  
     8  # Command: volume delete
     9  
    10  The `volume delete` command deletes external storage volumes with Nomad's
    11  [Container Storage Interface (CSI)][csi] support. Only CSI plugins that
    12  implement the [Controller][csi_plugins_internals] interface support this
    13  command. The volume will also be [deregistered] when it is successfully
    14  deleted.
    15  
    16  ## Usage
    17  
    18  ```plaintext
    19  nomad volume delete [options] [volume]
    20  ```
    21  
    22  The `volume delete` command requires a single argument, specifying the ID of
    23  volume to be deleted. The volume must still be [registered] with Nomad in
    24  order to be deleted. Deleting will fail if the volume is still in use by an
    25  allocation or in the process of being unpublished. If the volume no longer
    26  exists, this command will silently return without an error.
    27  
    28  When ACLs are enabled, this command requires a token with the
    29  `csi-write-volume` capability for the volume's namespace.
    30  
    31  ## General Options
    32  
    33  @include 'general_options.mdx'
    34  
    35  [csi]: https://github.com/container-storage-interface/spec
    36  [csi_plugins_internals]: /docs/concepts/plugins/csi#csi-plugins
    37  [deregistered]: /docs/commands/volume/deregister
    38  [registered]: /docs/commands/volume/register
    39  
    40  ## Delete Options
    41  
    42  - `-secret`: Secrets to pass to the plugin to delete the
    43    snapshot. Accepts multiple flags in the form `-secret key=value`