Skip to content

docs: Add docs for kernelType #1409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
openshift-merge-robot merged 1 commit into from
Jan 27, 2020
Merged

docs: Add docs for kernelType #1409

openshift-merge-robot merged 1 commit into from
Jan 27, 2020

Conversation

@sinnykumari
Copy link
Contributor

@sinnykumari sinnykumari commented Jan 27, 2020

No description provided.

@openshift-ci-robot openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 27, 2020
@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 27, 2020
yuqi-zhang
yuqi-zhang reviewed Jan 27, 2020
View reviewed changes
Copy link
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.

One minor nit, otherwise LGTM

docs/MachineConfiguration.md Outdated
Copy link
Contributor

@yuqi-zhang yuqi-zhang Jan 27, 2020

Choose a reason for hiding this comment

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

You refer to RT as "Real Time", "realtime" and "real-time" throughout this section, should probably make it consistent.

Copy link
Contributor Author

@sinnykumari sinnykumari Jan 27, 2020

Choose a reason for hiding this comment

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

It gives a feeling that I am not writing same word again and again ;)
Fixed!

@sinnykumari
docs: Add docs for kernelType
2d84e41 
Signed-off-by: Sinny Kumari <[email protected]>
@yuqi-zhang
Copy link
Contributor

yuqi-zhang commented Jan 27, 2020

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 27, 2020
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 27, 2020

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sinnykumari, 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:
  • OWNERS [sinnykumari,yuqi-zhang]

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

@sinnykumari
Copy link
Contributor Author

sinnykumari commented Jan 27, 2020

Doc PR shouldn't impact failing tests. skipping

/skip

@sinnykumari
Copy link
Contributor Author

sinnykumari commented Jan 27, 2020

/skip e2e-gcp-upgrade

@openshift-bot
Copy link
Contributor

openshift-bot commented Jan 27, 2020

/retest

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

@kikisdeliveryservice
Copy link
Contributor

kikisdeliveryservice commented Jan 27, 2020

/override ci/prow/e2e-gcp-upgrade

@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 27, 2020

@kikisdeliveryservice: Overrode contexts on behalf of kikisdeliveryservice: ci/prow/e2e-gcp-upgrade

Details

In response to this:

/override ci/prow/e2e-gcp-upgrade

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-merge-robot openshift-merge-robot merged commit 9dec16a into openshift:master Jan 27, 2020
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 27, 2020

@sinnykumari: The following tests failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
ci/prow/e2e-gcp-upgrade 2d84e41 link /test e2e-gcp-upgrade
ci/prow/e2e-aws-scaleup-rhel7 2d84e41 link /test e2e-aws-scaleup-rhel7

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

wking added a commit to wking/machine-config-operator that referenced this pull request Jul 5, 2022
@wking
pkg/controller/common/helpers: Explicitly set mode 0644
f6adfbb 
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-cherrypick-robot pushed a commit to openshift-cherrypick-robot/machine-config-operator that referenced this pull request Jul 6, 2022
@wking
pkg/controller/common/helpers: Explicitly set mode 0644
f4ef33d 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yuqi-zhang yuqi-zhang yuqi-zhang left review comments

@ericavonb ericavonb Awaiting requested review from ericavonb

Assignees

@yuqi-zhang yuqi-zhang

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. retest-not-required-docs-only size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@sinnykumari @yuqi-zhang @openshift-ci-robot @openshift-bot @kikisdeliveryservice @openshift-merge-robot