Add initial documents. #1

Random-Liu · 2017-04-14T07:21:06Z

This PR added initial documents including:

CONTRIBUTING.md
OWNERS
README.md
code-of-conduct.md
docs/proposal.md

/cc @feiskyer @resouer
@kubernetes-incubator/maintainers-cri-containerd

feiskyer · 2017-04-14T07:44:54Z

LGTM

resouer · 2017-04-14T09:00:43Z

docs/proposal.md

+Containerd was previously part of Docker, [introduced in Docker 1.11](https://blog.docker.com/2016/04/docker-engine-1-11-runc/), used to manage [runC](https://runc.io/) containers on the node. As is shown below, it creates a containerd-shim for each container, and the shim manages the lifecycle of its corresponding container.
+![containerd](./containerd.png)
+
+In Dec. 2016, Docker spun it out into a standalone component, and donated it to [CNCF](https://www.cncf.io/) in Mar. 2017.


Seems like we should use Docker Inc. here? It is confusing between Docker & Docker Inc in this part.

resouer · 2017-04-14T09:12:03Z

docs/proposal.md

+CRI-containerd should:
+* Create a network namespace;
+* Call [network plugin](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/network/plugins.go) to update the options of the network namespace;
+* Let the user containers share the network namespace.


Is this saying "user containers in the same Pod"?

needs more explanation..

Crazykev · 2017-04-14T09:22:59Z

README.md

@@ -1 +1,22 @@
-# cri-containerd
+# cri-containerd
+Cri-containerd is a [containerd](https://containerd.io/) based implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/kubernetes/blob/v1.6.0/pkg/kubelet/api/v1alpha1/runtime/api.proto).


Nit: Is it 'CRI-containerd' here?

Hm, based on https://english.stackexchange.com/questions/9063/how-do-you-capitalize-a-proper-noun-such-as-iphone, it should be "cri-containerd" here. Will update.

Yes unless the proper name of the product is CRI-ContainerD or some such..

Crazykev · 2017-04-14T09:28:27Z

Glad to see this project, please ping me if needs any help here!

supereagle · 2017-04-14T10:04:51Z

CONTRIBUTING.md

+
+### Adding dependencies
+
+If your patch depends on new packages, add that package with [`godep`](https://github.com/tools/godep). Follow the [instructions to add a dependency](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md#godep-and-dependency-management).


development.md#godep-and-dependency-management has been moved to https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#dependency-management

Copied the whole doc from other project. Will update. Thanks.

supereagle · 2017-04-14T10:13:37Z

Cool. Looking forward to this feature.

mikebrow

See proposed edits....

mikebrow · 2017-04-14T13:51:20Z

docs/proposal.md

+## Background
+Containerd is a core container runtime, which provides the minimum set of functionalities to manage the complete container lifecycle of its host system, including container execution and supervision, image distribution and storage, etc.
+
+Containerd was previously part of Docker, [introduced in Docker 1.11](https://blog.docker.com/2016/04/docker-engine-1-11-runc/), used to manage [runC](https://runc.io/) containers on the node. As is shown below, it creates a containerd-shim for each container, and the shim manages the lifecycle of its corresponding container.


/s/was previously/is a part of/

Actually, it's not a part of docker now.

right is a dependency.. without it there is no docker.

so maybe was previously part of Docker and will soon become a dependency of future Docker releases.

Because Docker said they were spanning out containerd, so it seems like before they spun out it, it was "part of docker".

right splitting out the component from github.com/docker/docker... yet still including it as a part of docker with respect to the design of docker and running code dependency chain that also includes opencontainers/runc and docker/libcontainer as the major code repositories for the container code.

The docker concept is confusing - docker opensource org, docker inc, docker itself.

I'll just remove this sentence then. :p

mikebrow · 2017-04-14T13:54:10Z

docs/proposal.md

+In Dec. 2016, Docker spun it out into a standalone component, and donated it to [CNCF](https://www.cncf.io/) in Mar. 2017.
+
+## Motivation
+Containerd is a potential alternative to Docker as the runtime for Kubernetes cluster. *Compared with Docker*, containerd has pros and cons.


/s/is a/is one/

What is the difference?

hints that there are other alternatives.. one of many..

rkt, cri-o, hyperv...

That's why I didn't use the. :)

http://www.differencebetween.com/difference-between-a-and-vs-one-in-english-grammar/

:-) It's tricky. Using a indicates the noun that follows (potential alternative) is singular. Whereas in this case it is plural.. one of many. But this is being picky :)

Hm, you are a good English teacher!

mikebrow · 2017-04-14T14:02:11Z

docs/proposal.md

+## Motivation
+Containerd is a potential alternative to Docker as the runtime for Kubernetes cluster. *Compared with Docker*, containerd has pros and cons.
+### Pros
+* **Stability**: Containerd has limited scope and slower feature velocity, which is expected to be more stable.


While containerd is fairly new, going forward it is expected, by design, to have slower feature velocity due mainly to it's limited scope as compared to Docker.

mikebrow · 2017-04-14T14:13:45Z

docs/proposal.md

+Containerd is a potential alternative to Docker as the runtime for Kubernetes cluster. *Compared with Docker*, containerd has pros and cons.
+### Pros
+* **Stability**: Containerd has limited scope and slower feature velocity, which is expected to be more stable.
+* **Compatibility**: The scope of containerd meets Kubernetes' requirement pretty well.


/s/meets Kubernetes' requirement pretty well./aligns with Kubernetes' requirements. Further, any missing features and function should be achievable through community involvement with the containerd team./

mikebrow · 2017-04-14T14:15:27Z

docs/proposal.md

+* **Stability**: Containerd has limited scope and slower feature velocity, which is expected to be more stable.
+* **Compatibility**: The scope of containerd meets Kubernetes' requirement pretty well.
+* **Performance**:
+  * Containerd consumes less resource because it's only a subset of Docker;


/s/because it's only a subset of Docker/than Docker at least because it is a subset of Docker/

mikebrow · 2017-04-14T15:02:07Z

docs/proposal.md

+CRI-containerd should:
+* Create a network namespace;
+* Call [network plugin](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/network/plugins.go) to update the options of the network namespace;
+* Let the user containers share the network namespace.


needs more explanation..

mikebrow · 2017-04-14T15:03:11Z

docs/proposal.md

+
+CRI container metrics api needs to be defined ([#27097](https://github.com/kubernetes/kubernetes/issues/27097)). After that, CRI-containerd should translate containerd container metrics into CRI container metrics.
+### Image Management
+CRI-containerd relies on containerd to manage image. Containerd should provide all function and information required by CRI, and CRI-containerd only needs to do api translation and information reorganization.


/s/manage image/manage images/

/s/Containerd should provide all function and/At least initially, containerd will provide all of the functionality and image/

mikebrow · 2017-04-14T15:12:13Z

docs/proposal.md

+### Out of Scope
+Following items are out of the scope of this design, we may address them in future version as enhancement or optimization.
+* **Debuggability**: One of the biggest concern of CRI-containerd is debuggability. We should provide equivalent debuggability with Docker CLI through `kubectl`, [`cri-tools`](https://github.com/kubernetes-incubator/cri-tools) or containerd CLI.
+* **Built-in CRI support**: The [plugin model](https://github.com/containerd/containerd/blob/master/design/plugins.md) provided by containerd makes it possible to directly build CRI support into containerd as a plugin, which will elimate one more hop from the stack. But because of the [limitation of golang plugin](https://github.com/containerd/containerd/issues/563), we have to either maintain our own branch or push CRI plugin upstream.


/s/elimate/eliminate/

mikebrow · 2017-04-14T15:17:54Z

docs/proposal.md

+|            Proposal            |          |          |     ✓    |          |          |          |
+|   Containerd Feature Complete  |     ✓    |     ✓    |     ✓    |          |          |          |
+| Runtime Management Integration |          |          |     ✓    |     ✓    |     ✓    |     ✓    |
+|  Image Management Integration  |          |          |          |     ✓    |     ✓    |     ✓    |


Should break these last two out into the separate parts listed above in the 1.7 and 1.8 sections.

Sorry, what do you mean? :)

the table shows runtime management integration as being check marked over 6weeks, same for image management. But the prior paragraphs breakout these two concepts into smaller items that each have their own priority level. The table does not explain when those parts would be worked on.

Done. But only put the P0 items in the roadmap.

mikebrow · 2017-04-14T15:19:18Z

docs/proposal.md

+* [P0] Feature complete, pass 100% cri validation test.
+* [P0] Integrate CRI-containerd with Kubernetes, and build the e2e/node e2e test framework.
+* [P1] Address the debuggability problem.
+### Q2 Roadmap


Proof of Concept (POC), First Half (1/2), Second Half (2/2)

This is not POC this time. This will be an alpha version.

right just defining the abbr. used in the table.

We only include the Q2 roadmap for now, the future is unpredictable. :)

heartlock · 2017-04-14T15:35:23Z

+1 for this project!

yujuhong · 2017-04-14T16:20:02Z

docs/proposal.md

+## Background
+Containerd is a core container runtime, which provides the minimum set of functionalities to manage the complete container lifecycle of its host system, including container execution and supervision, image distribution and storage, etc.
+
+Containerd was previously part of Docker, [introduced in Docker 1.11](https://blog.docker.com/2016/04/docker-engine-1-11-runc/), used to manage [runC](https://runc.io/) containers on the node. As is shown below, it creates a containerd-shim for each container, and the shim manages the lifecycle of its corresponding container.


s/As is shown/As shown

yujuhong · 2017-04-14T16:21:08Z

docs/proposal.md

+In Dec. 2016, Docker spun it out into a standalone component, and donated it to [CNCF](https://www.cncf.io/) in Mar. 2017.
+
+## Motivation
+Containerd is a potential alternative to Docker as the runtime for Kubernetes cluster. *Compared with Docker*, containerd has pros and cons.


s/cluster/clusters

yujuhong · 2017-04-14T16:40:12Z

docs/proposal.md

+* [P0] Basic image management.
+* [P0] Container networking.
+* [P1] Container streaming/logging.
+* [P2] Container/ImageFS Metrics.


Suggestion: Include how you plan to validate the implementation, e.g., what kind of testing can we expect.

Random-Liu · 2017-04-14T21:44:02Z

Thanks for reviewing everyone! Addressed comments and will squash the commit before merging.

mikebrow

LGTM

Random-Liu · 2017-04-14T22:06:26Z

@mikebrow Thanks for your patience! :)

Will squash and merge this.

Set default scheme in registryEndpoints for host

Remove Linux only block on sandbox mounts

k8s-ci-robot added the cncf-cla: yes label Apr 14, 2017

Random-Liu assigned mikebrow Apr 14, 2017

Random-Liu force-pushed the initial-document branch from ae82d1b to a91a3d6 Compare April 14, 2017 07:22

Random-Liu added the kind/docs label Apr 14, 2017

resouer reviewed Apr 14, 2017

View reviewed changes

Crazykev reviewed Apr 14, 2017

View reviewed changes

supereagle reviewed Apr 14, 2017

View reviewed changes

mikebrow reviewed Apr 14, 2017

View reviewed changes

yujuhong reviewed Apr 14, 2017

View reviewed changes

Random-Liu force-pushed the initial-document branch 2 times, most recently from 01813e1 to f6d0668 Compare April 14, 2017 21:47

mikebrow approved these changes Apr 14, 2017

View reviewed changes

Random-Liu added the lgtm label Apr 14, 2017

Add initial documents.

e51409a

Random-Liu force-pushed the initial-document branch from f6d0668 to e51409a Compare April 14, 2017 22:09

Random-Liu merged commit 2ec9bfc into containerd:master Apr 14, 2017

Random-Liu deleted the initial-document branch April 14, 2017 22:09

mikebrow mentioned this pull request Nov 12, 2018

support DisableCgroup, DisableApparmor, RestrictOOMScoreAdj #970

Merged

mikebrow mentioned this pull request Sep 6, 2019

[WIP] adds option for setting default oci hooks #1248

Closed

jterry75 mentioned this pull request Sep 26, 2019

[WCOW] Support live restore #1286

Closed

ibuildthecloud pushed a commit to ibuildthecloud/cri that referenced this pull request Feb 24, 2020

Merge pull request containerd#1 from erikwilson/fix-localhost-image-pull

1ef8e95

Set default scheme in registryEndpoints for host

dcantah added a commit to dcantah/cri that referenced this pull request Jan 7, 2022

Merge pull request containerd#1 from dcantah/windows-sandboxmount

3337fa9

Remove Linux only block on sandbox mounts


		### Adding dependencies

		If your patch depends on new packages, add that package with [`godep`](https://github.com/tools/godep). Follow the [instructions to add a dependency](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md#godep-and-dependency-management).

Add initial documents. #1

Add initial documents. #1

Uh oh!

Conversation

Random-Liu commented Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

feiskyer commented Apr 14, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

resouer Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Random-Liu Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Crazykev commented Apr 14, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

supereagle commented Apr 14, 2017

Uh oh!

mikebrow left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Random-Liu Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikebrow Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Random-Liu Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikebrow Apr 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Random-Liu commented Apr 14, 2017 •

edited

Loading

resouer Apr 14, 2017 •

edited

Loading

Random-Liu Apr 14, 2017 •

edited

Loading

Random-Liu Apr 14, 2017 •

edited

Loading

mikebrow Apr 14, 2017 •

edited

Loading

Random-Liu Apr 14, 2017 •

edited

Loading

mikebrow Apr 14, 2017 •

edited

Loading

mikebrow Apr 14, 2017 •

edited

Loading