latest--butane-v1.6.0
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/butane-config/_shared/latest--butane-v1.6.0.json |
| Parent schema | butane-config |
Schema to validate v1.6.0 specifications
Properties
The semantic version of the spec for this document. This document is for version 1.6.0 and generates Ignition configs with version 3.5.0.
Metadata about the configuration itself.
4 nested properties
Options related to the configuration.
2 nested properties
A list of the configs to be merged to the current config.
6 nested properties
The type of compression used on the file (null or gzip). Compression cannot be used with S3.
A list of HTTP headers to be added to the request. Available for http and https source schemes only.
Options related to the verification
The contents. Mutually exclusive with source and local.
A local path to the contents, relative to the directory specified by the --files-dir command-line argument. Mutually exclusive with source and inline.
Options relating to http timeouts when fetching files over http or https.
2 nested properties
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.
The time limit (in seconds) for the operation (connection, request, and response), including retries. 0 indicates no timeout. Default is 0.
Options relating to network security.
1 nested properties
Options relating to TLS when fetching resources over https.
1 nested properties
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, inline, or local.
Options relating to setting an HTTP(S) proxy when fetching resources.
3 nested properties
Will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by https_proxy or no_proxy.
Will be used as the proxy URL for HTTPS requests unless overridden by no_proxy.
Describes the desired state of the system’s storage devices.
8 nested properties
The list of disks to be configured and their options. Every entry must have a unique device.
The list of RAID arrays to be configured. Every RAID array must have a unique name.
The list of filesystems to be configured. device and format need to be specified. Every filesystem must have a unique device.
The list of files to be written. Every file, directory and link must have a unique path.
The list of directories to be created. Every file, directory, and link must have a unique path.
The list of links to be created. Every file, directory, and link must have a unique path.
The list of files to be written. Every file, directory and link must have a unique path.
A list of local directory trees to be embedded in the config. Ownership is not preserved. File modes are set to 0755 if the local file is executable or 0644 otherwise. Attributes of files, directories, and symlinks can be overridden by creating a corresponding entry in the files, directories, or links section; such files entries must omit contents and such links entries must omit target.
Describes the desired state of the systemd units.
1 nested properties
The list of systemd units. Every unit must have a unique name.
Describes the desired additions to the passwd database.
2 nested properties
The list of accounts that shall exist. All users must have a unique name.
The list of groups to be added. All groups must have a unique name.
Describes the desired kernel arguments.
Describes the desired boot device configuration. At least one of luks or mirror must be specified.
3 nested properties
The disk layout of the target OS image. Supported values are aarch64, ppc64le, s390x-eckd, s390x-virt, s390x-zfcp, and x86_64. Defaults to x86_64.
Describes the clevis configuration for encrypting the root filesystem.
6 nested properties
The whole-disk device (not partitions), referenced by their absolute path. Must start with /dev/dasd for s390x-eckd layout or /dev/sd for s390x-zfcp layouts.
Describes a tang server. Every server must have a unique url.
Whether or not to use a tpm2 device.
Sets the minimum number of pieces required to decrypt the device. Default is 1.
Whether to issue discard commands to the underlying block device when blocks are freed. Enabling this improves performance and device longevity on SSDs and space utilization on thinly provisioned SAN devices, but leaks information about which disk blocks contain data. If omitted, it defaults to false.
Describes the IBM Crypto Express (CEX) card configuration for the luks device.
1 nested properties
Whether or not to enable cex compatibility for luks. If omitted, defaults to false.
Describes mirroring of the boot disk for fault tolerance.
1 nested properties
Describes the desired GRUB bootloader configuration.
1 nested properties
The list of GRUB superusers.
Definitions
The type of compression used on the file (null or gzip). Compression cannot be used with S3.
A list of HTTP headers to be added to the request. Available for http and https source schemes only.
Options related to the verification
1 nested properties
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.
The contents. Mutually exclusive with source and local.
A local path to the contents, relative to the directory specified by the --files-dir command-line argument. Mutually exclusive with source and inline.
Options related to the verification
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.
A list of HTTP headers to be added to the request. Available for http and https source schemes only.
Describes a tang server. Every server must have a unique url.