Skip to content
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.

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

COS-2831: troubleshooting/operating-system: document kdump support over NFS #78300

Merged

Conversation

jbtrystram
Copy link
Contributor

@jbtrystram jbtrystram commented Jul 1, 2024

On RHCOS, the nfs module is explicitly excluded from the initramfs: https://github.com/coreos/fedora-coreos-config/blob/de0416b8820cffa2ea3b7dbd9e95a9cc0ad9a42b/overlay.d/05core/usr/lib/dracut/dracut.conf.d/coreos-omits.conf#L7 Thus, setting an NFS target destination in kdump.conf will not work because the kdump initramfs will not have the NFS module. Add instruction on how to add the module to enable the functionality.

This may not be necessary if kdump auto-detect the required modules: See rhkdump/kdump-utils#11

Version(s):
All versions that ship kdump, so 4.11 and above releases

Issue:
https://issues.redhat.com/browse/OCPBUGS-31755

Link to docs preview:
https://78300--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-operating-system-issues.html#enabling-kdump-day-one

QE review:

  • QE has approved this change.

@openshift-ci-robot openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jul 1, 2024
@openshift-ci-robot
Copy link

@jbtrystram: This pull request references Jira Issue OCPBUGS-31755, which is invalid:

  • expected the bug to target the "4.17.0" version, but no target version was set

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

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

On RHCOS, the nfs module is explicitly excluded from the initramfs: https://github.com/coreos/fedora-coreos-config/blob/de0416b8820cffa2ea3b7dbd9e95a9cc0ad9a42b/overlay.d/05core/usr/lib/dracut/dracut.conf.d/coreos-omits.conf#L7 Thus, setting an NFS target destination in kdump.conf will not work because the kdump initramfs will not have the NFS module. Add instruction on how to add the module to enable the functionality.

This may not be necessary if kdump auto-detect the required modules: See rhkdump/kdump-utils#11

Version(s):
All versions that ship kdump, so 4.11 and above releases

Issue:
https://issues.redhat.com/browse/OCPBUGS-31755

Link to docs preview:

QE review:

  • QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 1, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jul 1, 2024

@jbtrystram
Copy link
Contributor Author

/jira refresh

@openshift-ci-robot
Copy link

@jbtrystram: This pull request references Jira Issue OCPBUGS-31755, which is invalid:

  • expected the bug to target the "4.17.0" version, but no target version was set

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

In response to this:

/jira 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 openshift-eng/jira-lifecycle-plugin repository.

Copy link
Contributor

@jldohmann jldohmann left a comment

Choose a reason for hiding this comment

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

thanks for opening this Jean-Baptiste! 😄 just some minor comments before we can publish

modules/troubleshooting-enabling-kdump-day-one.adoc Outdated Show resolved Hide resolved
modules/troubleshooting-enabling-kdump-day-one.adoc Outdated Show resolved Hide resolved
@jldohmann jldohmann added peer-review-done Signifies that the peer review team has reviewed this PR branch/enterprise-4.17 and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jul 3, 2024
@jldohmann
Copy link
Contributor

@mike-nguyen can you PTAL for QE ack for this docs PR? thank you!

@jbtrystram jbtrystram force-pushed the pr/troubleshooting-nfs-add-kmod branch from 7667afe to 834ae65 Compare July 4, 2024 09:30
@jbtrystram
Copy link
Contributor Author

thanks for opening this Jean-Baptiste! 😄 just some minor comments before we can publish

Thanks for the review ! I updated with your comments

@jbtrystram jbtrystram changed the title OCPBUGS-31755: troubleshooting/operating-system: document kdump support over NFS COS-2831: troubleshooting/operating-system: document kdump support over NFS Jul 11, 2024
@openshift-ci-robot openshift-ci-robot removed the jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. label Jul 11, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 11, 2024

@jbtrystram: This pull request references COS-2831 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

On RHCOS, the nfs module is explicitly excluded from the initramfs: https://github.com/coreos/fedora-coreos-config/blob/de0416b8820cffa2ea3b7dbd9e95a9cc0ad9a42b/overlay.d/05core/usr/lib/dracut/dracut.conf.d/coreos-omits.conf#L7 Thus, setting an NFS target destination in kdump.conf will not work because the kdump initramfs will not have the NFS module. Add instruction on how to add the module to enable the functionality.

This may not be necessary if kdump auto-detect the required modules: See rhkdump/kdump-utils#11

Version(s):
All versions that ship kdump, so 4.11 and above releases

Issue:
https://issues.redhat.com/browse/OCPBUGS-31755

Link to docs preview:
https://78300--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-operating-system-issues.html#enabling-kdump-day-one

QE review:

  • QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

Copy link
Member

@mike-nguyen mike-nguyen left a comment

Choose a reason for hiding this comment

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

Overall content looks good to me. Just some minor nits.

modules/troubleshooting-enabling-kdump-day-one.adoc Outdated Show resolved Hide resolved
@jbtrystram jbtrystram force-pushed the pr/troubleshooting-nfs-add-kmod branch from 834ae65 to 5656434 Compare July 17, 2024 08:01
[NOTE]
====
To export the dumps to NFS targets, the `nfs` kernel module must be explicitly added to the configuration file:
+
Copy link
Contributor

Choose a reason for hiding this comment

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

this + doesn't seem to be rendering correctly in the preview...i guess being in the admonition is making it behave weird. since we don't need to chain it to a particular step, it won't hurt anything if it's removed, so let's go ahead and do that. @jbtrystram could you remove it?

On RHCOS, the nfs module is explicitly excluded from the initramfs:
https://github.com/coreos/fedora-coreos-config/blob/de0416b8820cffa2ea3b7dbd9e95a9cc0ad9a42b/overlay.d/05core/usr/lib/dracut/dracut.conf.d/coreos-omits.conf#L7
Thus, setting an NFS target destination in kdump.conf will not work
because the kdump initramfs will not have the NFS module. Add
instruction on how to add the module to enable the functionality.

This may not be necessary if kdump auto-detect the required modules:
See rhkdump/kdump-utils#11

Co-authored-by: Jesse Dohmann <[email protected]>
@jbtrystram jbtrystram force-pushed the pr/troubleshooting-nfs-add-kmod branch from 5656434 to 89a77ac Compare July 17, 2024 16:11
Copy link

openshift-ci bot commented Jul 17, 2024

@jbtrystram: 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-sigs/prow repository. I understand the commands that are listed here.

@jldohmann jldohmann merged commit 0d0d69f into openshift:main Jul 17, 2024
3 checks passed
@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.17

@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.16

@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.15

@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.14

@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.13

@jldohmann
Copy link
Contributor

/cherrypick enterprise-4.12

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79014

In response to this:

/cherrypick enterprise-4.17

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-sigs/prow repository.

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79015

In response to this:

/cherrypick enterprise-4.16

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-sigs/prow repository.

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79016

In response to this:

/cherrypick enterprise-4.15

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-sigs/prow repository.

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79017

In response to this:

/cherrypick enterprise-4.14

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-sigs/prow repository.

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79018

In response to this:

/cherrypick enterprise-4.13

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-sigs/prow repository.

@openshift-cherrypick-robot

@jldohmann: new pull request created: #79019

In response to this:

/cherrypick enterprise-4.12

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-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants