Butane merge v2 by prestist · Pull Request #2235 · coreos/ignition

prestist · 2026-06-11T13:13:45Z

The implementation is broken into six commits; reproducible via a shell script (https://gist.github.com/prestist/c3bfc2f3e2050b2d63a2ebb0f64bd066):

History-preserving merge: Butane files are first moved into a butane/ subdirectory in a prep branch, then merged into Ignition via git merge --allow-unrelated-histories. This preserves full git history so git blame and git log --follow work correctly for all butane/ files.
Cleanup: Butane's repo-level files are removed (go.mod, go.sum, vendor/, .github/, .copr/, linter configs) since these are now handled by Ignition's equivalents.
Import path rewrite: All Go imports across ~150 files are rewritten from github.com/coreos/butane/ to github.com/coreos/ignition/v2/butane/ to work under Ignition's single Go module. Butane's unique dependencies (clarketm/json, go-systemd v22.7.0) are added to go.mod. A license header typo in Butane files is also fixed.
Re-vendor: A single unified vendor/ directory replaces the two separate ones.
config.Parse() integration: Ignition's config.Parse() function -- the single entry point used by all 30+ cloud providers, ignition-validate, ignition-apply, and referenced/merged configs -- is modified to try Ignition JSON first, then fall back to Butane YAML transpilation via butane/config.TranslateBytes(). On both failures, the original Ignition error is returned for backward compatibility. Unit tests cover JSON parsing, Butane YAML parsing (with and without content), invalid input, and source: local failure. The deprecated unit.Deserialize call is updated to unit.DeserializeOptions for the go-systemd v22.7.0 bump.
Build and CI updates: The top-level ./build script sources butane/build to produce the butane binary and restores CGO_ENABLED=1 afterward (Butane sets it to 0, but Ignition requires cgo for libblkid). butane/build is updated to use the new module path. The ./test script adds butane/ to license header checks. The Makefile installs the butane binary. Eight errcheck lint issues in Butane code are fixed. Butane's TMT tests are removed to avoid conflicts with Ignition's TMT plan discovery.

Sync with coreos/repo-templates@d8980f4.

Sync repo templates ⚙

Sync with coreos/repo-templates@9066203.

Sync repo templates ⚙

- Use "layout" in the context path for errors related to the layout entry in the boot_device configuration. - Add tests for those error cases. - Refactor mirror boot_device check for s390x. Fixes: coreos/butane#484

For fcos 1.6.0-exp & openshift 4.18.0-exp specs, expected to be based on stable 3.5.0 spec. See: coreos#1693 See: coreos/fedora-coreos-tracker#1708

add: Support LUKS encryption using IBM CEX secure keys on s390x

Sync with coreos/repo-templates@7f596dd.

Sync repo templates ⚙

see: coreos/fedora-coreos-tracker#1695

Ignition spec bump

Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.9.0 to 1.10.0. - [Release notes](https://github.com/stretchr/testify/releases) - [Commits](stretchr/testify@v1.9.0...v1.10.0) --- updated-dependencies: - dependency-name: github.com/stretchr/testify dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Stablize fcos v1_6, base v0_6, and bump all other exp to latest

Dockerfile: update to Fedora 41

Rewrite all internal Butane import paths from github.com/coreos/butane/ to github.com/coreos/ignition/v2/butane/ so that Butane's code is part of the single Ignition Go module. Add github.com/clarketm/json as a new dependency required by Butane, and bump go-systemd to v22.7.0. Also fix stray ')' in license headers across Butane files.

Teach Ignition's config parser to accept Butane YAML configs in addition to Ignition JSON. Parse() now tries Ignition JSON first and, on failure, attempts to transpile the input as a Butane config using the integrated butane/ library. This allows users to provide Butane configs directly to instances without a separate transpilation step. Key design decisions: - JSON is tried first for zero behavioral change on existing configs - On both failures, the original Ignition error is returned - source: local properly errors since FilesDir is unavailable at boot - OpenShift variant configs produce MachineConfig YAML which fails Ignition parsing, as those configs go through MCO Related: coreos/fedora-coreos-tracker#2006

- build: Source butane/build to produce butane binary, restore CGO_ENABLED=1 - butane/build: Use module path, accept VERSION from parent - test: Add butane/ to license header check paths - Makefile: Install butane binary to /usr/bin - config: Add unit tests for Butane YAML parsing - config: Use DeserializeOptions (go-systemd v22.7.0) - butane: Fix errcheck lint issues - butane: Remove TMT tests (conflict with ignition TMT discovery)

Remove Butane test cases that reference ErrZeroesWithShouldNotExist, a validation that was deliberately removed from Ignition in commit 76f869a (stages/disks: Allow deleting a partition while creating number 0). The validation was originally present in Ignition but was removed because partition numbers are now resolved to their final values, making the check unnecessary. Butane's vendored copy of Ignition still had this validation, but after merging into Ignition proper, the test cases reference the real errors package which no longer defines this constant.

Adapt the build script to match the subcommand format introduced in coreos#2239. The butane build is now a subcommand (./build butane) instead of being sourced from butane/build. Add butane and butane-cross targets to the Makefile, and add butane to the install target. Also fix the binary-size CI workflow to use make for both PR and base builds, since ./build now requires a subcommand argument.

prestist · 2026-07-29T17:36:13Z


 ### Changes

+- Merge Butane config transpiler into the Ignition repository; the `butane` CLI is now built from the Ignition source tree ([#2235](https://github.com/coreos/ignition/pull/2235))


CI is not seeing this change, overriding it for this PR. I think its not able to handle this many commits.

PeaceRebel · 2026-07-30T09:49:19Z

LGTM

Rolv-Apneseth · 2026-07-31T18:05:22Z

Do we still need butane/build or should that file be deleted?

Otherwise it LGTM. I don't love the "On both failures, the original Ignition error is returned", but I should have brought that up for discussion during the change proposal.

Remove butane/build since the butane binary is now built via the top-level ./build butane subcommand. Having two build paths for the same binary is confusing and the standalone script is no longer referenced by any CI, Makefile, or build pipeline.

prestist · 2026-08-10T14:58:11Z

Ah yes dead code, good catch @Rolv-Apneseth (removed). I think regarding the original ignition error being returned we can revisit that later. This is not frozen code if it becomes and issue.

Rolv-Apneseth

LGTM

The butane repository has been archived and merged into ignition (coreos/ignition#2235). Remove butane from all template metadata files so the sync workflow no longer attempts to open PRs against the archived repo.

…ase scripts Butane has been merged into the Ignition repository (coreos/ignition#2235). Update the signing-ticket template to support multiple signing targets so the ignition signing ticket handles both ignition-validate and butane redistributable RPMs in a single ticket. Remove butane from signing-ticket.yaml and tag_release.yaml since butane releases are now part of the ignition release process. Closes coreos/ignition#2254

ruuda · 2026-09-03T09:24:55Z

In https://github.com/coreos/ignition/blob/958b26570b0d54f463f87c7cf5ed8751eda7f703/butane/README.md, it now says “This repository has been archived”. That’s appropriate for the original location, but I suppose now that everything has been merged here, the readme needs to be updated.

coreosbot and others added 30 commits November 14, 2024 13:17

Sync repo templates ⚙

de67188

Sync with coreos/repo-templates@d8980f4.

Merge pull request coreos#553 from coreosbot-releng/repo-templates

2ca6b36

Sync repo templates ⚙

Sync repo templates ⚙

9f99012

Sync with coreos/repo-templates@9066203.

Merge pull request coreos#557 from coreosbot-releng/repo-templates

40fa2dd

Sync repo templates ⚙

fcos/1.6.0-exp: Fix context for boot_device.layout errors

6531c7f

- Use "layout" in the context path for errors related to the layout entry in the boot_device configuration. - Add tests for those error cases. - Refactor mirror boot_device check for s390x. Fixes: coreos/butane#484

vendor: Update ignition/v2 v2.19.0 & aws-sdk-go v1.53.5

50dff55

Support LUKS encryption using IBM CEX secure keys on s390x

5862ae0

For fcos 1.6.0-exp & openshift 4.18.0-exp specs, expected to be based on stable 3.5.0 spec. See: coreos#1693 See: coreos/fedora-coreos-tracker#1708

Merge pull request coreos#536 from madhu-pillai/test_cex

da4b8a1

add: Support LUKS encryption using IBM CEX secure keys on s390x

mod: revendor latest ignition, stabilize 3.5

e37ee9c

Sync repo templates ⚙

a6374ff

Sync with coreos/repo-templates@7f596dd.

Merge pull request coreos#561 from coreosbot-releng/repo-templates

6d5cf89

Sync repo templates ⚙

docs: run generate with new ignition import

72550e5

Dockerfile: update to Fedora 41

9a6a9d8

see: coreos/fedora-coreos-tracker#1695

Merge pull request coreos#562 from prestist/ignition-spec-bump

011bb0c

Ignition spec bump

base: copy v0_6_exp to v0_7_exp

66c2a31

base/v0_7_exp: update imports and package names

67d33f0

mod: re-vendor to bring in new v3_6_exp type

fba29d0

base/v0_6: stabilize v0_6_exp to v0_6

0d098ca

fcos: copy v1_6_exp to v1_7_exp

97194bc

fcos/v1_7_exp: update imports and package names

969d811

fcos/v1_6: stabilize v1_6_exp to v1_6

08d0764

fiot/v1_1_exp: update import to new base/v0_7_exp

65b9bff

flatcar/v1_2_exp: update import to new base/v0_7_exp

04d1887

r4e/v1_2_exp: update import to new base/v0_7_exp

95fb547

openshift/v4_18_exp: update import for fcos and base to latest

4cb7c67

docs/main: add new fcos/v1_7_exp spec to doc generation, and run it

f9142bc

docs: update documentation for stablized and updated configs

142bfeb

Merge pull request coreos#566 from prestist/stablize-fcos-base-ocp

83ce1eb

Stablize fcos v1_6, base v0_6, and bump all other exp to latest

Merge pull request coreos#565 from marmijo/marmijo-rebase-41

a982e39

Dockerfile: update to Fedora 41

prestist added 7 commits July 28, 2026 16:13

*: re-vendor after butane merge

233beb5

docs: add release notes for Butane merge

c54fb0e

prestist force-pushed the butane-merge-v2 branch from 468a47b to 23a388b Compare July 28, 2026 20:19

prestist commented Jul 29, 2026

View reviewed changes

prestist added the skip-notes This PR does not need release notes label Jul 29, 2026

prestist marked this pull request as ready for review July 29, 2026 17:36

PeaceRebel approved these changes Jul 30, 2026

View reviewed changes

angelcerveraroldan mentioned this pull request Aug 6, 2026

compression: gzip on inline/local contents is accepted without checking whether the contents are actually gzipped coreos/butane#730

Closed

butane: remove standalone build script

d3d3fc6

Remove butane/build since the butane binary is now built via the top-level ./build butane subcommand. Having two build paths for the same binary is confusing and the standalone script is no longer referenced by any CI, Makefile, or build pipeline.

Rolv-Apneseth approved these changes Aug 10, 2026

View reviewed changes

prestist merged commit cb94422 into coreos:main Aug 10, 2026
12 checks passed

This was referenced Aug 11, 2026

signing-ticket: merge butane binary signing into ignition release process #2254

Closed

go: merge butane signing into ignition release process coreos/repo-templates#370

Merged

This was referenced Aug 12, 2026

*: add butane container image build #2255

Closed

butane: update Dockerfile and build script for ignition repo #2256

Merged

Rolv-Apneseth mentioned this pull request Sep 3, 2026

butane/readme: update readme to reflect the merge being completed #2320

Merged

This was referenced Sep 16, 2026

install: accept Butane YAML configs via --ignition-file/--ignition-url coreos/coreos-installer#1769

Merged

install: accept Butane YAML configs directly via --ignition-file/--ignition-url coreos/coreos-installer#1770

Closed

Navigation Menu

Butane merge v2 - #2235

Butane merge v2#2235
prestist merged 1322 commits into
coreos:mainfrom
prestist:butane-merge-v2

prestist commented Jun 11, 2026 •

edited

Loading

Uh oh!

prestist Jul 29, 2026

Uh oh!

PeaceRebel commented Jul 30, 2026

Uh oh!

Rolv-Apneseth commented Jul 31, 2026

Uh oh!

prestist commented Aug 10, 2026

Uh oh!

Rolv-Apneseth left a comment

Uh oh!

Uh oh!

ruuda commented Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants


		### Changes

		- Merge Butane config transpiler into the Ignition repository; the `butane` CLI is now built from the Ignition source tree ([#2235](https://github.com/coreos/ignition/pull/2235))

Conversation

prestist commented Jun 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prestist Jul 29, 2026

Choose a reason for hiding this comment

Uh oh!

PeaceRebel commented Jul 30, 2026

Uh oh!

Rolv-Apneseth commented Jul 31, 2026

Uh oh!

prestist commented Aug 10, 2026

Uh oh!

Rolv-Apneseth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ruuda commented Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants

prestist commented Jun 11, 2026 •

edited

Loading