Doc update for userns in 1.28 #41908

rata · 2023-07-06T09:54:53Z

Commits 1-3 are ports of what we just merged in main, for 1.27. They improve the wording, fix a typo and use a timeless way for some sentences.

On top of that is the new commit that just removes mentiones to stateless pods, as we support all pods (stateful and stateless) now.

rata · 2023-07-06T09:55:10Z

cc @giuseppe

netlify · 2023-07-17T16:43:45Z

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

Name	Link
🔨 Latest commit	`c250efb`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/64d10b097e1f4c0008798f84

rata · 2023-07-21T17:15:34Z

This is ready for review, PTAL :)

giuseppe

LGTM

natalisucks · 2023-07-25T11:04:12Z

/lgtm

k8s-ci-robot · 2023-07-25T11:04:19Z

LGTM label has been added.

Git tree hash: f090ff8f77650d7fedd9361331f2b9fe5e1fd301

sftim

I'd expect to see a change to https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/

Is that still needed? If not, why not?

content/en/docs/concepts/workloads/pods/user-namespaces.md

content/en/docs/tasks/configure-pod-container/user-namespaces.md

rata · 2023-08-07T14:01:02Z

@sftim I think that page is auto-generated, right? I think it is because the KEP didn't update the yaml (if this is auto generated). I've just opened a PR to fix the kep yaml: https://github.com/kubernetes/enhancements/pull/4147/files

Do you know if that is enough? Or anything else we need to do to fix it?

The variable expansion is wrong: it currently expands to 1.27.3 on the rendered website, so it says it is supported in 1.27 and that it is not. Let's just re-work this paragraph so it is cleaerer and the variable expansion is what we want (1.27 and not 1.27.3)- Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

The note is no longer valid (the branch was already merged and the merged was done correctly). Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

rata · 2023-08-07T14:39:27Z

@sftim all fixed now. PTAL. CI is not running for some reason (but not failing either, just not running at all).

sftim · 2023-08-07T14:43:16Z

I recommend rebasing against latest dev-1.28 and squashing to 1 commit.

Feedback was addressed

tengqm · 2023-08-07T14:34:35Z

content/en/docs/concepts/workloads/pods/user-namespaces.md

-Please note that containerd v1.7 supports user namespaces for containers,
-compatible with Kubernetes {{< skew currentPatchVersion >}}. It should not be used
-with Kubernetes 1.27 (and later).
+containerd v1.7 is not compatible with the userns support in Kubernetes v1.27 to v{{< skew latestVersion >}}.


?
What does this mean?

@tengqm that you can't use userns with containerd 1.7 and those k8s versions

It won't work, it will throw an error.

Let me try understand the situation.
containerd 1.7 + k8s 1.25/1.26 -> worked;
containerd 1.7 + k8s 1.27 -> this doesn't work;

If my understanding is correct, how about adjust the order of the two statements?

@tengqm Your understanding is correct. But can you make a specific suggestion here on github? I mean, just changing the order doesn't make much sense IMHO, as the second sentence highlights that some version do support it. It would be weird to say that before sayin some version does NOT support it.

I can do the change that you want, but give me github suggestion to avoid misunderstandings :)

content/en/docs/reference/command-line-tools-reference/feature-gates.md

tengqm · 2023-08-07T14:47:20Z

content/en/docs/tasks/configure-pod-container/user-namespaces.md

+The feature gate to enable user namespaces was previously named
+`UserNamespacesStatelessPodsSupport`, when only stateless pods were supported.
+Only Kubernetes v1.25 through to v1.27 recognise `UserNamespacesStatelessPodsSupport`; for
+Kubernetes `{{< skew currentVersion >}}`, you need to use `UserNamespacesSupport`.


This is an abuse of the skew shortcode.
The 'currentVersion' is a moving target, so this statement will become obsolete soon.
We will eventually remove this statement, either because 1.28 becomes an ancient release or because the gate has graduated/deprecated and removed. We are not sure which one will happen first. So .. instead you may want to clearly call out the version number rather than playing the skew magic.

"for Kubernetes start from v1.28, you need to ..."

"for Kubernetes start from v1.28, you need to ..."

If we forget to update the text for some future release, that proposed text becomes equally incorrect.
The trick is not to forget! Maybe one day though we'll be able to warn - or fail a built - when people forget (I can see how to write that).

I have removed everything after the ;. This way, this sentence is always correct.

content/en/docs/reference/command-line-tools-reference/feature-gates.md

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

rata · 2023-08-07T15:24:20Z

@sftim @tengqm PTAL.

katcosgrove · 2023-08-08T17:43:27Z

Hey y'all! I'm swinging by for the v1.28 Docs team. Today is the docs deadline. Is there anything we can help you with to get this merged?

sftim · 2023-08-08T18:32:00Z

I'm happy with the changes since #41908 (comment)

/lgtm
/approve

We have some time before the release @tengqm if you want to propose a revision.

k8s-ci-robot · 2023-08-08T18:32:08Z

LGTM label has been added.

Git tree hash: e60b83195b7a55efd130a62d718f3aed2bba257f

k8s-ci-robot · 2023-08-08T18:32:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: giuseppe, saschagrunert, 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:

~~content/en/OWNERS~~ [sftim]

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

Doc update for userns in 1.28

k8s-ci-robot added this to the 1.28 milestone Jul 6, 2023

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 6, 2023

k8s-ci-robot requested a review from bradtopol July 6, 2023 09:55

k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 6, 2023

k8s-ci-robot requested a review from mehabhalodiya July 6, 2023 09:55

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jul 6, 2023

rata mentioned this pull request Jul 6, 2023

Support User Namespaces in pods kubernetes/enhancements#127

Open

26 tasks

rata force-pushed the rata/userns-1.28 branch from b7d2eb3 to f88a2a1 Compare July 17, 2023 16:43

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 17, 2023

rata marked this pull request as ready for review July 21, 2023 17:15

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 Jul 21, 2023

k8s-ci-robot requested review from divya-mohan0209 and natalisucks July 21, 2023 17:15

giuseppe approved these changes Jul 24, 2023

View reviewed changes

saschagrunert approved these changes Jul 24, 2023

View reviewed changes

k8s-ci-robot assigned natalisucks Jul 25, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 25, 2023

sftim previously requested changes Aug 5, 2023

View reviewed changes

rata force-pushed the rata/userns-1.28 branch from f88a2a1 to 24348d6 Compare August 7, 2023 13:51

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2023

rata requested a review from sftim August 7, 2023 13:51

rata force-pushed the rata/userns-1.28 branch 2 times, most recently from 528252e to 0be42ca Compare August 7, 2023 14:29

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 7, 2023

rata added 3 commits August 7, 2023 16:34

content: Remove old note about userns

5e70c9a

The note is no longer valid (the branch was already merged and the merged was done correctly). Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

content: Make userns statement about dockerd timeless

922458d

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

rata force-pushed the rata/userns-1.28 branch 3 times, most recently from ee88d1c to 05f6207 Compare August 7, 2023 14:38

tengqm reviewed Aug 7, 2023

View reviewed changes

rata force-pushed the rata/userns-1.28 branch from 05f6207 to 98a564a Compare August 7, 2023 15:04

tengqm reviewed Aug 7, 2023

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Show resolved Hide resolved

tengqm reviewed Aug 7, 2023

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Show resolved Hide resolved

rata added 3 commits August 7, 2023 17:16

content: Userns now supports stateful pods

c34f1eb

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

content: Expand version requirements for userns explanation

6c2a9c5

content: Fix typo

c250efb

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>

rata force-pushed the rata/userns-1.28 branch from 98a564a to c250efb Compare August 7, 2023 15:17

k8s-ci-robot assigned sftim Aug 8, 2023

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 8, 2023

k8s-ci-robot merged commit b23511b into kubernetes:dev-1.28 Aug 8, 2023
6 of 7 checks passed

Rishit-dagli pushed a commit to Rishit-dagli/website that referenced this pull request Aug 12, 2023

Merge pull request kubernetes#41908 from kinvolk/rata/userns-1.28

977b17f

Doc update for userns in 1.28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc update for userns in 1.28 #41908

Doc update for userns in 1.28 #41908

rata commented Jul 6, 2023 •

edited

rata commented Jul 6, 2023

netlify bot commented Jul 17, 2023 •

edited

rata commented Jul 21, 2023

giuseppe left a comment

natalisucks commented Jul 25, 2023

k8s-ci-robot commented Jul 25, 2023

sftim left a comment

rata commented Aug 7, 2023 •

edited

rata commented Aug 7, 2023

sftim commented Aug 7, 2023

tengqm Aug 7, 2023

rata Aug 7, 2023

rata Aug 7, 2023

tengqm Aug 7, 2023

rata Aug 7, 2023

tengqm Aug 7, 2023

sftim Aug 7, 2023

rata Aug 7, 2023

rata commented Aug 7, 2023

katcosgrove commented Aug 8, 2023

sftim commented Aug 8, 2023

k8s-ci-robot commented Aug 8, 2023

k8s-ci-robot commented Aug 8, 2023

Doc update for userns in 1.28 #41908

Doc update for userns in 1.28 #41908

Conversation

rata commented Jul 6, 2023 • edited

rata commented Jul 6, 2023

netlify bot commented Jul 17, 2023 • edited

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

rata commented Jul 21, 2023

giuseppe left a comment

Choose a reason for hiding this comment

natalisucks commented Jul 25, 2023

k8s-ci-robot commented Jul 25, 2023

sftim left a comment

Choose a reason for hiding this comment

rata commented Aug 7, 2023 • edited

rata commented Aug 7, 2023

sftim commented Aug 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rata commented Aug 7, 2023

katcosgrove commented Aug 8, 2023

sftim commented Aug 8, 2023

k8s-ci-robot commented Aug 8, 2023

k8s-ci-robot commented Aug 8, 2023

rata commented Jul 6, 2023 •

edited

netlify bot commented Jul 17, 2023 •

edited

rata commented Aug 7, 2023 •

edited