coreos-metadata

This is a small utility, typically used in conjunction with Ignition, which reads metadata from a given cloud-provider and applies it to the system. This can include adding SSH keys and writing cloud-specific attributes into an environment file (e.g. /run/metadata/coreos), which can then be consumed by systemd service units via EnvironmentFile=.

Support

The supported cloud providers and their respective metadata are as follows:

• azure
  • SSH Keys
  • Attributes
    • COREOSAZUREIPV4DYNAMIC
    • COREOSAZUREIPV4VIRTUAL
• cloudstack-configdrive
  • SSH Keys
  • Attributes
    • COREOSCLOUDSTACKAVAILABILITYZONE
    • COREOSCLOUDSTACKINSTANCEID
    • COREOSCLOUDSTACKSERVICEOFFERING
    • COREOSCLOUDSTACKCLOUDIDENTIFIER
    • COREOSCLOUDSTACKLOCALHOSTNAME
    • COREOSCLOUDSTACKVMID
• cloudstack-metadata
  • SSH Keys
  • Attributes
    • COREOSCLOUDSTACKAVAILABILITYZONE
    • COREOSCLOUDSTACKCLOUDIDENTIFIER
    • COREOSCLOUDSTACKHOSTNAME
    • COREOSCLOUDSTACKINSTANCEID
    • COREOSCLOUDSTACKIPV4LOCAL
    • COREOSCLOUDSTACKIPV4PUBLIC
    • COREOSCLOUDSTACKLOCALHOSTNAME
    • COREOSCLOUDSTACKPUBLICHOSTNAME
    • COREOSCLOUDSTACKSERVICEOFFERING
    • COREOSCLOUDSTACKVM_ID
• digitalocean
  • SSH Keys
  • Network Configs
  • Attributes
    • COREOSDIGITALOCEANHOSTNAME
    • COREOSDIGITALOCEANIPV4ANCHOR0
    • COREOSDIGITALOCEANIPV4PUBLIC0
    • COREOSDIGITALOCEANIPV4PRIVATE0
    • COREOSDIGITALOCEANIPV6PUBLIC0
    • COREOSDIGITALOCEANIPV6PRIVATE0
    • COREOSDIGITALOCEANREGION
• ec2
  • SSH Keys
  • Attributes
    • COREOSEC2HOSTNAME
    • COREOSEC2PUBLICHOSTNAME
    • COREOSEC2IPV4LOCAL
    • COREOSEC2IPV4PUBLIC
    • COREOSEC2AVAILABILITYZONE
    • COREOSEC2INSTANCE_ID
    • COREOSEC2REGION
• gce
  • SSH Keys
  • Attributes
    • COREOSGCEHOSTNAME
    • COREOSGCEIPEXTERNAL0
    • COREOSGCEIPLOCAL0
• openstack-metadata
  • SSH Keys
  • Attributes
    • COREOSOPENSTACKHOSTNAME
    • COREOSOPENSTACKIPV4LOCAL
    • COREOSOPENSTACKIPV4PUBLIC
    • COREOSOPENSTACKINSTANCE_ID
• packet
  • SSH Keys
  • Network Configs
  • Attributes
    • COREOSPACKETHOSTNAME
    • COREOSPACKETIPV4PUBLIC0
    • COREOSPACKETIPV4PRIVATE0
    • COREOSPACKETIPV6PUBLIC0
• vagrant-virtualbox
  • Attributes
    • COREOSVAGRANTVIRTUALBOXPRIVATEIPV4
    • COREOSVAGRANTVIRTUALBOX_HOSTNAME

Additionally, some attribute names are reserved for usage by custom metadata providers. These can be safely used by external providers on a platform not supported by coreos-metadata:

• custom
  • Attributes
    • COREOSCUSTOMHOSTNAME
    • COREOSCUSTOMPUBLICIPV4
    • COREOSCUSTOMPRIVATEIPV4
    • COREOSCUSTOMPUBLICIPV6
    • COREOSCUSTOMPRIVATEIPV6