luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

Merge pull request #6317 from hashicorp/docs-fix-volume-docs

Browse source 
Fix `volume_mount` attribute in the docs and formatting
This commit is contained in:
Luiz Aoqui 2019-09-12 16:53:30 -04:00 committed by GitHub
parent c6c294aa47 8dd39333c9
commit c1b04b91cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
website/source/docs/job-specification/volume.html.md
View file

@ -19,7 +19,7 @@ description: |-
</tr>
</table>
The "volume" stanza allows the group to specify that it requires a given volume
The `volume` stanza allows the group to specify that it requires a given volume
from the cluster.
The key of the stanza is the name of the volume as it will be exposed to task
@ -29,7 +29,7 @@ configuration.
job "docs" {
group "example" {
volume "certs" {
type = "host"
type = "host"
read_only = true
config {
@ -41,7 +41,7 @@ job "docs" {
```
The Nomad server will ensure that the allocations are only scheduled on hosts
that have a set of volumes that meet the criteria specified in the volume
that have a set of volumes that meet the criteria specified in the `volume`
stanzas.
The Nomad client will make the volumes available to tasks according to the

12
website/source/docs/job-specification/volume_mount.html.md
View file

@ -18,8 +18,8 @@ description: |-
</tr>
</table>
The "volume_mount" stanza allows the task to specify how a group
[`volume`][volume] should be mounted into the task.
The `volume_mount` stanza allows the task to specify how a group
[`volume`][volume] should be mounted into the task.
```hcl
job "docs" {
@ -35,7 +35,7 @@ job "docs" {
task "example" {
volume_mount {
source = "certs"
volume = "certs"
destination = "/etc/ssl/certs"
}
}
@ -49,14 +49,14 @@ updates to remove a volume that it depends on.
## `volume_mount` Parameters
- `source` `(string: "")` - Specifies the group volume that the mount is going
- `volume` `(string: "")` - Specifies the group volume that the mount is going
to access.
- `destination` `(string: "")` - Specifies where the volume should be mounted
inside the tasks container.
- `read_only` `(bool: false)` - When a group volume is writeable, you may
specify that it is read_only on a per mount level using the `read_only` option
here.
specify that it is `read_only` on a per mount level using the `read_only`
option here.
[volume]: /docs/job-specification/volume.html "Nomad volume Job Specification"