HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Nomad
Nomad Home

You are viewing documentation for version v1.1.x. View latest version.

Command: volume register

The volume register command registers external storage volumes with Nomad's Container Storage Interface (CSI) support. The volume must exist on the remote storage provider before it can be registered and used by a task.

CSI plugins that implement the Controller interface can be created via the volume create command, which will automatically register the volume as well.

Usage

nomad volume register [options] [file]

The volume register command requires a single argument, specifying the path to a file containing a valid volume specification. This file will be read and the job will be submitted to Nomad for scheduling. If the supplied path is "-", the job 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 the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

  • -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_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 the NOMAD_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.

  • -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_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 the NOMAD_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 the NOMAD_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 the NOMAD_CLIENT_KEY environment variable if set.

  • -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_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 if NOMAD_SKIP_VERIFY is set.

  • -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

Volume Specification

The file may be provided as either HCL or JSON. An example HCL configuration:

id              = "ebs_prod_db1"
name            = "database"
type            = "csi"
external_id     = "vol-23452345"
plugin_id       = "ebs-prod"

capability {
  access_mode     = "single-node-reader-only"
  attachment_mode = "file-system"
}

capability {
  access_mode     = "single-node-writer"
  attachment_mode = "file-system"
}

mount_options {
  fs_type     = "ext4"
  mount_flags = "noatime"
}

secrets {
  example_secret = "xyzzy"
}

parameters {
  skuname = "Premium_LRS"
}

context {
  endpoint = "http://192.168.1.101:9425"
}

Volume Specification Parameters

  • id (string: <required>) - The unique ID of the volume. This is how the volume.source field in a job specification will refer to the volume.

  • name (string: <required>) - The display name of the volume.

  • type (string: <required>) - The type of volume. Currently only "csi" is supported.

  • external_id (string: <required>) - The ID of the physical volume from the storage provider. For example, the volume ID of an AWS EBS volume or Digital Ocean volume.

  • plugin_id (string: <required>) - The ID of the CSI plugin that manages this volume.

  • capability (Capability: <required>) - Option for validating the capability of a volume. You must provide at least one capability block, and you must provide a block for each capability you intend to use in a job's volume block. Each capability 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 mounting file-system volumes that don't already have a pre-formatted file system. This block will be validated during volume creation against the capability field. The mount_options provided in a job specification's volume 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: file system type (ex. "ext4")
    • mount_flags: the flags passed to mount (ex. ["ro", "noatime"])

  • 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.

  • context (map<string|string>:nil) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume. The details of these parameters are specific to each storage provider, so please see the specific plugin documentation for more information.

Unused Fields

Note that several fields used in the volume create command are set automatically by the plugin when volume create is successful and cannot be set on a pre-existing volume. You should not set the snapshot_id, clone_id, capacity_min, or capacity_max fields described on that page.