Configuration Specification v3.2.0

The Ignition configuration is a JSON document conforming to the following specification, with italicized entries being optional:

ignition (object): metadata about the configuration itself.
- version (string): the semantic version number of the spec. The spec version must be compatible with the latest version (3.2.0). Compatibility requires the major versions to match and the spec version be less than or equal to the latest version. -experimental versions compare less than the final version with the same number, and previous experimental versions are not accepted.
- config (object): options related to the configuration.
  - merge (list of objects): a list of the configs to be merged to the current config.
    - source (string): the URL of the config. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified.
    - compression (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
    - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
      - name (string): the header name.
      - value (string): the header contents.
    - verification (object): options related to the verification of the config.
      - hash (string): the hash of the config, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed config.
  - replace (object): the config that will replace the current.
    - source (string): the URL of the config. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified.
    - compression (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
    - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
      - name (string): the header name.
      - value (string): the header contents.
    - verification (object): options related to the verification of the config.
      - hash (string): the hash of the config, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed config.
- timeouts (object): options relating to http timeouts when fetching files over http or https.
  - httpResponseHeaders (integer): the time to wait (in seconds) for the server’s response headers (but not the body) after making a request. 0 indicates no timeout. Default is 10 seconds.
  - httpTotal (integer): the time limit (in seconds) for the operation (connection, request, and response), including retries. 0 indicates no timeout. Default is 0.
- security (object): options relating to network security.
  - tls (object): options relating to TLS when fetching resources over https.
    - certificateAuthorities (list of objects): the list of additional certificate authorities (in addition to the system authorities) to be used for TLS verification when fetching over https. All certificate authorities must have a unique source.
      - source (string): the URL of the certificate bundle (in PEM format). The bundle can contain multiple concatenated certificates. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified.
      - compression (string): the type of compression used on the certificate bundle (null or gzip). Compression cannot be used with S3.
      - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
        name (string): the header name.
        value (string): the header contents.
      - verification (object): options related to the verification of the certificate bundle.
        hash (string): the hash of the certificate bundle, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed certificate bundle.
- proxy (object): options relating to setting an HTTP(S) proxy when fetching resources.
  - httpProxy (string): will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by httpsProxy or noProxy.
  - httpsProxy (string): will be used as the proxy URL for HTTPS requests unless overridden by noProxy.
  - noProxy (list of strings): specifies a list of strings to hosts that should be excluded from proxying. Each value is represented by an IP address prefix (1.2.3.4), an IP address prefix in CIDR notation (1.2.3.4/8), a domain name, or a special DNS label (*). An IP address prefix and domain name can also include a literal port number (1.2.3.4:80). A domain name matches that name and all subdomains. A domain name with a leading . matches subdomains only. For example foo.com matches foo.com and bar.foo.com; .y.com matches x.y.com but not y.com. A single asterisk (*) indicates that no proxying should be done.
storage (object): describes the desired state of the system’s storage devices.
- disks (list of objects): the list of disks to be configured and their options. Every entry must have a unique device.
  - device (string): the absolute path to the device. Devices are typically referenced by the /dev/disk/by-* symlinks.
  - wipeTable (boolean): whether or not the partition tables shall be wiped. When true, the partition tables are erased before any further manipulation. Otherwise, the existing entries are left intact.
  - partitions (list of objects): the list of partitions and their configuration for this particular disk. Every partition must have a unique number, or if 0 is specified, a unique label.
    - label (string): the PARTLABEL for the partition.
    - number (integer): the partition number, which dictates its position in the partition table (one-indexed). If zero, use the next available partition slot.
    - sizeMiB (integer): the size of the partition (in mebibytes). If zero, the partition will be made as large as possible.
    - startMiB (integer): the start of the partition (in mebibytes). If zero, the partition will be positioned at the start of the largest block available.
    - typeGuid (string): the GPT partition type GUID. If omitted, the default will be 0FC63DAF-8483-4772-8E79-3D69D8477DE4 (Linux filesystem data).
    - guid (string): the GPT unique partition GUID.
    - wipePartitionEntry (boolean): if true, Ignition will clobber an existing partition if it does not match the config. If false (default), Ignition will fail instead.
    - shouldExist (boolean): whether or not the partition with the specified number should exist. If omitted, it defaults to true. If false Ignition will either delete the specified partition or fail, depending on wipePartitionEntry. If false number must be specified and non-zero and label, start, size, guid, and typeGuid must all be omitted.
    - resize (boolean): whether or not the existing partition should be resized. If omitted, it defaults to false. If true, Ignition will resize an existing partition if it matches the config in all respects except the partition size.
- raid (list of objects): the list of RAID arrays to be configured. Every RAID array must have a unique name.
  - name (string): the name to use for the resulting md device.
  - level (string): the redundancy level of the array (e.g. linear, raid1, raid5, etc.).
  - devices (list of strings): the list of devices (referenced by their absolute path) in the array.
  - spares (integer): the number of spares (if applicable) in the array.
  - options (list of strings): any additional options to be passed to mdadm.
- filesystems (list of objects): the list of filesystems to be configured. device and format need to be specified. Every filesystem must have a unique device.
  - device (string): the absolute path to the device. Devices are typically referenced by the /dev/disk/by-* symlinks.
  - format (string): the filesystem format (ext4, btrfs, xfs, vfat, or swap).
  - path (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
  - wipeFilesystem (boolean): whether or not to wipe the device before filesystem creation, see Ignition’s documentation on filesystems for more information. Defaults to false.
  - label (string): the label of the filesystem.
  - uuid (string): the uuid of the filesystem.
  - options (list of strings): any additional options to be passed to the format-specific mkfs utility.
  - mountOptions (list of strings): any special options to be passed to the mount command.
- files (list of objects): the list of files to be written. Every file, directory and link must have a unique path.
  - path (string): the absolute path to the file.
  - overwrite (boolean): whether to delete preexisting nodes at the path. contents must be specified if overwrite is true. Defaults to false.
  - contents (object): options related to the contents of the file.
    - source (string): the URL of the file. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified. If source is omitted and a regular file already exists at the path, Ignition will do nothing. If source is omitted and no file exists, an empty file will be created.
    - compression (string): the type of compression used on the file (null or gzip). Compression cannot be used with S3.
    - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
      - name (string): the header name.
      - value (string): the header contents.
    - verification (object): options related to the verification of the file.
      - hash (string): the hash of the file, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed file.
  - append (list of objects): list of fragments to be appended to the file. Follows the same structure as contents.
    - source (string): the URL of the fragment. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified.
    - compression (string): the type of compression used on the fragment (null or gzip). Compression cannot be used with S3.
    - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
      - name (string): the header name.
      - value (string): the header contents.
    - verification (object): options related to the verification of the fragment.
      - hash (string): the hash of the fragment, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed fragment.
  - mode (integer): the file’s permission mode. Note that the mode must be properly specified as a decimal value (i.e. 0644 -> 420). Setuid/setgid/sticky bits are not supported. If not specified, the permission mode for files defaults to 0644 or the existing file’s permissions if overwrite is false, contents is unspecified, and a file already exists at the path.
  - user (object): specifies the file’s owner.
    - id (integer): the user ID of the owner.
    - name (string): the user name of the owner.
  - group (object): specifies the file’s group.
    - id (integer): the group ID of the group.
    - name (string): the group name of the group.
- directories (list of objects): the list of directories to be created. Every file, directory, and link must have a unique path.
  - path (string): the absolute path to the directory.
  - overwrite (boolean): whether to delete preexisting nodes at the path. If false and a directory already exists at the path, Ignition will only set its permissions. If false and a non-directory exists at that path, Ignition will fail. Defaults to false.
  - mode (integer): the directory’s permission mode. Note that the mode must be properly specified as a decimal value (i.e. 0755 -> 493). Setuid/setgid/sticky bits are not supported. If not specified, the permission mode for directories defaults to 0755 or the mode of an existing directory if overwrite is false and a directory already exists at the path.
  - user (object): specifies the directory’s owner.
    - id (integer): the user ID of the owner.
    - name (string): the user name of the owner.
  - group (object): specifies the directory’s group.
    - id (integer): the group ID of the group.
    - name (string): the group name of the group.
- links (list of objects): the list of links to be created. Every file, directory, and link must have a unique path.
  - path (string): the absolute path to the link
  - overwrite (boolean): whether to delete preexisting nodes at the path. If overwrite is false and a matching link exists at the path, Ignition will only set the owner and group. Defaults to false.
  - user (object): specifies the owner for a symbolic link. Ignored for hard links.
    - id (integer): the user ID of the owner.
    - name (string): the user name of the owner.
  - group (object): specifies the group for a symbolic link. Ignored for hard links.
    - id (integer): the group ID of the group.
    - name (string): the group name of the group.
  - target (string): the target path of the link
  - hard (boolean): a symbolic link is created if this is false, a hard one if this is true.
- luks (list of objects): the list of luks devices to be created. Every device must have a unique name.
  - name (string): the name of the luks device.
  - device (string): the absolute path to the device. Devices are typically referenced by the /dev/disk/by-* symlinks.
  - keyFile (object): options related to the contents of the key file.
    - source (string): the URL of the key file. Supported schemes are http, https, tftp, s3, gs, and data. When using http, it is advisable to use the verification option to ensure the contents haven’t been modified.
    - compression (string): the type of compression used on the key file (null or gzip). Compression cannot be used with S3.
    - httpHeaders (list of objects): a list of HTTP headers to be added to the request. Available for http and https source schemes only.
      - name (string): the header name.
      - value (string): the header contents.
    - verification (object): options related to the verification of the key file.
      - hash (string): the hash of the key file, in the form <type>-<value> where type is either sha512 or sha256. If compression is specified, the hash describes the decompressed key file.
  - label (string): the label of the luks device.
  - uuid (string): the uuid of the luks device.
  - options (list of strings): any additional options to be passed to cryptsetup luksFormat.
  - wipeVolume (boolean): whether or not to wipe the device before volume creation, see Ignition’s documentation on filesystems for more information.
  - clevis (object): describes the clevis configuration for the luks device.
    - tang (list of objects): describes a tang server. Every server must have a unique url.
      - url (string): url of the tang server.
      - thumbprint (string): thumbprint of a trusted signing key.
    - tpm2 (boolean): whether or not to use a tpm2 device.
    - threshold (integer): sets the minimum number of pieces required to decrypt the device. Default is 1.
    - custom (object): overrides the clevis configuration. The pin & config will be passed directly to clevis luks bind. If specified, all other clevis options must be omitted.
      - pin (string): the clevis pin.
      - config (string): the clevis configuration JSON.
      - needsNetwork (boolean): whether or not the device requires networking.
systemd (object): describes the desired state of the systemd units.
- units (list of objects): the list of systemd units. Every unit must have a unique name.
  - name (string): the name of the unit. This must be suffixed with a valid unit type (e.g. “thing.service”).
  - enabled (boolean): whether or not the service shall be enabled. When true, the service is enabled. When false, the service is disabled. When omitted, the service is unmodified. In order for this to have any effect, the unit must have an install section.
  - mask (boolean): whether or not the service shall be masked. When true, the service is masked by symlinking it to /dev/null. When false, the service is unmasked by deleting the symlink to /dev/null if it exists.
  - contents (string): the contents of the unit.
  - dropins (list of objects): the list of drop-ins for the unit. Every drop-in must have a unique name.
    - name (string): the name of the drop-in. This must be suffixed with “.conf”.
    - contents (string): the contents of the drop-in.
passwd (object): describes the desired additions to the passwd database.
- users (list of objects): the list of accounts that shall exist. All users must have a unique name.
  - name (string): the username for the account.
  - passwordHash (string): the hashed password for the account.
  - sshAuthorizedKeys (list of strings): a list of SSH keys to be added as an SSH key fragment at .ssh/authorized_keys.d/ignition in the user’s home directory. All SSH keys must be unique.
  - uid (integer): the user ID of the account.
  - gecos (string): the GECOS field of the account.
  - homeDir (string): the home directory of the account.
  - noCreateHome (boolean): whether or not to create the user’s home directory. This only has an effect if the account doesn’t exist yet.
  - primaryGroup (string): the name of the primary group of the account.
  - groups (list of strings): the list of supplementary groups of the account.
  - noUserGroup (boolean): whether or not to create a group with the same name as the user. This only has an effect if the account doesn’t exist yet.
  - noLogInit (boolean): whether or not to add the user to the lastlog and faillog databases. This only has an effect if the account doesn’t exist yet.
  - shell (string): the login shell of the new account.
  - shouldExist (boolean): whether or not the user with the specified name should exist. If omitted, it defaults to true. If false, then Ignition will delete the specified user.
  - system (boolean): whether or not this account should be a system account. This only has an effect if the account doesn’t exist yet.
- groups (list of objects): the list of groups to be added. All groups must have a unique name.
  - name (string): the name of the group.
  - gid (integer): the group ID of the new group.
  - passwordHash (string): the hashed password of the new group.
  - shouldExist (boolean): whether or not the group with the specified name should exist. If omitted, it defaults to true. If false, then Ignition will delete the specified group.
  - system (boolean): whether or not the group should be a system group. This only has an effect if the group doesn’t exist yet.