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

docs: fix kernel lockdown documentation #1704

Merged

Conversation

arnaldo2792
Copy link
Contributor

Issue number:
N/A

Description of changes:

1c0f4d2d docs: fix kernel lockdown documentation

This fixes the kernel lockdown's documentation, since the default values changed in newer variants.

Testing done:
Documentation change, no testing required (other than just verify the render).

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

README.md Outdated
@@ -476,7 +476,7 @@ Here are the metrics settings:
#### Kernel settings

* `settings.kernel.lockdown`: This allows further restrictions on what the Linux kernel will allow, for example preventing the loading of unsigned modules.
May be set to "none" (the default), "integrity", or "confidentiality".
May be set to "none" (the default in older [variants](variants/)), "integrity" (the default for newer [variants](variants/)), or "confidentiality".
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we list the specific variants? Or perhaps just list the variants which are still defaulting to "none"?

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
May be set to "none" (the default in older [variants](variants/)), "integrity" (the default for newer [variants](variants/)), or "confidentiality".
May be set to "none" (the default in older [variants](variants/), up through aws-k8s-1.19), "integrity" (the default for newer variants), or "confidentiality".

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we make the same change the SECURITY-GUIDANCE.md doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I'll update the Security Guidance with your suggestion 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated both the README and SECURITY-GUIDANCE doc

This fixes the kernel lockdown's documentation, since the default values
changed in newer variants

Signed-off-by: Arnaldo Garcia Rincon <agarrcia@amazon.com>
@arnaldo2792 arnaldo2792 force-pushed the fix-kernel-lockdown-docs branch from 1c0f4d2 to e90380e Compare August 11, 2021 17:37
@arnaldo2792
Copy link
Contributor Author

Forced push includes:

  • Rebase
  • Added suggestions to both the README.md and SECURITY_GUIDANCE.md docs

@arnaldo2792 arnaldo2792 requested a review from samuelkarp August 11, 2021 20:30
@arnaldo2792 arnaldo2792 merged commit 12c7b70 into bottlerocket-os:develop Aug 12, 2021
@arnaldo2792 arnaldo2792 deleted the fix-kernel-lockdown-docs branch August 12, 2021 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants