From 1ab731cf1f08edcb2ff2b16ec4991fbc9646445d Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Fri, 24 Oct 2014 12:30:12 -0700
Subject: [PATCH] website/docs: document kernel upgrades for VMware [GH-4362]

---
 website/docs/source/layouts/layout.erb        |  1 +
 .../source/v2/vmware/kernel-upgrade.html.md   | 55 +++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 website/docs/source/v2/vmware/kernel-upgrade.html.md

diff --git a/website/docs/source/layouts/layout.erb b/website/docs/source/layouts/layout.erb
index 94fa3bb7f..f9d5f54b9 100644
--- a/website/docs/source/layouts/layout.erb
+++ b/website/docs/source/layouts/layout.erb
@@ -253,6 +253,7 @@
 									<li<%= sidebar_current("vmware-boxes") %>><a href="/v2/vmware/boxes.html">Boxes</a></li>
 									<li<%= sidebar_current("vmware-configuration") %>><a href="/v2/vmware/configuration.html">Configuration</a></li>
 									<li<%= sidebar_current("vmware-known-issues") %>><a href="/v2/vmware/known-issues.html">Known Issues</a></li>
+									<li<%= sidebar_current("vmware-kernel-upgrade") %>><a href="/v2/vmware/kernel-upgrade.html">Kernel Upgrade</a></li>
 								</ul>
 								<% end %>
 								<% end %>
diff --git a/website/docs/source/v2/vmware/kernel-upgrade.html.md b/website/docs/source/v2/vmware/kernel-upgrade.html.md
new file mode 100644
index 000000000..9b998ba33
--- /dev/null
+++ b/website/docs/source/v2/vmware/kernel-upgrade.html.md
@@ -0,0 +1,55 @@
+---
+page_title: "Kernel Upgrade - VMware Provider"
+sidebar_current: "vmware-kernel-upgrade"
+---
+
+# Kernel Upgrade
+
+If as part of running your Vagrant environment with VMware, you perform
+a kernel upgrade, it is likely that the VMware guest tools will stop working.
+This breaks features of Vagrant such as synced folders and sometimes
+networking as well.
+
+This page documents how to upgrade your kernel and keep your guest tools
+functioning. If you're not planning to upgrade your kernel, then you can safely
+skip this page.
+
+## Enable Auto-Upgrade of VMware Tools
+
+If you're running a common OS, VMware tools can often auto-upgrade themselves.
+This setting is disabled by default. The Vagrantfile settings below will
+enable auto-upgrading:
+
+```ruby
+# Ensure that VMWare Tools recompiles kernel modules
+# when we update the linux images
+$fix_vmware_tools_script = <<SCRIPT
+sed -i.bak 's/answer AUTO_KMODS_ENABLED_ANSWER no/answer AUTO_KMODS_ENABLED_ANSWER yes/g' /etc/vmware-tools/locations
+sed -i.bak 's/answer AUTO_KMODS_ENABLED no/answer AUTO_KMODS_ENABLED yes/g' /etc/vmware-tools/locations
+SCRIPT
+
+Vagrant.configure(2) do |config|
+  # ...
+
+  config.vm.provision "shell", inline: $fix_vmware_tools_script
+end
+```
+
+Note that this doesn't work for every OS, so `vagrant up` with the above
+settings, do a kernel upgrade, and do a `vagrant reload`. If HGFS (synced
+folders) and everything appears to be working, great! If not, then read on...
+
+## Manually Reinstalling VMware Tools
+
+At this point, you'll have to manually reinstall VMware tools. The best
+source of information for how to do this is the
+[VMware documentation](http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1018414).
+
+There are some gotchas:
+
+  * Make sure you have the kernel headers properly installed. This varies
+    by distro but is generally a package available via the package manager.
+
+  * Watch the installation output carefully. Even if HGFS (synced folders)
+    support failed to build, the installer will output that installing VMware
+    tools was successful. Read the output to find any error messages.