Skip to content

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

Merged
openshift-ci[bot] merged 1 commit intoopenshift:masterfrom
wking:restore-explicit-mode
Jul 6, 2022
Merged

Bug 2102004: pkg/controller/common/helpers: Explicitly set mode 0644#3226
openshift-ci[bot] merged 1 commit intoopenshift:masterfrom
wking:restore-explicit-mode

Conversation

@wking
Copy link
Copy Markdown
Member

@wking wking commented Jul 5, 2022

When da5184f (#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 #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 #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, 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:

     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.

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 openshift-ci Bot added bugzilla/severity-unspecified Referenced Bugzilla bug's severity is unspecified for the PR. bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Jul 5, 2022
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 5, 2022

@wking: This pull request references Bugzilla bug 2102004, which is invalid:

  • expected the bug to target the "4.12.0" release, but it targets "---" instead

Comment /bugzilla refresh to re-evaluate validity if changes to the Bugzilla bug are made, or edit the title of this pull request to link to a different bug.

Details

In response to this:

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

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.

@wking
Copy link
Copy Markdown
Member Author

wking commented Jul 5, 2022

/bugzilla refresh

@openshift-ci openshift-ci Bot added bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. and removed bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Jul 5, 2022
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 5, 2022

@wking: This pull request references Bugzilla bug 2102004, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.12.0) matches configured target release for branch (4.12.0)
  • bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @rioliu-rh

Details

In response to this:

/bugzilla refresh

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.

@openshift-ci openshift-ci Bot requested a review from rioliu-rh July 5, 2022 23:03
@wking
Copy link
Copy Markdown
Member Author

wking commented Jul 6, 2022

I couldn't figure out the MachineSet incantation to test this end-to-end against OCP 4.5 / Ignition v2 boot images, but this confirms the smaller "we are now explicitly setting mode in ContainerRuntimeConfig-to-MachineConfig conversion".

@wking
Copy link
Copy Markdown
Member Author

wking commented Jul 6, 2022

/bugzilla refresh

@openshift-ci openshift-ci Bot added bugzilla/severity-high Referenced Bugzilla bug's severity is high for the branch this PR is targeting. and removed bugzilla/severity-unspecified Referenced Bugzilla bug's severity is unspecified for the PR. labels Jul 6, 2022
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 6, 2022

@wking: This pull request references Bugzilla bug 2102004, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.12.0) matches configured target release for branch (4.12.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @rioliu-rh

Details

In response to this:

/bugzilla refresh

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.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 6, 2022

@wking: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

Copy link
Copy Markdown
Contributor

@yuqi-zhang yuqi-zhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice investigation! Thanks for the PR.

I think we should consider this a 4.11 release blocker and attempt to backport into 4.11.0 ASAP

@yuqi-zhang
Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 6, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wking, yuqi-zhang

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 6, 2022
@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 6, 2022
@openshift-ci openshift-ci Bot merged commit 5d54e09 into openshift:master Jul 6, 2022
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Jul 6, 2022

@wking: All pull requests linked via external trackers have merged:

Bugzilla bug 2102004 has been moved to the MODIFIED state.

Details

In response to this:

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

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.

@yuqi-zhang
Copy link
Copy Markdown
Contributor

/cherry-pick release-4.11

@openshift-cherrypick-robot
Copy link
Copy Markdown

@yuqi-zhang: new pull request created: #3232

Details

In response to this:

/cherry-pick release-4.11

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.

@cgwalters
Copy link
Copy Markdown
Member

cgwalters commented Jul 6, 2022

While I think this fix is correct, I also think a better fix would be changing the ignition spec 3 → spec 2 conversion logic to handle this instead. Then it'd apply everywhere, not even just in the MCO.

@yuqi-zhang
Copy link
Copy Markdown
Contributor

While I think this fix is correct, I also think a better fix would be changing the ignition spec 3 → spec 2 conversion logic to handle this instead. Then it'd apply everywhere, not even just in the MCO.

Agreed, let's do so as a follow up. Since this already merged, I'll go ahead and push through the backport to unblock upgrades with this file

@sinnykumari
Copy link
Copy Markdown
Contributor

Thanks Trevor for investigating and working on fix!

@wking wking deleted the restore-explicit-mode branch July 6, 2022 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-high Referenced Bugzilla bug's severity is high for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants