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

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume register'
     4  description: |
     5    Register volumes with CSI plugins.
     6  ---
     7  
     8  # Command: volume register
     9  
    10  The `volume register` command registers external storage volumes with Nomad's
    11  [Container Storage Interface (CSI)][csi] support. The volume must exist on the
    12  remote storage provider before it can be registered and used by a task.
    13  
    14  CSI plugins that implement the [Controller][csi_plugins_internals] interface
    15  can be created via the [`volume create`] command, which will automatically
    16  register the volume as well.
    17  
    18  ## Usage
    19  
    20  ```plaintext
    21  nomad volume register [options] [file]
    22  ```
    23  
    24  The `volume register` command requires a single argument, specifying the path
    25  to a file containing a valid [volume specification][volume_specification]. This
    26  file will be read and the job will be submitted to Nomad for scheduling. If the
    27  supplied path is "-", the job file is read from STDIN. Otherwise it is read
    28  from the file at the supplied path.
    29  
    30  When ACLs are enabled, this command requires a token with the
    31  `csi-write-volume` capability for the volume's namespace.
    32  
    33  ## General Options
    34  
    35  @include 'general_options.mdx'
    36  
    37  ## Volume Specification
    38  
    39  <!--
    40  Redirection rules are applied server-side, so we can't redirect these sections
    41  that used to be located in this page since they use URL fragments. Creating
    42  these hidden anchors will at least point users to the new page, although not to
    43  the exact section.
    44  -->
    45  
    46  <span id="volume-specification-parameters" />
    47  <span id="id" />
    48  <span id="namespace-1" />
    49  <span id="name" />
    50  <span id="type" />
    51  <span id="external_id" />
    52  <span id="plugin_id" />
    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="context" />
    63  <span id="topology_request-parameters" />
    64  <span id="segments" />
    65  <span id="unused-fields" />
    66  
    67  The volume specification is documented in the [Volume
    68  Specification][volume_specification] page.
    69  
    70  [csi]: https://github.com/container-storage-interface/spec
    71  [csi_plugins_internals]: /docs/concepts/plugins/csi#csi-plugins
    72  [volume_specification]: /docs/other-specifications/volume
    73  [`volume create`]: /docs/commands/volume/create