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

Update hardening Kubernetes clusters URL in website to the latest version 1.2 #44031

Merged
merged 10 commits into from
Dec 27, 2023
Merged

Conversation

seifrajhi
Copy link
Member

NSA and CISA released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1). The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.

NSA and CISA released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1). The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/blog Issues or PRs related to the Kubernetes Blog subproject labels Nov 22, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 22, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @seifrajhi!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 22, 2023
Copy link

netlify bot commented Nov 22, 2023

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit b5a8275
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6568fe7b7638490008ac00cf
😎 Deploy Preview https://deploy-preview-44031--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim
sftim previously requested changes Nov 22, 2023
Copy link
Contributor

@sftim sftim 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 spotting that there's an update available.

The change doesn't make sense: the background to this article only includes things that had happened prior to publication. It will jar with readers if the article appears to have been written taking into account guidance published a year later.

You could reframe the change as an aside to the article text. Please check in with the 3 article authors to make sure they're happy with the proposed change.

@seifrajhi
Copy link
Member Author

It will jar with readers if the article appears to have been written taking into account guidance published a year later.

The current link in this blog gives 404 error, so it should be changed or removed imo.

You could reframe the change as an aside to the article text.

I will do that 👍 , it's a better approach.

Please check in with the 3 article authors to make sure they're happy with the proposed change.

I will try to contact them, to ask them if they are ok with my changes.

@PushkarJ
Copy link
Member

This blog was actually one of the inputs taken as feedback to v1.0 and then the newer published version of hardening guide added the blog as a reference.

Adding a line at the top as a markdown "note" mentioning that and then linking the v1.1 version as part of it would make more sense to avoid circular referencing :)

Thank you @seifrajhi for spotting this and opening a PR to fix it.

@seifrajhi
Copy link
Member Author

Hey @PushkarJ ,

thank you for the prompt feedback !!

That's exactly what I did, I added a note saying that there are newer versions v1.1 and v1.2 and I updated the PDF link to the latest version v1.2 ( v1.0 is not accessible anymore on the current link used in the blog )

Comment on lines 32 to 35
> The National Security Agency (NSA) and the Cybersecurity and Infrastructure Security Agency (CISA) released
> the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1).
> The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.
> Version 1.2 outlines a number of recommendations for (hardening Kubernetes clusters)[https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF].
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, but: please don't mark this as a quote (it's not a quote). Try using italics instead; for example:

**Update, November 2023**  
_The National Security Agency (NSA) and the Cybersecurity and Infrastructure Security Agency (CISA)_
_released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on_
_industry feedback in March 2022 (version 1.1)._  
_The most recent version of the Kubernetes hardening guidance was released in August 2022_
_with corrections and clarifications._  
_Version 1.2 outlines a number of recommendations for_
[_hardening Kubernetes clusters_](https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF]. 

ℹ️ The trailing whitespace is intentional and significant.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changes are made per suggestion @sftim

Copy link
Member Author

Choose a reason for hiding this comment

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

Hello, any other changes to be made ?

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 22, 2023
@PushkarJ
Copy link
Member

I am okay with these new changes with a note.

Tagging the remaining authors for review

/cc @jimangel @savitharaghunathan

@savitharaghunathan
Copy link
Member

I am fine with the changes but will defer accepting this PR to sig-docs leads. IIRC, there used to be a policy on not updating blogposts. I am not sure if there are exceptions. Tagging co-chairs and apologies in advance for spamming.
cc: @divya-mohan0209 @reylejano @natalisucks

@seifrajhi seifrajhi requested a review from sftim November 27, 2023 20:04
@divya-mohan0209
Copy link
Contributor

@seifrajhi The update seems to have been formatted incorrectly in the deploy preview. Could you please advise if this was intentional? If not, please could you fix it at the earliest possible?

@seifrajhi
Copy link
Member Author

Hey @divya-mohan0209,

Yes it was intentional, Tim advised me to use this format and to use the italic font in this comment

Comment on lines 33 to 39
_The National Security Agency (NSA) and the Cybersecurity and Infrastructure Security Agency (CISA)_
_released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on_
_industry feedback in March 2022 (version 1.1)._
_The most recent version of the Kubernetes hardening guidance was released in August 2022_
_with corrections and clarifications._
_Version 1.2 outlines a number of recommendations for_
[_hardening Kubernetes clusters_](https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF).
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, I didn't expect this to wrap like it has. Please amend so it renders as a paragraph.

Copy link
Member Author

Choose a reason for hiding this comment

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

ok I change it to paragraph without italic font

@sftim
Copy link
Contributor

sftim commented Nov 30, 2023

Please put back the emphasis - even if that means making it all one line, or something. It's useful to highlight that this is an aside to the main article.

@sftim
Copy link
Contributor

sftim commented Nov 30, 2023

You could use a pageinfo - does that work?

@divya-mohan0209
Copy link
Contributor

Fwiw: The comment was not on the emphasis but the actual rendering of the text that was added. It wasn't wrapped correctly and my question to @seifrajhi was regarding that. I can see how that wasn't clear in my previous statement and I apologize.

@seifrajhi
Copy link
Member Author

@sftim, I used a pageinfo in the latest commit, it looks better in my opinion

waiting for your feedback

@seifrajhi seifrajhi requested a review from sftim December 4, 2023 10:23
@sftim
Copy link
Contributor

sftim commented Dec 27, 2023

/sig security
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added sig/security Categorizes an issue or PR as relevant to SIG Security. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. labels Dec 27, 2023
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks

/lgtm
/approve


The National Security Agency (NSA) and the Cybersecurity and Infrastructure Security Agency (CISA) released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1).

The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications. Version 1.2 outlines a number of recommendations for [hardening Kubernetes clusters](https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF).
Copy link
Contributor

Choose a reason for hiding this comment

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

Even better, IMO:

Suggested change
The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications. Version 1.2 outlines a number of recommendations for [hardening Kubernetes clusters](https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF).
A more recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications. Version 1.2 outlines a number of recommendations for [hardening Kubernetes clusters](https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF).

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 27, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: f76d311b6346c202a74b6a6b5c32bbd9fc21cd6b

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 27, 2023
@k8s-ci-robot k8s-ci-robot merged commit 8aecf06 into kubernetes:main Dec 27, 2023
6 checks passed
adityasamant25 pushed a commit to adityasamant25/website that referenced this pull request Dec 29, 2023
…sion 1.2 (kubernetes#44031)

* Update 2021-10-05-nsa-cisa-hardening.md

NSA and CISA released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1). The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.

* Add the changes as an aside to the article text

* Update formatting per suggestion

* make changes in font

* update formatting

* more changes in formatting

* more changes in formatting

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md
lbzss pushed a commit to lbzss/website that referenced this pull request Dec 29, 2023
…sion 1.2 (kubernetes#44031)

* Update 2021-10-05-nsa-cisa-hardening.md

NSA and CISA released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1). The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.

* Add the changes as an aside to the article text

* Update formatting per suggestion

* make changes in font

* update formatting

* more changes in formatting

* more changes in formatting

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md
aoki-taquan pushed a commit to aoki-taquan/website that referenced this pull request Jan 26, 2024
…sion 1.2 (kubernetes#44031)

* Update 2021-10-05-nsa-cisa-hardening.md

NSA and CISA released the 1.0 version of the Kubernetes hardening guide in August 2021 and updated it based on industry feedback in March 2022 (version 1.1). The most recent version of the Kubernetes hardening guidance was released in August 2022 with corrections and clarifications.

* Add the changes as an aside to the article text

* Update formatting per suggestion

* make changes in font

* update formatting

* more changes in formatting

* more changes in formatting

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md

* Update 2021-10-05-nsa-cisa-hardening.md
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. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/security Categorizes an issue or PR as relevant to SIG Security. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants