ignition

module
v0.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 11, 2019 License: Apache-2.0

README

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.

Ignition has two main development branches: master and spec2x. This is the spec2x branch which is for Ignition included in Container Linux. For new Ignition development see the master branch.

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 for details on providing Ignition with a runtime configuration.

Contact

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

To help triage or fix bugs, see the current Ignition issues.

Reporting Bugs

Config Validation

To validate a config for Ignition there are binaries for a cli tool called ignition-validate available on the releases page, and an online validator available on the CoreOS website.

Directories

Path Synopsis
config
shared
Package shared contains types, validations, errors, etc that may be shared between multiple config versions safely.
Package shared contains types, validations, errors, etc that may be shared between multiple config versions safely.
shared/errors
Package errors includes errors that are used in multiple config versions
Package errors includes errors that are used in multiple config versions
shared/validations
Package validations contains validations shared between multiple config versions.
Package validations contains validations shared between multiple config versions.
v1
earlyrand
Package earlyrand provides a non-blocking reader to a source of randomness that can be used at early-boot.
Package earlyrand provides a non-blocking reader to a source of randomness that can be used at early-boot.
log
oem

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL