cloudinit/Documentation/cloud-config-locations.md
Josh Wood b56c0f5609 Docs/vmware-backdoor: Rename backdoor to guestinfo
Based on results of google searches on a few possible titles
to improve on the connotation of backdoor, Guestinfo Configuration
Interface (as part of the RPC API) seems recognizable in vmware
circles. Friends call it just guestinfo.

This changeset also makes docs and usage for this flag appear with
a single hypen (-flag) like most go programs do.
2015-11-05 15:27:33 -08:00

2.4 KiB

Cloud-Config Locations

On every boot, coreos-cloudinit looks for a config file to configure your host. Here is a list of locations which are used by the Cloud-Config utility, depending on your CoreOS platform:

Location Description
/media/configvirtfs/openstack/latest/user_data /media/configvirtfs mount point with config-2 label. It should contain a openstack/latest/user_data relative path. Usually used by cloud providers or in VM installations.
/media/configdrive/openstack/latest/user_data FAT or ISO9660 filesystem with config-2 label and /media/configdrive/ mount point. It should also contain a openstack/latest/user_data relative path. Usually used in installations which are configured by USB Flash sticks or CDROM media.
Kernel command line: cloud-config-url=http://example.com/user_data. You can find this string using this command cat /proc/cmdline. Usually used in PXE or iPXE boots.
/var/lib/coreos-install/user_data When you install CoreOS manually using the coreos-install tool. Usually used in bare metal installations.
/usr/share/oem/cloud-config.yml Path for OEM images.
/var/lib/coreos-vagrant/vagrantfile-user-data Vagrant OEM scripts automatically store Cloud-Config into this path.
/var/lib/waagent/CustomData Azure platform uses OEM path for first Cloud-Config initialization and then /var/lib/waagent/CustomData to apply your settings.
http://169.254.169.254/metadata/v1/user-data http://169.254.169.254/2009-04-04/user-data https://metadata.packet.net/userdata DigitalOcean, EC2 and Packet cloud providers correspondingly use these URLs to download Cloud-Config.
/usr/share/oem/bin/vmtoolsd --cmd "info-get guestinfo.coreos.config.data" Cloud-Config provided by VMware Guestinfo
/usr/share/oem/bin/vmtoolsd --cmd "info-get guestinfo.coreos.config.url" Cloud-Config URL provided by VMware Guestinfo

You can also run the coreos-cloudinit tool manually and provide a path to your custom Cloud-Config file:

sudo coreos-cloudinit --from-file=/home/core/cloud-config.yaml

This command will apply your custom cloud-config.