» Command: volume create
The volume create
command creates external storage volumes with Nomad's
Container Storage Interface (CSI) support. Only CSI plugins that
implement the Controller interface support this
command. The volume will also be registered when it is successfully created.
» Usage
The volume create
command requires a single argument, specifying the path to
a file containing a valid volume specification. This
file will be read and the volume will be submitted to Nomad for scheduling. If
the supplied path is "-", the volume file is read from STDIN. Otherwise it is
read from the file at the supplied path.
When ACLs are enabled, this command requires a token with the
csi-write-volume
capability for the volume's namespace.
» General Options
-address=<addr>
: The address of the Nomad server. Overrides theNOMAD_ADDR
environment variable if set. Defaults tohttp://127.0.0.1:4646
.-region=<region>
: The region of the Nomad server to forward commands to. Overrides theNOMAD_REGION
environment variable if set. Defaults to the Agent's local region.-namespace=<namespace>
: The target namespace for queries and actions bound to a namespace. Overrides theNOMAD_NAMESPACE
environment variable if set. If set to'*'
, job and alloc subcommands query all namespaces authorized to user. Defaults to the "default" namespace.-no-color
: Disables colored command output. Alternatively,NOMAD_CLI_NO_COLOR
may be set. This option takes precedence over-force-color
.-force-color
: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,NOMAD_CLI_FORCE_COLOR
may be set. This option has no effect if-no-color
is also used.-ca-cert=<path>
: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides theNOMAD_CACERT
environment variable if set.-ca-path=<path>
: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both-ca-cert
and-ca-path
are specified,-ca-cert
is used. Overrides theNOMAD_CAPATH
environment variable if set.-client-cert=<path>
: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify-client-key
. Overrides theNOMAD_CLIENT_CERT
environment variable if set.-client-key=<path>
: Path to an unencrypted PEM encoded private key matching the client certificate from-client-cert
. Overrides theNOMAD_CLIENT_KEY
environment variable if set.-tls-server-name=<value>
: The server name to use as the SNI host when connecting via TLS. Overrides theNOMAD_TLS_SERVER_NAME
environment variable if set.-tls-skip-verify
: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped ifNOMAD_SKIP_VERIFY
is set.-token
: The SecretID of an ACL token to use to authenticate API requests with. Overrides theNOMAD_TOKEN
environment variable if set.
» Volume Specification
The file may be provided as either HCL or JSON. An example HCL configuration:
» Volume Specification Parameters
id
(string: <required>)
- The unique ID of the volume. This is how thevolume.source
field in a job specification will refer to the volume.namespace
(string: <optional>)
- The namespace of the volume. This field overrides the namespace provided by the-namespace
flag orNOMAD_NAMESPACE
environment variable. Defaults to"default"
if unset.name
(string: <required>)
- The display name of the volume. This field may be used by the external storage provider to tag the volume.type
(string: <required>)
- The type of volume. Currently only"csi"
is supported.plugin_id
(string: <required>)
- The ID of the CSI plugin that manages this volume.snapshot_id
(string: <optional>)
- If the storage provider supports snapshots, the external ID of the snapshot to restore when creating this volume. If omitted, the volume will be created from scratch. Thesnapshot_id
cannot be set if theclone_id
field is set.clone_id
(string: <optional>)
- If the storage provider supports cloning, the external ID of the volume to clone when creating this volume. If omitted, the volume will be created from scratch. Theclone_id
cannot be set if thesnapshot_id
field is set.capacity_min
(string: <optional>)
- Option for setting the capacity. The volume must be at least this large, in bytes. The storage provider may return a volume that is larger than this value. Accepts human-friendly suffixes such as"100GiB"
. This field may not be supported by all storage providers.capacity_max
(string: <optional>)
- Option for setting the capacity. The volume must be no more than this large, in bytes. The storage provider may return a volume that is smaller than this value. Accepts human-friendly suffixes such as"100GiB"
. This field may not be supported by all storage providers.capability
(Capability: <required>)
- Option for validating the capability of a volume. You must provide at least onecapability
block, and you must provide a block for each capability you intend to use in a job'svolume
block. Eachcapability
block must have the following fields:access_mode
(string: <required>)
- Defines whether a volume should be available concurrently. Can be one of"single-node-reader-only"
,"single-node-writer"
,"multi-node-reader-only"
,"multi-node-single-writer"
, or"multi-node-multi-writer"
. Most CSI plugins support only single-node modes. Consult the documentation of the storage provider and CSI plugin.attachment_mode
(string: <required>)
- The storage API that will be used by the volume. Most storage providers will support"file-system"
, to mount volumes using the CSI filesystem API. Some storage providers will support"block-device"
, which will mount the volume with the CSI block device API within the container.
mount_options
- Options for mountingfile-system
volumes that don't already have a pre-formatted file system. This block will be validated during volume creation against thecapability
field. Themount_options
provided in a job specification'svolume
block will override this block. Consult the documentation for your storage provider and CSI plugin as to whether these options are required or necessary.fs_type
(string <optional>)
- File system type (ex."ext4"
)mount_flags
([]string: <optional>)
- The flags passed tomount
(ex.["ro", "noatime"]
)
topology_request
(TopologyRequest: nil)
- Specify locations (region, zone, rack, etc.) where the provisioned volume must be accessible from. Consult the documentation for your storage provider and CSI plugin as to whether it supports defining topology and what values it expects for topology segments. Specifying topology segments that aren't supported by the storage provider may return an error or may be silently removed by the plugin.secrets
(map<string|string>:nil)
- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.parameters
(map<string|string>:nil)
- An optional key-value map of strings passed directly to the CSI plugin to configure the volume. The details of these parameters are specific to each storage provider, so please see the specific plugin documentation for more information.
»topology_request
Parameters
For the topology_request
field, you may specify a list of either
required
or preferred
topologies (or both). The required
topologies indicate that the volume must be created in a location
accessible from at least one of the listed topologies. The preferred
topologies indicate that you would prefer the storage provider to
create the volume in one of the provided topologies.
Each topology listed has a single field:
segments
(map[string]string)
- A map of location types to their values. The specific fields required are defined by the CSI plugin. For example, a plugin might require defining both a rack and a zone:segments {rack = "R2", zone = "us-east-1a"}
.
For example:
This configuration indicates you require the volume to be created
within racks R1
or R2
, but that you prefer the volume to be
created within R1
.
» Unused Fields
Note that several fields used in the volume register
command are set
automatically by the plugin when volume create
is successful. You should not
set the external_id
or context
fields described on that page.