Merge pull request #57705 from vermagit/patch-2

Document settings

Author: Ja-Dunn

articles/virtual-machines/extensions/hpccompute-gpu-linux.md

@@ -13,35 +13,33 @@ ms.devlang: na
 ms.topic: article
 ms.tgt_pltfrm: vm-linux
 ms.workload: infrastructure-services
-ms.date: 08/20/2018
+ms.date: 11/15/2018
 ms.author: roiyz
 
 ---
 # NVIDIA GPU Driver Extension for Linux
 
 ## Overview
 
-This extension installs NVIDIA GPU drivers on Linux N-series VMs. Depending on the VM family, the extension installs CUDA or GRID drivers. When you install NVIDIA drivers using this extension, you are accepting and agreeing to the terms of the NVIDIA End-User License Agreement. During the installation process, your virtual machine may reboot to complete the driver setup.
+This extension installs NVIDIA GPU drivers on Linux N-series VMs. Depending on the VM family, the extension installs CUDA or GRID drivers. When you install NVIDIA drivers using this extension, you are accepting and agreeing to the terms of the [NVIDIA End-User License Agreement](https://go.microsoft.com/fwlink/?linkid=874330). During the installation process, the VM may reboot to complete the driver setup.
 
 An extension is also available to install NVIDIA GPU drivers on [Windows N-series VMs](hpccompute-gpu-windows.md).
 
-Terms of NVIDIA End-User License Agreement are located here - https://go.microsoft.com/fwlink/?linkid=874330
-
 ## Prerequisites
 
 ### Operating system
 
-This extension supports the following OSs:
+This extension supports the following OS distros, depending on driver support for specific OS version.
 
 | Distribution | Version |
 |---|---|
-| Linux: Ubuntu | 16.04 LTS |
-| Linux: Red Hat Enterprise Linux | 7.3, 7.4 |
-| Linux: CentOS | 7.3, 7.4 |
+| Linux: Ubuntu | 16.04 LTS, 18.04 LTS |
+| Linux: Red Hat Enterprise Linux | 7.3, 7.4, 7.5 |
+| Linux: CentOS | 7.3, 7.4, 7.5 |
 
 ### Internet connectivity
 
-The Microsoft Azure Extension for NVIDIA GPU Drivers requires that the target virtual machine is connected to the internet and have access.
+The Microsoft Azure Extension for NVIDIA GPU Drivers requires that the target VM is connected to the internet and have access.
 
 ## Extension schema
 
@@ -59,22 +57,32 @@ The following JSON shows the schema for the extension.
   "properties": {
     "publisher": "Microsoft.HpcCompute",
     "type": "NvidiaGpuDriverLinux",
-    "typeHandlerVersion": "1.1",
+    "typeHandlerVersion": "1.2",
     "autoUpgradeMinorVersion": true,
     "settings": {
     }
   }
 }
 ```
 
-### Property values
+### Properties
 
 | Name | Value / Example | Data Type |
 | ---- | ---- | ---- |
 | apiVersion | 2015-06-15 | date |
 | publisher | Microsoft.HpcCompute | string |
 | type | NvidiaGpuDriverLinux | string |
-| typeHandlerVersion | 1.1 | int |
+| typeHandlerVersion | 1.2 | int |
+
+### Settings
+
+All settings are optional. The default behavior is to not update the kernel if not required for driver installation, install the latest supported driver and the CUDA toolkit (as applicable).
+
+| Name | Description | Default Value | Valid Values | Data Type |
+| ---- | ---- | ---- | ---- | ---- |
+| updateOS | Update the kernel even if not required for driver installation | false | true, false | boolean |
+| driverVersion | NV: GRID driver version<br> NC/ND: CUDA toolkit version. The latest drivers for the chosen CUDA are installed automatically. | latest | GRID: "390.75", "390.57", "390.42"<br> CUDA: "10.0.130", "9.2.88", "9.1.85" | string |
+| installCUDA | Install CUDA toolkit. Only relevant for NC/ND series VMs. | true | true, false | boolean |
 
 
 ## Deployment
@@ -100,7 +108,7 @@ The following example assumes the extension is nested inside the virtual machine
   "properties": {
     "publisher": "Microsoft.HpcCompute",
     "type": "NvidiaGpuDriverLinux",
-    "typeHandlerVersion": "1.1",
+    "typeHandlerVersion": "1.2",
     "autoUpgradeMinorVersion": true,
     "settings": {
     }
@@ -118,21 +126,25 @@ Set-AzureRmVMExtension
     -Publisher "Microsoft.HpcCompute" `
     -ExtensionName "NvidiaGpuDriverLinux" `
     -ExtensionType "NvidiaGpuDriverLinux" `
-    -TypeHandlerVersion 1.1 `
+    -TypeHandlerVersion 1.2 `
     -SettingString '{ `
 	}'
 ```
 
 ### Azure CLI
 
+The following example mirrors the above Azure Resource Manager and PowerShell examples and also adds custom settings as an example for non-default driver installation. Specifically, it updates the OS kernel and installs a specific CUDA toolkit version driver.
+
 ```azurecli
 az vm extension set `
   --resource-group myResourceGroup `
   --vm-name myVM `
   --name NvidiaGpuDriverLinux `
   --publisher Microsoft.HpcCompute `
-  --version 1.1 `
+  --version 1.2 `
   --settings '{ `
+    "updateOS": true, `
+    "driverVersion": "9.1.85", `
   }'
 ```
 
@@ -161,13 +173,12 @@ Extension execution output is logged to the following file:
 | Exit Code | Meaning | Possible Action |
 | :---: | --- | --- |
 | 0 | Operation successful |
-| 1 | Incorrect usage of extension. | Contact support with execution output log. |
-| 10 | Linux Integration Services for Hyper-V and Azure not available or installed. | Check output of lspci. |
-| 11 | NVIDIA GPU not found on this VM size. | Use a [supported VM size and OS](../linux/n-series-driver-setup.md). |
+| 1 | Incorrect usage of extension | Check execution output log |
+| 10 | Linux Integration Services for Hyper-V and Azure not available or installed | Check output of lspci |
+| 11 | NVIDIA GPU not found on this VM size | Use a [supported VM size and OS](../linux/n-series-driver-setup.md) |
 | 12 | Image offer not supported |
 | 13 | VM size not supported | Use an N-series VM to deploy |
-| 14 | Operation unsuccessful | |
-| 21 | Update failed on Ubuntu | Check output of "sudo apt-get update" |
+| 14 | Operation unsuccessful | Check execution output log |
 
 
 ### Support
@@ -177,4 +188,4 @@ If you need more help at any point in this article, you can contact the Azure ex
 ## Next steps
 For more information about extensions, see [Virtual machine extensions and features for Linux](features-linux.md).
 
-For more information about N-series VMs, see [GPU optimized virtual machine sizes](../linux/sizes-gpu.md).
+For more information about N-series VMs, see [GPU optimized virtual machine sizes](../linux/sizes-gpu.md).