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

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume create'
     4  description: |
     5    Create volumes with CSI plugins.
     6  ---
     7  
     8  # Command: volume create
     9  
    10  The `volume create` command creates 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 [registered] when it is successfully created.
    14  
    15  ## Usage
    16  
    17  ```plaintext
    18  nomad volume create [options] [file]
    19  ```
    20  
    21  The `volume create` command requires a single argument, specifying the path to
    22  a file containing a valid [volume specification][volume_specification]. This
    23  file will be read and the volume will be submitted to Nomad for scheduling. If
    24  the supplied path is "-", the volume file is read from STDIN. Otherwise it is
    25  read from the file at the supplied path.
    26  
    27  When ACLs are enabled, this command requires a token with the
    28  `csi-write-volume` capability for the volume's namespace.
    29  
    30  ## General Options
    31  
    32  @include 'general_options.mdx'
    33  
    34  ## Volume Specification
    35  
    36  <!--
    37  Redirection rules are applied server-side, so we can't redirect these sections
    38  that used to be located in this page since they use URL fragments. Creating
    39  these hidden anchors will at least point users to the new page, although not to
    40  the exact section.
    41  -->
    42  
    43  <span id="volume-specification-parameters" />
    44  <span id="id" />
    45  <span id="namespace-1" />
    46  <span id="name" />
    47  <span id="type" />
    48  <span id="plugin_id" />
    49  <span id="snapshot_id" />
    50  <span id="clone_id" />
    51  <span id="capacity_min" />
    52  <span id="capacity_max" />
    53  <span id="capability" />
    54  <span id="access_mode" />
    55  <span id="attachment_mode" />
    56  <span id="mount_options" />
    57  <span id="fs_type" />
    58  <span id="mount_flags" />
    59  <span id="topology_request" />
    60  <span id="secrets" />
    61  <span id="parameters" />
    62  <span id="topology_request-parameters" />
    63  <span id="segments" />
    64  <span id="unused-fields" />
    65  
    66  The volume specification is documented in the [Volume
    67  Specification][volume_specification] page.
    68  
    69  [csi]: https://github.com/container-storage-interface/spec
    70  [csi_plugins_internals]: /docs/concepts/plugins/csi#csi-plugins
    71  [registered]: /docs/commands/volume/register
    72  [volume_specification]: /docs/other-specifications/volume