From 262cafcdff151b9ecc54f520c4f1acae890b42ed Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Thu, 21 May 2020 13:56:40 -0400 Subject: [PATCH] docs: add missing fields to driver Capabilities (#8037) Adds `NetIsolationModes`, `MustInitiateNetwork`, and `MountConfigs` fields to the driver `Capabilities` internals documentation. --- .../docs/internals/plugins/task-drivers.mdx | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/website/pages/docs/internals/plugins/task-drivers.mdx b/website/pages/docs/internals/plugins/task-drivers.mdx index c77494e3a..7a45b0cb9 100644 --- a/website/pages/docs/internals/plugins/task-drivers.mdx +++ b/website/pages/docs/internals/plugins/task-drivers.mdx @@ -48,13 +48,28 @@ Capabilities define what features the driver implements. Example: ```go Capabilities { // Does the driver support sending OS signals to the task? - SendSignals: true, + SendSignals: true, // Does the driver support executing a command within the task execution // environment? - Exec: true, + Exec: true, // What filesystem isolation is supported by the driver. Options include // FSIsolationImage, FSIsolationChroot, and FSIsolationNone - FSIsolation: FSIsolationImage, + FSIsolation: FSIsolationImage, + + // NetIsolationModes lists the set of isolation modes supported by the driver. + // Options include NetIsolationModeHost, NetIsolationModeGroup, + // NetIsolationModeTask, and NetIsolationModeNone. + NetIsolationModes []NetIsolationMode + + // MustInitiateNetwork tells Nomad that the driver must create the network + // namespace and that the CreateNetwork and DestroyNetwork RPCs are implemented. + MustInitiateNetwork bool + + // MountConfigs tells Nomad which mounting config options the driver + // supports. This is used to check whether mounting host volumes or CSI + // volumes is allowed. Options include MountConfigSupportAll (default), + // or MountConfigSupportNone. + MountConfigs MountConfigSupport } ```