open-nomad/website/content/docs/other-specifications/volume/mount_options.mdx
Luiz Aoqui 6598567725
docs: create volume spec page (#13353)
In addition to jobs, there are other objects in Nomad that have a
specific format and can be provided to commands and API endpoints.

This commit creates a new menu section to hold the specification for
volumes and update the command pages to point to the new centralized
definition.

Redirecting the previous entries is not possible with `redirect.js`
because they are done server-side and URL fragments are not accessible
to detect a match. So we provide hidden anchors with a link to the new
page to guide users towards the new documentation.

Co-authored-by: Tim Gross <tgross@hashicorp.com>
2022-06-14 14:08:25 -04:00

45 lines
1.1 KiB
Plaintext

---
layout: docs
page_title: mount_options Block - Volume Specification
description: The "mount_options" block allows for configuring how a volume is mounted.
---
# `mount_options` Block
<Placement
groups={[
['volume', 'mount_options'],
]}
/>
Options for mounting `file-system` volumes that don't already have a
pre-formatted file system.
```hcl
id = "ebs_prod_db1"
namespace = "default"
name = "database"
type = "csi"
plugin_id = "ebs-prod"
capacity_max = "200G"
capacity_min = "100G"
mount_options {
fs_type = "ext4"
mount_flags = ["noatime"]
}
```
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.
## `mount_options` Parameters
- `fs_type` `(string <optional>)` - File system type (ex. `"ext4"`)
- `mount_flags` `([]string: <optional>)` - The flags passed to `mount` (ex.
`["ro", "noatime"]`)
[`volume`]: /docs/job-specification/volume