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..name` | `string` | +| `interface..mac` | `MAC address` | +| `interface..dhcp` | `{"yes", "no"}` | +| `interface..role` | `{"public", "private"}` | +| `interface..ip..address` | `CIDR IP address` | +| `interface..route..gateway` | `IP address` | +| `interface..route..destination` | `CIDR IP address` | +| `dns.server.` | `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.