Add note for aws-neuron-dkms install to address multiple kernel versi…

…ons (#253)

* Add note for aws-neuron-dkms install to address multiple kernel versions

* fix troubleshooting guide reference

* clarify how to check if dkms is installed for the current kernel

* clarify dkms dependency on linux kernel

neuron-guide/neuron-runtime/nrt-troubleshoot.rst

@@ -95,6 +95,8 @@ Please follow the installation steps in :ref:`neuron-install-guide` to install `
 package and then restart runtime using
 ``sudo systemctl restart neuron-rtd`` command.
 
+.. _neuron-driver-installation-fails:
+
 Neuron Driver installation fails
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

neuron-intro/install-templates/al2-pip-install.rst

@@ -18,4 +18,14 @@ are installed.
    sudo yum install aws-neuron-runtime-base
    sudo yum install aws-neuron-runtime
    sudo yum install aws-neuron-tools
-   
+
+.. note::
+
+   ``aws-neuron-dkms`` is a special kernel module package that has a dependency on the linux kernel version. This
+   means that when the package is installed through yum, it will only be compatible with the linux kernel version
+   that was running on the instance during the installation.
+
+   You have to re-install this package if you change the linux kernel version. The current kernel version can be
+   checked using ``uname -r``, and a list of the kernels that have dkms installed can be checked with
+   ``dkms status | grep aws-neuron``. Refer to the :ref:`NRT Troubleshooting Guide <neuron-driver-installation-fails>`
+   for steps on how to re-install aws-neuron-dkms on a new kernel.

neuron-intro/install-templates/ubuntu-pip-install.rst

@@ -25,3 +25,14 @@
 
       E: Could not get lock /var/lib/dpkg/lock-frontend - open (11: Resource temporarily unavailable)
       E: Unable to acquire the dpkg frontend lock (/var/lib/dpkg/lock-frontend), is another process using it?
+
+.. note::
+
+   ``aws-neuron-dkms`` is a special kernel module package that has a dependency on the linux kernel version. This
+   means that when the package is installed through apt, it will only be compatible with the linux kernel version
+   that was running on the instance during the installation.
+
+   You have to re-install this package if you change the linux kernel version. The current kernel version can be
+   checked using ``uname -r``, and a list of the kernels that have dkms installed can be checked with
+   ``dkms status | grep aws-neuron``. Refer to the :ref:`NRT Troubleshooting Guide <neuron-driver-installation-fails>`
+   for steps on how to re-install aws-neuron-dkms on a new kernel.