Skip to content

Commit

Permalink
refs: add platforms docs (coreos#11)
Browse files Browse the repository at this point in the history
This introduces a "Platforms" reference page to show how the platform ID
is used, and to keep track of all known platforms.
  • Loading branch information
Luca Bruno authored and dustymabe committed Oct 2, 2019
1 parent 29d52a8 commit c0bdca8
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
7 changes: 5 additions & 2 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
* xref:getting-started.adoc[Getting Started]
* xref:faq.adoc[FAQ]
* User guides
** xref:getting-started.adoc[Getting Started]
** xref:faq.adoc[FAQ]
* Reference pages
** xref:platforms.adoc[Platforms]
31 changes: 31 additions & 0 deletions modules/ROOT/pages/platforms.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
= Platforms

Fedora CoreOS is provisioned via prebuilt disk images, and configured on first-boot via https://github.com/coreos/ignition[Ignition]. Each platform may require specific logic and components, thus dedicated images are provided for each supported environment. Additionally, a unique platform ID is available in the host environment for runtime introspection.

== Runtime introspection

Each Fedora CoreOS image boots with a platform-specific identifier, available on the kernel command-line. The name of the parameter is `ignition.platform.id` and the list of supported platform is documented here.

Platform ID can be introspected at runtime, as follows:

.CLI example of platform introspection
[source, bash]
----
$ grep -o ignition.platform.id='[[:alnum:]]*' /proc/cmdline
ignition.platform.id=aws
----

Platform ID is consumed by OS components such as https://github.com/coreos/ignition[Ignition] and https://github.com/coreos/afterburn[Afterburn]. Additionally, it can be used in systemd units via https://www.freedesktop.org/software/systemd/man/systemd.unit.html#ConditionKernelCommandLine=[`ConditionKernelCommandLine=`].

== Well-known IDs

Here is a list of all supported platforms and their identifier:

* `aws`: Amazon Web Services (cloud platform)
* `azure`: Microsoft Azure (cloud platform)
* `gcp`: Google Cloud Platform (cloud platform)
* `metal`: bare metal with BIOS or UEFI boot
* `openstack`: OpenStack (cloud platform)
* `qemu`: QEMU (hypervisor)
* `vmware`: VMware ESXi (hypervisor)

0 comments on commit c0bdca8

Please sign in to comment.