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

Kubernetes Hardening Guide Section on Authentication Mechanisms #42486

Merged
merged 5 commits into from
Sep 18, 2023
Merged

Kubernetes Hardening Guide Section on Authentication Mechanisms #42486

merged 5 commits into from
Sep 18, 2023

Conversation

raesene
Copy link
Contributor

@raesene raesene commented Aug 10, 2023

This is the first section for the Kubernetes hardening guide which has been under discussion in SIG-Security-Docs kubernetes/sig-security#30 .

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 10, 2023
@k8s-ci-robot k8s-ci-robot requested a review from reylejano August 10, 2023 12:41
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Aug 10, 2023
@k8s-ci-robot k8s-ci-robot requested a review from sftim August 10, 2023 12:41
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 10, 2023
@netlify
Copy link

netlify bot commented Aug 10, 2023

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 8ed2edd
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/64eb09d80df09c00088fe78c
😎 Deploy Preview https://deploy-preview-42486--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.

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

Really liked it, very clear and concise. I agree with sftim's comments, just not sure we need to go into TLS version recommendation details.

/lgtm

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

LGTM label has been added.

Git tree hash: 42c9696677089bab7462e74397a8f079f4d1b858

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2023
@k8s-ci-robot k8s-ci-robot requested a review from mtardy August 19, 2023 14:37
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 19, 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.

/lgtm

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

LGTM label has been added.

Git tree hash: 0dbe68c46082213a48080b88630c24d4fbc692e7

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2023
@k8s-ci-robot k8s-ci-robot requested a review from sftim August 19, 2023 17:28
@@ -0,0 +1,143 @@
---
title: Hardening Guide - Authentication Mechanisms
Copy link
Contributor

Choose a reason for hiding this comment

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

This page doesn't taste like a concept page.
Maybe it should be a reference page?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not a reference either. Actual guides really belong in the tasks section. I think that'd be a good home

We could invent a new content_type: guide. If that feels useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, I'm not hugely attached to where this ends up, what I would say is that it's a slightly funny one. The content in tasks feels quite hands-on (i.e. specific commands that are being run) where this is higher level.

Not to say we couldn't put it in tasks, but it's not a 100% fit there, compared to other content in that section. That said, I'd agree isn't not 100% concept either :)

Copy link
Member

Choose a reason for hiding this comment

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

Since tasks are for "contains pages that show how to do individual tasks", I don't feel this hardening guide on auth mechanisms belong there unless we extend the scope of the tasks section to include a new content_type of guide

Good practices for Kubernetes Secrets
and Role Based Access Control Good Practices are under concepts. I would consider these as guides as well.

There is a Best Practices section, https://kubernetes.io/docs/setup/best-practices/. Is a hardening guide (& other guides) a good fit for the Best Practices section -- I'm leaning towards yes but I can also see this not under best practices.

@sftim
Copy link
Contributor

sftim commented Sep 7, 2023

Following up #42486 (comment)

If we want to make a new section for, eg good-practice or guidance or suchlike, that works for me.

If we do decide to do that, I'm OK to plan for it but also find an interim home for this PR's changes to land, and then refactor. We could add a note for localizers to make the situation clear.

configured authentication source.

For production clusters with multiple users directly accessing the Kubernetes API, it is
recommended to use external authentication sources such as OIDC. The internal authentication
Copy link
Contributor

Choose a reason for hiding this comment

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

OpenID Connect (OIDC)

@kbhawkey
Copy link
Contributor

/lgtm

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

LGTM label has been added.

Git tree hash: 0b978a37273f6f9e1855c68470b5645ea9241134

@reylejano
Copy link
Member

I'm good to have this land under concepts for now. Like Tim mentioned earlier, if we make a new section for guides or good-practice we can refactor and move the current good-practice and guide pages lter
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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 Sep 18, 2023
@k8s-ci-robot k8s-ci-robot merged commit 430dad2 into kubernetes:main Sep 18, 2023
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. 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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants