Skip to content

Commit

Permalink
Backport of [CSI] Prevent stage_publish_base_dir from being subdir of…
Browse files Browse the repository at this point in the history
… mount_dir into release/1.6.x hashicorp#19463

Co-authored-by: Grant Griffiths <[email protected]>
  • Loading branch information
hc-github-team-nomad-core and ggriffiths authored Dec 13, 2023
1 parent 14e8d4e commit cd8c8c5
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .changelog/19441.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
csi: Added validation to `csi_plugin` blocks to prevent `stage_publish_base_dir` from being a subdirectory of `mount_dir`
```
5 changes: 5 additions & 0 deletions nomad/structs/structs.go
Original file line number Diff line number Diff line change
Expand Up @@ -7842,6 +7842,11 @@ func (t *Task) Validate(jobType string, tg *TaskGroup) error {
mErr.Errors = append(mErr.Errors, fmt.Errorf("CSIPluginConfig PluginType must be one of 'node', 'controller', or 'monolith', got: \"%s\"", t.CSIPluginConfig.Type))
}

if t.CSIPluginConfig.StagePublishBaseDir != "" && t.CSIPluginConfig.MountDir != "" &&
strings.HasPrefix(t.CSIPluginConfig.StagePublishBaseDir, t.CSIPluginConfig.MountDir) {
mErr.Errors = append(mErr.Errors, fmt.Errorf("CSIPluginConfig StagePublishBaseDir must not be a subdirectory of MountDir, got: StagePublishBaseDir=\"%s\" MountDir=\"%s\"", t.CSIPluginConfig.StagePublishBaseDir, t.CSIPluginConfig.MountDir))
}

// TODO: Investigate validation of the PluginMountDir. Not much we can do apart from check IsAbs until after we understand its execution environment though :(
}

Expand Down
10 changes: 10 additions & 0 deletions nomad/structs/structs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2905,6 +2905,16 @@ func TestTask_Validate_CSIPluginConfig(t *testing.T) {
},
expectedErr: "CSIPluginConfig PluginType must be one of 'node', 'controller', or 'monolith', got: \"nonsense\"",
},
{
name: "requires staging publish base dir to not be a subdir of mountdir",
pc: &TaskCSIPluginConfig{
ID: "com.hashicorp.csi",
Type: "monolith",
MountDir: "/csi",
StagePublishBaseDir: "/csi/local",
},
expectedErr: "CSIPluginConfig StagePublishBaseDir must not be a subdirectory of MountDir, got: StagePublishBaseDir=\"/csi/local\" MountDir=\"/csi\"",
},
}

for _, tt := range table {
Expand Down
3 changes: 2 additions & 1 deletion website/content/docs/job-specification/csi_plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ csi_plugin {
- `stage_publish_base_dir` `(string: <optional>)` - The base directory
path inside the container where the plugin will be instructed to
stage and publish volumes. This field is typically not required.
Refer to your CSI plugin's documentation for details.
Refer to your CSI plugin's documentation for details. This can not
be a subdirectory of `mount_dir`.

- `health_timeout` `(duration: <optional>)` - The duration that
the plugin supervisor will wait before restarting an unhealthy
Expand Down

0 comments on commit cd8c8c5

Please sign in to comment.