summaryrefslogtreecommitdiff
path: root/vendor/github.com/coreos/ignition/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/coreos/ignition/README.md')
-rw-r--r--vendor/github.com/coreos/ignition/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/vendor/github.com/coreos/ignition/README.md b/vendor/github.com/coreos/ignition/README.md
new file mode 100644
index 00000000..1c96889d
--- /dev/null
+++ b/vendor/github.com/coreos/ignition/README.md
@@ -0,0 +1,12 @@
+# Ignition #
+
+Ignition is the utility used by CoreOS Container Linux to manipulate disks during the initramfs. This includes partitioning disks, formatting partitions, writing files (regular files, systemd units, networkd units, etc.), and configuring users. On first boot, Ignition reads its configuration from a source of truth (remote URL, network metadata service, hypervisor bridge, etc.) and applies the configuration.
+
+## Usage ##
+
+Odds are good that you don't want to invoke Ignition directly. In fact, it isn't even present in the Container Linux root filesystem. Take a look at the [Getting Started Guide][getting started] for details on providing Ignition with a runtime configuration.
+
+Use the [bug tracker][issues] to report bugs.
+
+[getting started]: doc/getting-started.md
+[issues]: https://github.com/coreos/bugs/issues/new?labels=component/ignition