doc: Containerd alpha support on Windows #19208

PatrickLang · 2020-02-20T02:37:27Z

This updates the status of ContainerD on Windows to alpha for v1.18 (see kubernetes/enhancements#1001)

k8sio-netlify-preview-bot · 2020-02-20T02:37:31Z

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

Building with commit 43ebc28

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5e6a5f9c2c5511000a83b3ae

michmike

/lgtm
/approve

makoscafee · 2020-02-20T15:42:06Z

/milestone 1.18

sftim · 2020-02-20T20:52:58Z

I'll mark this as a work in progress
/hold cancel
/retitle [WIP] Updating containerd status

sftim

Here's some informal feedback that I hope helps shape the PR.

sftim · 2020-02-20T21:05:20Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

@@ -571,9 +571,11 @@ If filing a bug, please include detailed information about how to reproduce the

 We have a lot of features in our roadmap. An abbreviated high level list is included below, but we encourage you to view our [roadmap project](https://github.com/orgs/kubernetes/projects/8) and help us make Windows support better by [contributing](https://github.com/kubernetes/community/blob/master/sig-windows/).

-### CRI-ContainerD
+### CRI-ContainerD (alpha in v1.18)


@PatrickLang this will break incoming links at least twice: once when adding the feature state, then again when it changes.

Use a feature state shortcode instead.

thanks! fixed

sftim · 2020-02-20T21:05:53Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

-{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that recently graduated as a {{< glossary_tooltip text="CNCF" term_id="cncf" >}} project. It's currently tested on Linux, but 1.3 will bring support for Windows and Hyper-V. [[reference](https://blog.docker.com/2019/02/containerd-graduates-within-the-cncf/)]
+{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that recently graduated as a {{< glossary_tooltip text="CNCF" term_id="cncf" >}} project.
+
+Kubernetes v1.18 is tested along with the upcoming ContainerD 1.4 release.


Please avoid statements about the future. I would also avoid hinting at the recent past (“recently graduated”). This kind of text tends to go stale.

thanks! just fixed

sftim · 2020-02-20T21:07:45Z

/lgtm cancel

sftim · 2020-02-20T21:21:03Z

/sig node
/sig windows

PatrickLang · 2020-03-05T18:54:02Z

/hold cancel

This is ready for review

sftim · 2020-03-08T23:10:22Z

I recommend taking a look at the previous feedback I provided; there's a few things still to address.

PatrickLang · 2020-03-09T00:20:52Z

@sftim - can you be more specific or quote what's wrong? I admit I am not a good writer and could use some help here since I believe I already removed the last forward-looking statements.

The last feedback I see you added is about whether or not a feature should go to alpha. What we have is consistent with what was agreed between SIG-Node and SIG-Windows. We need to have a working implementation in Kubernetes in place so we can continue working with the ContainerD maintainers on remaining issues and eventually get to a working release of containerd to recommend with k8s.

cc @m2 @craiglpeters @marosset - I may need some help here

sftim · 2020-03-09T09:42:32Z

The style guide asks authors to avoid making promises or giving hints about the future. Can you revise these changes so you're not adding those kind of promises / hints?

sftim · 2020-03-09T09:43:28Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

+- Azure - [AKS-Engine](https://github.com/Azure/aks-engine/blob/master/docs/topics/features.md#windows-containerd)
+
+
+In future milestones, the CRI-ContainerD interface will be able to manage sandboxes based on Hyper-V. This provides a foundation where RuntimeClass could be implemented for new use cases including:


This is a forward looking statement.

sftim · 2020-03-09T09:43:34Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

+ContainerD on Windows is suitable for development purposes only for a few reasons:
+
+- Kubernetes 1.18 was not tested with an official ContainerD release, only the master development branch. Production deployments should use official releases that have been fully tested and are supported with security fixes.
+- Group-Managed Service Accounts are not yet implemented with ContainerD - see [containerd/cri#1276](https://github.com/containerd/cri/issues/1276).


This is a forward looking statement.

sftim · 2020-03-09T09:43:58Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md


-The CRI-ContainerD interface will be able to manage sandboxes based on Hyper-V. This provides a foundation where RuntimeClass could be implemented for new use cases including:
+{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that works with Kubernetes on Linux. Kubernetes v1.18 is the first version tested with ContainerD on Windows. It's still a work-in-progress, and you can track progress in [enhancements#1001](https://github.com/kubernetes/enhancements/issues/1001). 


This includes a hint about future improvements.

marosset · 2020-03-10T16:55:50Z

I will be picking up the remaining work for this PR

sftim · 2020-03-10T17:01:22Z

Cool. @marosset would you like any help?

marosset · 2020-03-10T17:04:25Z

Let me look over the style guide.
I may come back with more questions tho @sftim :)

marosset · 2020-03-10T19:12:51Z

@sftim @michmike can you take a look the updates I made to avoid forward/future looking statements?

sftim

It's unusual to have a feature move into alpha in a page's What's Next section.

@marosset for a minimum viable change, can you also reword line 572:

We have a lot of features in our roadmap. An abbreviated high level list is included below, but we encourage you to view our roadmap project and help us make Windows support better by contributing.

I think that'd be enough.

kbhawkey · 2020-03-10T20:06:32Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

@@ -575,28 +575,29 @@ We have a lot of features in our roadmap. An abbreviated high level list is incl

 {{< feature-state for_k8s_version="v1.18" state="alpha" >}}

-{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that works with Kubernetes on Linux. Kubernetes v1.18 is the first version tested with ContainerD on Windows. It's still a work-in-progress, and you can track progress in [enhancements#1001](https://github.com/kubernetes/enhancements/issues/1001). 
+{{< glossary_tooltip term_id="containerd" >}} is an OCI-compliant runtime that works with Kubernetes on Linux. Kubernetes v1.18 adds support for ContainerD on Windows. Progress for ContainerD on Windows can be tracked at [enhancements#1001](https://github.com/kubernetes/enhancements/issues/1001).


@PatrickLang @marosset, Some general input:

Is there a good reason to place this content in the What's next section?
Why not introduce a ContainerD for Windows heading (level2)?
OR
There is already a sub section on the page,
https://deploy-preview-19208--kubernetes-io-vnext-staging.netlify.com/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#container-runtime

Line 578, If the name of this feature is, ContainerD, then I suggest starting the sentence with that name, not the tooltip. You could use the tooltip in another place in the first sentence. Also, add the text attribute to the glossary_tooltip shortcode such as: text="ContainerD".

Line 580, The caution shortcode should contain the list of isssues/things.
Line 584. Perhaps modify statement about official releases indicating that ContainerD does not officially support Windows.
Line 594, Do you need the word, new
Look through the content and try to remove content that refers to possible future use or deprecations, etc..
Such as,
Windows node support in kubeadm will come in a future release.

I'll move the ContainerD info under the Container Runtimes - good idea!

I'll address some of the other feedback as well.

sftim

Thanks, that's a much better page.

sftim · 2020-03-10T23:34:46Z

content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

+For Kubernetes v1.18, you can use the test scripts to set up a cluster:
+
+* GCE - [kube-up.sh](https://github.com/kubernetes/kubernetes/blob/master/cluster/gce/windows/README-GCE-Windows-kube-up.md)
+* Azure - [AKS-Engine](https://github.com/Azure/aks-engine/blob/master/docs/topics/features.md#windows-containerd)


I'd omit this: it's cloud provider specific.

michmike

great changes. thank you @PatrickLang and @marosset
/lgtm

marosset · 2020-03-12T16:13:49Z

My last push just squashed the commit - no new changes were introduced.

sftim · 2020-03-12T16:41:24Z

/lgtm
echoing #19208 (review)

michmike · 2020-03-12T19:28:51Z

/approve
/lgtm

VineethReddy02 · 2020-03-12T19:31:20Z

/lgtm
/approve

k8s-ci-robot · 2020-03-12T19:31:37Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: michmike, VineethReddy02

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~~ [VineethReddy02]

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 added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 20, 2020

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Feb 20, 2020

PatrickLang mentioned this pull request Feb 20, 2020

Support CRI-ContainerD on Windows kubernetes/enhancements#1001

Closed

26 tasks

k8s-ci-robot requested review from kbhawkey and michmike February 20, 2020 02:38

michmike approved these changes Feb 20, 2020

View reviewed changes

k8s-ci-robot assigned michmike Feb 20, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 20, 2020

k8s-ci-robot added this to the 1.18 milestone Feb 20, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 20, 2020

k8s-ci-robot changed the title ~~doc: Updating containerd status~~ [WIP] Updating containerd status #19208 Feb 20, 2020

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 20, 2020

sftim reviewed Feb 20, 2020

View reviewed changes

k8s-ci-robot assigned sftim Feb 20, 2020

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 20, 2020

k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. sig/windows Categorizes an issue or PR as relevant to SIG Windows. labels Feb 20, 2020

PatrickLang force-pushed the windows-containerd branch from 48e2907 to 33a08fd Compare March 5, 2020 18:52

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 Mar 5, 2020

PatrickLang changed the title ~~[WIP] Updating containerd status #19208~~ Updating containerd status #19208 Mar 5, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 8, 2020

sftim reviewed Mar 9, 2020

View reviewed changes

sftim reviewed Mar 10, 2020

View reviewed changes

kbhawkey reviewed Mar 10, 2020

View reviewed changes

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 10, 2020

sftim reviewed Mar 10, 2020

View reviewed changes

michmike approved these changes Mar 12, 2020

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 12, 2020

doc: ContainerD on Windows alpha

43ebc28

marosset force-pushed the windows-containerd branch from 6698db4 to 43ebc28 Compare March 12, 2020 16:12

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 12, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 12, 2020

k8s-ci-robot assigned VineethReddy02 Mar 12, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 12, 2020

k8s-ci-robot merged commit 5372544 into kubernetes:dev-1.18 Mar 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Containerd alpha support on Windows #19208

doc: Containerd alpha support on Windows #19208

PatrickLang commented Feb 20, 2020 •

edited

Loading

k8sio-netlify-preview-bot commented Feb 20, 2020 •

edited

Loading

michmike left a comment

makoscafee commented Feb 20, 2020

sftim commented Feb 20, 2020 •

edited

Loading

sftim left a comment

sftim Feb 20, 2020

PatrickLang Mar 5, 2020

sftim Feb 20, 2020

PatrickLang Mar 5, 2020

sftim commented Feb 20, 2020

sftim commented Feb 20, 2020

PatrickLang commented Mar 5, 2020

sftim commented Mar 8, 2020

PatrickLang commented Mar 9, 2020 •

edited

Loading

sftim commented Mar 9, 2020

sftim Mar 9, 2020

sftim Mar 9, 2020

sftim Mar 9, 2020

marosset commented Mar 10, 2020

sftim commented Mar 10, 2020

marosset commented Mar 10, 2020

marosset commented Mar 10, 2020 •

edited

Loading

sftim left a comment

kbhawkey Mar 10, 2020

marosset Mar 10, 2020 •

edited

Loading

sftim left a comment

sftim Mar 10, 2020

michmike left a comment

marosset commented Mar 12, 2020

sftim commented Mar 12, 2020

michmike commented Mar 12, 2020

VineethReddy02 commented Mar 12, 2020

k8s-ci-robot commented Mar 12, 2020

		- Azure - [AKS-Engine](https://github.com/Azure/aks-engine/blob/master/docs/topics/features.md#windows-containerd)


		In future milestones, the CRI-ContainerD interface will be able to manage sandboxes based on Hyper-V. This provides a foundation where RuntimeClass could be implemented for new use cases including:


		The CRI-ContainerD interface will be able to manage sandboxes based on Hyper-V. This provides a foundation where RuntimeClass could be implemented for new use cases including:
		{{< glossary_tooltip term_id="containerd" >}} is another OCI-compliant runtime that works with Kubernetes on Linux. Kubernetes v1.18 is the first version tested with ContainerD on Windows. It's still a work-in-progress, and you can track progress in [enhancements#1001](https://github.com/kubernetes/enhancements/issues/1001).

doc: Containerd alpha support on Windows #19208

doc: Containerd alpha support on Windows #19208

Conversation

PatrickLang commented Feb 20, 2020 • edited Loading

k8sio-netlify-preview-bot commented Feb 20, 2020 • edited Loading

michmike left a comment

Choose a reason for hiding this comment

makoscafee commented Feb 20, 2020

sftim commented Feb 20, 2020 • edited Loading

sftim left a 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

sftim commented Feb 20, 2020

sftim commented Feb 20, 2020

PatrickLang commented Mar 5, 2020

sftim commented Mar 8, 2020

PatrickLang commented Mar 9, 2020 • edited Loading

sftim commented Mar 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marosset commented Mar 10, 2020

sftim commented Mar 10, 2020

marosset commented Mar 10, 2020

marosset commented Mar 10, 2020 • edited Loading

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marosset Mar 10, 2020 • edited Loading

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michmike left a comment

Choose a reason for hiding this comment

marosset commented Mar 12, 2020

sftim commented Mar 12, 2020

michmike commented Mar 12, 2020

VineethReddy02 commented Mar 12, 2020

k8s-ci-robot commented Mar 12, 2020

PatrickLang commented Feb 20, 2020 •

edited

Loading

k8sio-netlify-preview-bot commented Feb 20, 2020 •

edited

Loading

sftim commented Feb 20, 2020 •

edited

Loading

PatrickLang commented Mar 9, 2020 •

edited

Loading

marosset commented Mar 10, 2020 •

edited

Loading

marosset Mar 10, 2020 •

edited

Loading