Move Ignition file generation to controller/common, fix Compression #3128

cgwalters · 2022-04-29T20:29:51Z

Basically, everywhere we make a "raw" Ignition file type, we need
to be explicitly setting the compression field. This is prep
for updating butane and using it for some of our templates, which
will start compressing files automatically.

The problem is Ignition config merging is a bit broken with respect
to an unset compression field. We need to make it the explicit
empty string.

Now, when I was digging into this I noticed that we'd ended up with
our API to make Ignition files in the test/helpers. We shouldn't
have core code importing APIs from test/.

This moves the APIs into controller/common.

Port the kubelet config and container runtime config bits to this -
notice how much the code shrinks!

pkg/controller/common/helpers_test.go

pkg/controller/common/helpers.go

mtrmac

(Just a quick look as someone not familiar with the problem space, going just by the diff and the problem description.)

ACK; apart from the bug fix, the consolidation of copy&pasted data is certainly a great improvement.

I wonder about the change to use dataurl.EncodeBytes. It does seem to me to be an improvement, or at worst immaterial, I’m just tempted to think that the people explicitly setting a MIME type and ASCII could have had a reason for doing so. Or… maybe not?

mtrmac · 2022-04-29T21:44:44Z

pkg/controller/common/helpers.go

+		},
+		FileEmbedded1: ign3types.FileEmbedded1{
+			Contents: ign3types.Resource{
+				Source:      StrToPtr(dataurl.EncodeBytes(contents)),


This is doing MIME type auto detection (notably using text/plain; charset=utf-8, or application/content-stream, while the old code was usually manually setting text/plain. Does that matter?

AFAICS this sets base64 data encoding to base64, but all existing data manually sets ASCII. Does that matter? It does seem to me that base64 is a better default (binary-safe and we don’t have to worry about special cases).

Well, hmm...actually it does mean that these files will start appearing as base64 inside MachineConfig, which will mean people need to base64 decode them manually if relevant.

It will also be a "spurious" change on upgrades, e.g. the machineconfig hash will be different, but the physical files will not.

I am not sure if either of these really matter though.

pkg/controller/common/helpers.go

cgwalters · 2022-05-02T15:53:37Z

I wonder about the change to use dataurl.EncodeBytes. It does seem to me to be an improvement, or at worst immaterial, I’m just tempted to think that the people explicitly setting a MIME type and ASCII could have had a reason for doing so. Or… maybe not?

This is only interpreted by Ignition, which ends up calling
https://github.com/coreos/ignition/blob/646538087cdcf5e4980c663ecda4327cafaeca3e/internal/resource/url.go#L334
which as best I can tell, just parses the type out and exposes it via ContentType() which Ignition ignores.

cgwalters · 2022-05-02T16:43:00Z

Thanks for the thoughtful review! Addressed all comments. The e2e test failure I think is just a flake, cc #3039

See coreos/butane#332 (comment) Basically, everywhere we make a "raw" Ignition file type, we need to be explicitly setting the compression field. This is prep for updating butane and using it for some of our templates, which will start compressing files automatically. The problem is Ignition config merging is a bit broken with respect to an unset compression field. We need to make it the explicit empty string. Now, when I was digging into this I noticed that we'd ended up with our API to make Ignition files in the `test/helpers`. We shouldn't have *core* code importing APIs from `test/`. This moves the APIs into `controller/common`. Port the kubelet config and container runtime config bits to this - notice how much the code shrinks!

mtrmac · 2022-05-02T17:19:18Z

/lgtm

(The data: URL encoding change looks fine to me, but I’ll defer to actual knowledgeable maintainers.)

openshift-ci · 2022-05-02T17:19:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cgwalters, mtrmac

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [cgwalters]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-bot · 2022-05-02T20:13:28Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-05-02T20:37:33Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-05-02T22:50:15Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-ci · 2022-05-03T03:26:17Z

@cgwalters: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

cgwalters · 2022-05-03T21:16:08Z

Today's offhand thought: when we can hard switch to layering, the role of Ignition in the MCO will shrink...perhaps to nearly nil. If we can move everything we need to bootstrap into the pointer config, the MCS goes away. How we generate the content that goes into our images becomes very flexible - the stock templates don't have to be Ignition or butane or whatever necessarily, etc.

When da5184f (Move Ignition file generation to controller/common, fix Compression, 2022-04-29, openshift#3128) created the NewIgnFileBytes* helpers, the call-sites which had previously explicitly set file modes began leaving them unset. Updating from 4.10 to 4.11 and picking up da5184f, clusters which include ContainerRuntimeConfig (or possibly KubeletConfig) which flow through the NewIgnFileBytes* helpers would have rendered MachineConfig entries with null/unset mode values. While this is not a problem for Ignition v3 clients, where there is an explicit 0644 default: $ git clone --depth 1 --branch main https://github.com/coreos/ignition.git $ cd ignition $ git --no-pager log --oneline -1 7652b83 (grafted, HEAD -> main, origin/main, origin/HEAD) Merge pull request openshift#1409 from bgilbert/notes $ git --no-pager grep '_mode_.*file' docs docs/configuration-v3_0.md: * **_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.source` is unspecified, and a file already exists at the path. docs/configuration-v3_1.md: * **_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.source` is unspecified, and a file already exists at the path. docs/configuration-v3_2.md: * **_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.source` is unspecified, and a file already exists at the path. docs/configuration-v3_3.md: * **_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.source` is unspecified, and a file already exists at the path. docs/configuration-v3_4_experimental.md: * **_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 supported. If not specified, the permission mode for files defaults to 0644 or the existing file's permissions if `overwrite` is false, `contents.source` is unspecified, and a file already exists at the path. it is a problem for Ignition v2 clients, where there is no such default: $ git clone --depth 1 --branch spec2x https://github.com/coreos/ignition.git $ cd ignition $ git --no-pager log --oneline -1 4db553d (grafted, HEAD -> spec2x, origin/spec2x) Merge pull request openshift#1067 from bgilbert/spec2y $ git --no-pager grep '_mode_.*file' doc doc/configuration-v2_0.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). doc/configuration-v2_1.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). doc/configuration-v2_2.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). doc/configuration-v2_3.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). doc/configuration-v2_4.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). doc/configuration-v2_5-experimental.md: * **_mode_** (integer): the file's permission mode. Note that the mode must be properly specified as a **decimal** value (i.e. 0644 -> 420). There is also no in-cluster component responsible for updating boot image configuration, or even complaining about stale boot image configuration, in Machines or MachineSets. This causes problems when 4.10 clusters with older boot images (at least older than 4.6 [1], I haven't pinned down a specific version): 1. Cluster updates to 4.11. 2. Incoming machine-config operator renders fresh MachineConfig from any ContainerRuntimeConfig or KubeletConfig. 3. Those rendered MachineConfig contain null/unset modes. 4. A new Machine is created with the old Ignition v2 boot image. 5. The boot image Ignition lays down a file with mode 0, because Ignition v2 does not define a default mode. 6. The boot image pivots into the modern machine-os-content image. 7. The incoming (modern) machine-config daemon notices the mode 0 file, compares it with its Ignition-v3-like 0644 default mode, and complains with [2]: unexpected on-disk state validating against rendered-worker-44f2c74623e4d3bbe9557a9e82102c01: mode mismatch for file: "/etc/crio/crio.conf.d/01-ctrcfg-pidsLimit"; expected: -rw-r--r--/420/0644; received: ----------/0/0 Folks should probably update to more modern boot images, but this commit restores the explicit mode to avoid breaking on this mode-mismatch issue for folks who are still running Ignition v2 boot images. [1]: https://bugzilla.redhat.com/show_bug.cgi?id=2102004#c28 [2]: https://bugzilla.redhat.com/show_bug.cgi?id=2102004#c0

openshift-ci bot requested review from mtrmac and yuqi-zhang April 29, 2022 20:30

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 29, 2022

This was referenced Apr 29, 2022

Pull layering/ changes to go modules #3126

Closed

Automatically-compressed resources interact badly with config merging coreos/butane#332

Closed

cgwalters force-pushed the helper-ign-file-with-compression branch from 79a0d9c to b2eb20c Compare April 29, 2022 20:41

cgwalters commented Apr 29, 2022

View reviewed changes

pkg/controller/common/helpers_test.go Show resolved Hide resolved

cgwalters commented Apr 29, 2022

View reviewed changes

pkg/controller/common/helpers.go Outdated Show resolved Hide resolved

mtrmac reviewed Apr 29, 2022

View reviewed changes

cgwalters force-pushed the helper-ign-file-with-compression branch from b2eb20c to fc3bff9 Compare May 2, 2022 16:39

cgwalters force-pushed the helper-ign-file-with-compression branch from fc3bff9 to da5184f Compare May 2, 2022 16:58

openshift-ci bot assigned mtrmac May 2, 2022

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 2, 2022

openshift-merge-robot merged commit eff34a5 into openshift:master May 3, 2022

wking mentioned this pull request Jul 5, 2022

Bug 2102004: pkg/controller/common/helpers: Explicitly set mode 0644 #3226

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move Ignition file generation to controller/common, fix Compression #3128

Move Ignition file generation to controller/common, fix Compression #3128

cgwalters commented Apr 29, 2022

mtrmac left a comment

mtrmac Apr 29, 2022

cgwalters May 2, 2022

cgwalters May 2, 2022

cgwalters commented May 2, 2022

cgwalters commented May 2, 2022

mtrmac commented May 2, 2022

openshift-ci bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-ci bot commented May 3, 2022

cgwalters commented May 3, 2022

Move Ignition file generation to controller/common, fix Compression #3128

Move Ignition file generation to controller/common, fix Compression #3128

Conversation

cgwalters commented Apr 29, 2022

mtrmac left a comment

Choose a reason for hiding this comment

mtrmac Apr 29, 2022

Choose a reason for hiding this comment

cgwalters May 2, 2022

Choose a reason for hiding this comment

cgwalters May 2, 2022

Choose a reason for hiding this comment

cgwalters commented May 2, 2022

cgwalters commented May 2, 2022

mtrmac commented May 2, 2022

openshift-ci bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-bot commented May 2, 2022

openshift-ci bot commented May 3, 2022

cgwalters commented May 3, 2022