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.

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

Add docs for Authorization Configuration #41892

Merged
merged 5 commits into from
Nov 27, 2023
Merged

Add docs for Authorization Configuration #41892

merged 5 commits into from
Nov 27, 2023

Conversation

palnabarun
Copy link
Member

@palnabarun palnabarun commented Jul 5, 2023 •
edited by sftim
Loading

@palnabarun
add authorization config documentation
83bb609 
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 5, 2023
@k8s-ci-robot k8s-ci-robot requested a review from deads2k July 5, 2023 12:27
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 5, 2023
@k8s-ci-robot k8s-ci-robot requested a review from lavalamp July 5, 2023 12:27
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jul 5, 2023
@palnabarun palnabarun mentioned this pull request Jul 5, 2023
Open
29 tasks
@netlify
Copy link

netlify bot commented Jul 5, 2023

✅ Pull request preview available for checking

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

@palnabarun palnabarun changed the base branch from main to dev-1.29 October 9, 2023 09:58
@sftim
Copy link
Contributor

sftim commented Oct 9, 2023

/sig auth

@k8s-ci-robot k8s-ci-robot added the sig/auth Categorizes an issue or PR as relevant to SIG Auth. label Oct 9, 2023
@sftim
Copy link
Contributor

sftim commented Oct 25, 2023

This will also need a change to https://kubernetes.io/docs/reference/config-api/

@katcosgrove
Copy link
Contributor

Hi, @palnabarun! v1.29 Docs Lead here. Please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday 14th November 2023. Thank you!

@liggitt liggitt mentioned this pull request Nov 3, 2023
Open
@katcosgrove
Copy link
Contributor

Hi, @palnabarun! Just dropping by to remind you that the deadline for docs PRs to be ready for review is tomorrow, November 14. Is there anything we can help you with to get this PR ready?

@katcosgrove
Copy link
Contributor

As discussed in Slack, your extended deadline to have this PR ready for review is Friday, 17 November

@palnabarun
Copy link
Member Author

This will also need a change to https://kubernetes.io/docs/reference/config-api/

@sftim -- could you please point me to the steps to regenerate those? I was trying the process here: https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/, but it looks the steps are supposed to be run after a release tag is cut.

@sftim
Copy link
Contributor

sftim commented Nov 18, 2023

This will also need a change to https://kubernetes.io/docs/reference/config-api/

@sftim -- could you please point me to the steps to regenerate those? I was trying the process here: https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/, but it looks the steps are supposed to be run after a release tag is cut.

We're not asking for you to run generation (either in this PR, or during the release). Actually the ask is to help revise https://github.com/kubernetes-sigs/reference-docs/ to cover the changed config formats.

@katcosgrove
Copy link
Contributor

Hi, @palnabarun! We are now past your extended deadline to provide docs for this enhancements. What can I do to get this across the line?

@palnabarun
add documentation for AuthorizationConfiguration
5627db2 
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
@netlify Netlify
Copy link

netlify bot commented Nov 20, 2023 •
edited
Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 21ac70e
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/656473a7fd6eab0008081fa9

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 20, 2023
@palnabarun
Copy link
Member Author

@katcosgrove added the documentation now. I missed committing the changes.

@palnabarun
Copy link
Member Author

@sftim ack for clarifying. The initial ask wasn't clear. So, I guess no-op on this PR related to your comment.

@palnabarun palnabarun changed the title [WIP] Add docs for Authorization Configuration Add docs for Authorization Configuration Nov 20, 2023
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 20, 2023
@katcosgrove
Copy link
Contributor

Hi, @palnabarun! Just a reminder that the deadline to have this PR reviewed and merged is Tuesday, 28 November. Let me know if you need any help!

CCing KEP owners: @deads2k @liggitt @ritazh

@stlaz
Copy link
Member

stlaz commented Nov 20, 2023

/triage accepted

@k8s-ci-robot k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Nov 20, 2023
@palnabarun
Update from code review
1056863 
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
@palnabarun
Add more context to downgrade example
03e2976 
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
@ritazh
Copy link
Member

ritazh commented Nov 24, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 24, 2023
sftim
sftim reviewed Nov 24, 2023
View reviewed changes
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. Here's some feedback from the documentation side.

Tech LGTM noted!
/lgtm cancel

We do want the docs style changes as well.

content/en/docs/reference/access-authn-authz/authorization.md Outdated Show resolved Hide resolved
content/en/docs/reference/access-authn-authz/authorization.md Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 24, 2023
@k8s-ci-robot k8s-ci-robot requested a review from ritazh November 24, 2023 11:07
@katcosgrove
Copy link
Contributor

/assign @nate-double-u

@palnabarun
Wrap markdown text
21ac70e 
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
sftim
sftim reviewed Nov 27, 2023
View reviewed changes
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.

Tech LGTM: #41892 (comment)

/lgtm
/approve

content/en/docs/reference/access-authn-authz/authorization.md
@@ -209,6 +209,143 @@ The following flags can be used:
You can choose more than one authorization module. Modules are checked in order
so an earlier module has higher priority to allow or deny a request.

## Configuring the API Server using an Authorization Config File
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit)

Suggested change
## Configuring the API Server using an Authorization Config File
## Configuring the API Server using an authorization config file

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

LGTM label has been added.

Git tree hash: fb99f4076d74088906b1fd08f4650defae573622

@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 Nov 27, 2023
@k8s-ci-robot k8s-ci-robot merged commit 123973c into kubernetes:dev-1.29 Nov 27, 2023
6 checks passed
@k8s-ci-robot k8s-ci-robot added this to the 1.29 milestone Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@deads2k deads2k Awaiting requested review from deads2k

@lavalamp lavalamp Awaiting requested review from lavalamp

@ritazh ritazh Awaiting requested review from ritazh

Assignees

@ritazh ritazh

@nate-double-u nate-double-u

@sftim sftim

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/auth Categorizes an issue or PR as relevant to SIG Auth. 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. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Auth
Archived in project
Structured Authz Enhancement
Status: ✅ Done
Milestone
1.29
Development

Successfully merging this pull request may close these issues.
7 participants
@palnabarun @sftim @katcosgrove @stlaz @ritazh @k8s-ci-robot @nate-double-u