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

update doc for BoundServiceAccountTokenVolume and RootCAConfigMap #27082

Merged
merged 1 commit into from Mar 26, 2021
Merged

update doc for BoundServiceAccountTokenVolume and RootCAConfigMap #27082

merged 1 commit into from Mar 26, 2021

Conversation

zshihang
Copy link
Contributor

@zshihang zshihang commented Mar 16, 2021 •
edited

@k8s-ci-robot k8s-ci-robot added this to the 1.21 milestone Mar 16, 2021
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 16, 2021
@k8sio-netlify-preview-bot
Copy link
Collaborator

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 7a461e5

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/605d7802ed26180008e31d8b

@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. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 16, 2021
@zshihang zshihang mentioned this pull request Mar 16, 2021
Closed
@zshihang
Copy link
Contributor Author

/cc @liggitt

@reylejano
Copy link
Member

/assign @PI-Victor
/sig auth

@k8s-ci-robot k8s-ci-robot added the sig/auth Categorizes an issue or PR as relevant to SIG Auth. label Mar 16, 2021
@liggitt
Copy link
Member

liggitt commented Mar 16, 2021

/lgtm

@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 1b0b87257e27a565cf80a302ed96cae38bdc1b54

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2021
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2021
sftim
sftim previously requested changes Mar 16, 2021
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.

Hi @zshihang

Thanks for this PR. We'd like some changes which I've detailed some in the review summary and some inline.

https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/#bound-service-account-token-volume also needs updating to revise:

This feature depends on the RootCAConfigMap feature gate enabled which publish a "kube-root-ca.crt" ConfigMap to every namespace.

content/en/docs/reference/access-authn-authz/service-accounts-admin.md Outdated
@@ -60,7 +60,7 @@ It acts synchronously to modify pods as they are created or updated. When this p
1. It adds a `volumeSource` to each container of the pod mounted at `/var/run/secrets/kubernetes.io/serviceaccount`.

#### Bound Service Account Token Volume
{{< feature-state for_k8s_version="v1.13" state="alpha" >}}
{{< feature-state for_k8s_version="v1.21" state="beta" >}}

When the `BoundServiceAccountTokenVolume` feature gate is enabled, the service account admission controller will
Copy link
Contributor

Choose a reason for hiding this comment

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

We're a bit more strict about beta docs, so I recommend:

Suggested change
When the `BoundServiceAccountTokenVolume` feature gate is enabled, the service account admission controller will
When the `BoundServiceAccountTokenVolume` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
is enabled, the service account admission controller will

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

content/en/docs/reference/command-line-tools-reference/feature-gates.md
Comment on lines +303 to +313
| `RootCAConfigMap` | `false` | Alpha | 1.13 | 1.19 |
| `RootCAConfigMap` | `true` | Beta | 1.20 | 1.20 |
| `RootCAConfigMap` | `true` | GA | 1.21 | - |
Copy link
Contributor

Choose a reason for hiding this comment

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

Remember to remove this feature gate from the previous table (it's not yet automated, sorry).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@sftim
Copy link
Contributor

sftim commented Mar 16, 2021

Because this does need a couple of updates, I'll note the tech review from SIG Auth (thanks @liggitt) but
/lgtm cancel

@PI-Victor
Copy link
Member

Hi @zshihang , thank you for having your Doc PR ready for review, friendly reminder about the upcoming doc related dates for the 1.21 release:
Upcoming doc related dates for the 1.21 release:

  • Docs Ready for Review deadline is March 24
  • Docs Ready to Merge deadline is March 31

@reylejano
Copy link
Member

Hi @zshihang, please review @sftim's comments and requested changes
Thank you

@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. language/es Issues or PRs related to Spanish language and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 26, 2021
@k8s-ci-robot k8s-ci-robot added language/id Issues or PRs related to Indonesian language language/ko Issues or PRs related to Korean language language/pt Issues or PRs related to Portuguese language language/zh Issues or PRs related to Chinese language labels Mar 26, 2021
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 26, 2021
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 26, 2021
@sftim sftim dismissed their stale review March 26, 2021 00:41

Review was indeed stale

sftim
sftim reviewed Mar 26, 2021
View reviewed changes
content/en/docs/reference/command-line-tools-reference/feature-gates.md Outdated
Comment on lines 154 to 157
| `RemoveSelfLink` | `false` | Alpha | 1.16 | 1.19 |
| `RemoveSelfLink` | `true` | Beta | 1.20 | |
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is RemoveSelfLink removed here? The PR description does not explain this amendment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oops, done

@tengqm
Copy link
Contributor

tengqm commented Mar 26, 2021

We have got tech LGTM with doc review feedbacks addressed.
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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 lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 26, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: a7653be7e469c2273945e261715f1c51c4d27709

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 26, 2021
@k8s-ci-robot k8s-ci-robot merged commit 9442bf8 into kubernetes:dev-1.21 Mar 26, 2021
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

@davidopp davidopp Awaiting requested review from davidopp

@kbarnard10 kbarnard10 Awaiting requested review from kbarnard10

@liggitt liggitt Awaiting requested review from liggitt

Assignees

@liggitt liggitt

@tengqm tengqm

@PI-Victor PI-Victor

@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 language/es Issues or PRs related to Spanish language language/id Issues or PRs related to Indonesian language language/ko Issues or PRs related to Korean language language/pt Issues or PRs related to Portuguese language language/zh Issues or PRs related to Chinese 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
1.21
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@zshihang @k8sio-netlify-preview-bot @reylejano @liggitt @k8s-ci-robot @sftim @PI-Victor @tengqm