From 15b50d4712b69a614b8783020acfa903c6cda124 Mon Sep 17 00:00:00 2001
From: Alex Crawford <alex.crawford@coreos.com>
Date: Mon, 18 May 2015 15:22:50 -0700
Subject: [PATCH] doc: Add docs for VMware backdoor

---
 Documentation/vmware-backdoor.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Documentation/vmware-backdoor.md

diff --git a/Documentation/vmware-backdoor.md b/Documentation/vmware-backdoor.md
new file mode 100644
index 0000000..4994238
--- /dev/null
+++ b/Documentation/vmware-backdoor.md
@@ -0,0 +1,25 @@
+# VMware Backdoor #
+
+coreos-cloudinit is capable of reading userdata and metadata from the VMware
+backdoor. This datasource can be enable with the `--from-vmware-backdoor` flag.
+Userdata and metadata are passed from the hypervisor to the virtual machine
+through guest variables. The following guest variables and their expected types
+are supported by coreos-cloudinit:
+
+|            guest variable             |              type               |
+|:--------------------------------------|:--------------------------------|
+| `hostname`                            | `hostname`                      |
+| `interface.<n>.name`                  | `string`                        |
+| `interface.<n>.mac`                   | `MAC address`                   |
+| `interface.<n>.dhcp`                  | `{"yes", "no"}`                 |
+| `interface.<n>.role`                  | `{"public", "private"}`         |
+| `interface.<n>.ip.<m>.address`        | `CIDR IP address`               |
+| `interface.<n>.route.<l>.gateway`     | `IP address`                    |
+| `interface.<n>.route.<l>.destination` | `CIDR IP address`               |
+| `dns.server.<x>`                      | `IP address`                    |
+| `coreos.config.data`                  | `string`                        |
+| `coreos.config.data.encoding`         | `{"", "base64", "gzip+base64"}` |
+
+Note: "n", "m", "l", and "x" are 0-indexed, incrementing integers. The
+identifier for the interfaces does not correspond to anything outside of this
+configuration; it is merely for mapping configuration values to each interface.