Merge pull request #667 from mikebrow/doc-updates-cri-move

docs update for cri-containerd to cri move
containerd · Mar 16, 2018 · 4785511 · 4785511
2 parents 65b5240 + 0ee7614
commit 4785511
Show file tree

Hide file tree

Showing 8 changed files with 104 additions and 147 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,23 @@
-# cri-containerd
+# cri
 <p align="center">
 <img src="https://github.com/kubernetes/kubernetes/blob/master/logo/logo.png" width="50" height="50">
 <img src="https://github.com/containerd/containerd/blob/master/docs/images/containerd-dark.png" width="200" >
 </p>
 
-[![Build Status](https://api.travis-ci.org/containerd/cri-containerd.svg?style=flat-square)](https://travis-ci.org/containerd/cri-containerd)
-[![Go Report Card](https://goreportcard.com/badge/github.com/containerd/cri-containerd?style=flat-square)](https://goreportcard.com/report/github.com/containerd/cri-containerd)
+Note: `cri-containerd` is transitioning from a standalone binary that talks to
+containerd to a plugin within containerd. This github branch is for the `cri`
+plugin. See [cri-containerd standalone branch](https://github.com/containerd/cri/tree/standalone-cri-containerd)
+for information about the standalone version of cri-containerd.
 
-`cri-containerd` is a [containerd](https://containerd.io/) based implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto).
+[![Build Status](https://api.travis-ci.org/containerd/cri.svg?style=flat-square)](https://travis-ci.org/containerd/cri)
+[![Go Report Card](https://goreportcard.com/badge/github.com/containerd/cri?style=flat-square)](https://goreportcard.com/report/github.com/containerd/cri)
+
+`cri` is a [containerd](https://containerd.io/) plugin implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto).
 
 With it, you could run Kubernetes using containerd as the container runtime.
-![cri-containerd](./docs/cri-containerd.png)
+![cri](./docs/cri.png)
 ## Current Status
-`cri-containerd` is in beta:
+`cri` is in beta:
 * It is feature complete.
 * It (the beta version) works with Kubernetes >= 1.9.
 * It has passed all [CRI validation tests](https://github.com/kubernetes/community/blob/master/contributors/devel/cri-validation.md).
@@ -21,11 +26,11 @@ With it, you could run Kubernetes using containerd as the container runtime.
 
 See [test dashboard](https://k8s-testgrid.appspot.com/sig-node-containerd)
 ## Support Metrics
-| CRI-Containerd Version | Kubernetes Version |
-|:----------------------:|:------------------:|
-|     v1.0.0-alpha.x     |      1.7, 1.8      |
-|      v1.0.0-beta.x     |        1.9         |
-|          HEAD          |        1.10+       |
+| CRI-Containerd Version | CRI Plugin Version | Kubernetes Version |
+|:----------------------:|:------------------:|:------------------:|
+|     v1.0.0-alpha.x     |                    |      1.7, 1.8      |
+|      v1.0.0-beta.x     |                    |        1.9         |
+|                        |        HEAD        |        1.10+       |
 ## Production Quality Cluster on GCE
 For a production quality cluster on GCE brought up with `kube-up.sh` refer [here](docs/kube-up.md).
 ## Installing with Ansible and Kubeadm
@@ -35,48 +40,49 @@ For non ansible users, you can download the `cri-containerd` release tarball and
 kubernetes cluster using kubeadm as described [here](docs/installation.md).
 ## Getting Started for Developers
 ### Binary Dependencies and Specifications
-The current release of `cri-containerd` has the following dependencies:
+The current release of the `cri` plugin has the following dependencies:
 * [containerd](https://github.com/containerd/containerd)
 * [runc](https://github.com/opencontainers/runc)
 * [CNI](https://github.com/containernetworking/cni)
 
-See [versions](./vendor.conf) of these dependencies `cri-containerd` is tested with.
+See [versions](./vendor.conf) of these dependencies `cri` is tested with.
 
 As containerd and runc move to their respective general availability releases,
-we will do our best to rebase/retest `cri-containerd` with these releases on a
-weekly/monthly basis. Similarly, given that `cri-containerd` uses the Open
+we will do our best to rebase/retest `cri` with these releases on a
+weekly/monthly basis. Similarly, given that `cri` uses the Open
 Container Initiative (OCI) [image](https://github.com/opencontainers/image-spec)
 and [runtime](https://github.com/opencontainers/runtime-spec) specifications, we
-will also do our best to update `cri-containerd` to the latest releases of these
+will also do our best to update `cri` to the latest releases of these
 specifications as appropriate.
 ### Install Dependencies
 1. Install development libraries:
-* **libseccomp development library.** Required by cri-containerd and runc seccomp support. `libseccomp-dev` (Ubuntu, Debian) / `libseccomp-devel`
+* **libseccomp development library.** Required by cri and runc seccomp support. `libseccomp-dev` (Ubuntu, Debian) / `libseccomp-devel`
 (Fedora, CentOS, RHEL). On releases of Ubuntu <=Trusty and Debian <=jessie a
 backport version of `libseccomp-dev` is required. See [travis.yml](.travis.yml) for an example on trusty.
-* **libapparmor development library.** Required by cri-containerd and runc apparmor support. To use apparmor on Debian, Ubuntu, and related distributions the installation of `libapparmor-dev` is required.
+* **libapparmor development library.** Required by cri and runc apparmor support. To use apparmor on Debian, Ubuntu, and related distributions the installation of `libapparmor-dev` is required.
 * **btrfs development library.** Required by containerd btrfs support. `btrfs-tools`(Ubuntu, Debian) / `btrfs-progs-devel`(Fedora, CentOS, RHEL)
 2. Install other dependencies:
 * **`nsenter`**: Required by CNI and portforward.
 * **`socat`**: Required by portforward.
 3. Install and setup a go 1.10 development environment.
 4. Make a local clone of this repository.
-5. Install binary dependencies by running the following command from your cloned `cri-containerd/` project directory:
+5. Install binary dependencies by running the following command from your cloned `cri/` project directory:
 ```bash
 # Note: install.deps installs the above mentioned runc, containerd, and CNI
 # binary dependencies. install.deps is only provided for general use and ease of
 # testing. To customize `runc` and `containerd` build tags and/or to configure
 # `cni`, please follow instructions in their documents.
 make install.deps
 ```
-### Build and Install cri-containerd
-To build and install `cri-containerd` enter the following commands from your `cri-containerd` project directory:
+### Build and Install cri
+To build and install a version of containerd with the `cri` plugin enter the
+following commands from your `cri` project directory:
 ```bash
 make
 sudo make install
 ```
 #### Build Tags
-`cri-containerd` supports optional build tags for compiling support of various features.
+`cri` supports optional build tags for compiling support of various features.
 To add build tags to the make option the `BUILDTAGS` variable must be set.
 
 ```bash
@@ -88,31 +94,27 @@ make BUILD_TAGS='seccomp apparmor'
 | seccomp   | syscall filtering                  | libseccomp development library  |
 | selinux   | selinux process and mount labeling | <none>                          |
 | apparmor  | apparmor profile support           | libapparmor development library |
-### Validate Your cri-containerd Setup
+### Validate Your cri Setup
 A Kubernetes incubator project called [cri-tools](https://github.com/kubernetes-incubator/cri-tools)
-includes programs for exercising CRI implementations such as `cri-containerd`.
+includes programs for exercising CRI implementations such as the `cri plugin`.
 More importantly, cri-tools includes the program `critest` which is used for running
 [CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/cri-validation.md).
 
-Run the CRI Validation test to validate your installation of `cri-containerd`:
+Run the CRI Validation test to validate your installation of `containerd` with `cri`:
 ```bash
 make test-cri
 ```
 ### Running a Kubernetes local cluster
 If you already have a working development environment for supported Kubernetes
-version, you can try `cri-containerd` in a local cluster:
+version, you can try `cri` in a local cluster:
 
 1. Start `containerd` as root in a first terminal:
 ```bash
 sudo containerd
 ```
-2. Start `cri-containerd` as root in a second terminal:
-```bash
-sudo cri-containerd
-```
-3. From the Kubernetes project directory startup a local cluster using `cri-containerd`:
+2. From the Kubernetes project directory startup a local cluster using `containerd` with `cri`:
 ```bash
-CONTAINER_RUNTIME=remote CONTAINER_RUNTIME_ENDPOINT='/var/run/cri-containerd.sock' ./hack/local-up-cluster.sh
+CONTAINER_RUNTIME=remote CONTAINER_RUNTIME_ENDPOINT='/run/containerd/containerd.sock' ./hack/local-up-cluster.sh
 ```
 ### Test
 See [here](./docs/testing.md) for information about test.

diff --git a/contrib/ansible/README.md b/contrib/ansible/README.md
@@ -26,8 +26,8 @@ $ cat hosts
 ## Step 1:
 At this point, the ansible playbook should be able to ssh into the machines in the hosts file.
 ```console
-git clone https://github.com/containerd/cri-containerd
-cd ./cri-containerd/contrib/ansible
+git clone https://github.com/containerd/cri
+cd ./cri/contrib/ansible
 ansible-playbook -i hosts cri-containerd.yaml
 ```
 A typical cloud login might have a username and private key file, in which case the following can be used:

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,18 +1,18 @@
-# Architecture of CRI-Containerd
-This document describes the architecture of `cri-containerd`.
+# Architecture of The CRI Plugin
+This document describes the architecture of the `cri` plugin for `containerd`.
 
-Cri-containerd is a containerd based implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto). It operates on the same node as the [Kubelet](https://kubernetes.io/docs/reference/generated/kubelet/) and [containerd](https://github.com/containerd/containerd). Layered between Kubernetes and containerd, cri-containerd handles all CRI service requests from the Kubelet and uses containerd to manage containers and container images.
+This plugin is an implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto). Containerd operates on the same node as the [Kubelet](https://kubernetes.io/docs/reference/generated/kubelet/). The `cri` plugin inside containerd handles all CRI service requests from the Kubelet and uses containerd internals to manage containers and container images.
 
-Cri-containerd uses containerd to manage the full container lifecycle and all container images. As also shown below, cri-containerd manages pod networking via [CNI](https://github.com/containernetworking/cni) (another CNCF project).
+The `cri` plugin uses containerd to manage the full container lifecycle and all container images. As also shown below, `cri` manages pod networking via [CNI](https://github.com/containernetworking/cni) (another CNCF project).
 
 ![architecture](./architecture.png)
 
-Let's use an example to demonstrate how cri-containerd works for the case when Kubelet creates a single-container pod:
-* Kubelet calls cri-containerd, via the CRI runtime service API, to create a pod;
-* cri-containerd uses containerd to create and start a special [pause container](https://www.ianlewis.org/en/almighty-pause-container) (the sandbox container) and put that container inside the pod’s cgroups and namespace (steps omitted for brevity);
-* cri-containerd configures the pod’s network namespace using CNI;
-* Kubelet subsequently calls cri-containerd, via the CRI image service API, to pull the application container image;
-* cri-containerd further uses containerd to pull the image if the image is not present on the node;
-* Kubelet then calls cri-containerd, via the CRI runtime service API, to create and start the application container inside the pod using the pulled container image;
-* cri-containerd finally calls containerd to create the application container, put it inside the pod’s cgroups and namespace, then to start the pod’s new application container.
+Let's use an example to demonstrate how the `cri` plugin works for the case when Kubelet creates a single-container pod:
+* Kubelet calls the `cri` plugin, via the CRI runtime service API, to create a pod;
+* `cri` uses containerd internal to create and start a special [pause container](https://www.ianlewis.org/en/almighty-pause-container) (the sandbox container) and put that container inside the pod’s cgroups and namespace (steps omitted for brevity);
+* `cri` configures the pod’s network namespace using CNI;
+* Kubelet subsequently calls the `cri` plugin, via the CRI image service API, to pull the application container image;
+* `cri` further uses containerd to pull the image if the image is not present on the node;
+* Kubelet then calls `cri`, via the CRI runtime service API, to create and start the application container inside the pod using the pulled container image;
+* `cri` finally uses containerd internal to create the application container, put it inside the pod’s cgroups and namespace, then to start the pod’s new application container.
 After these steps, a pod and its corresponding application container is created and running.
diff --git a/docs/cri-containerd.png → docs/cri.png b/docs/cri-containerd.png → docs/cri.png
diff --git a/docs/crictl.md b/docs/crictl.md
@@ -1,17 +1,16 @@
 CRICTL User Guide
 =================
-This document presumes you already have `containerd` and `cri-containerd`
-installed and running.
+This document presumes you already have `containerd` with the `cri` plugin installed and running.
 
 This document is for developers who wish to debug, inspect, and manage their pods,
 containers, and container images.
 
-Before generating issues against this document, `containerd`, `cri-containerd`,
+Before generating issues against this document, `containerd`, `containerd/cri`,
 or `crictl` please make sure the issue has not already been submitted.
 
 ## Install crictl
 If you have not already installed crictl please install the version compatible
-with the `cri-containerd` you are using. If you are a user, your deployment
+with the `cri` plugin you are using. If you are a user, your deployment
 should have installed crictl for you. If not, get it from your release tarball.
 If you are a developer the current version of crictl is specified [here](../hack/utils.sh).
 A helper command has been included to install the dependencies at the right version:
@@ -23,8 +22,8 @@ so you don't have to repeatedly specify the runtime sock used to connect crictl
 to the container runtime:
 ```console
 $ cat /etc/crictl.yaml
-runtime-endpoint: /var/run/cri-containerd.sock
-image-endpoint: /var/run/cri-containerd.sock
+runtime-endpoint: /run/containerd/containerd.sock
+image-endpoint: /run/containerd/containerd.sock
 timeout: 10
 debug: true
 ```
@@ -95,20 +94,8 @@ $ crictl inspectp e1c8
 * Other commands to manage the pod include `stops ID` to stop a running pod and
 `rmp ID` to remove a pod sandbox.
 
-## Create and Run a Container in a Pod Sandbox (using a config file)
+## Create and Run a Container in the Pod Sandbox (using a config file)
 ```console
-$ cat sandbox-config.json
-{
-    "metadata": {
-        "name": "nginx-sandbox",
-        "namespace": "default",
-        "attempt": 1,
-        "uid": "hdishd83djaidwnduwk28bcsb"
-    },
-    "linux": {
-    }
-}
-
 $ cat container-config.json
 {
   "metadata": {
@@ -126,7 +113,7 @@ $ cat container-config.json
 
 $ crictl create e1c83 container-config.json sandbox-config.json
 0a2c761303163f2acaaeaee07d2ba143ee4cea7e3bde3d32190e2a36525c8a05
-$ crictl ps
+$ crictl ps -a
 CONTAINER ID        IMAGE               CREATED             STATE               NAME                ATTEMPT
 0a2c761303163       docker.io/busybox   2 hours ago         CONTAINER_CREATED   busybox             0
 $ crictl start 0a2c
@@ -145,20 +132,20 @@ bin   dev   etc   home  proc  root  sys   tmp   usr   var
 ## Display Stats for the Container
 ```console
 $ crictl stats
-CONTAINER           CPU %               MEM                 DISK                INODES
-0a2c761303163f      0.00                991.2kB             16.38kB             6
+CONTAINER           CPU %               MEM                 DISK              INODES
+0a2c761303163f      0.00                983kB             16.38kB             6
 ```
 * Other commands to manage the container include `stop ID` to stop a running
 container and `rm ID` to remove a container.
 ## Display Version Information
 ```console
 $ crictl version
 Version:  0.1.0
-RuntimeName:  cri-containerd
-RuntimeVersion:  1.0.0-alpha.1-167-g737efe7-dirty
-RuntimeApiVersion:  0.0.0
+RuntimeName:  containerd
+RuntimeVersion:  1.0.0-beta.1-186-gdd47a72-TEST
+RuntimeApiVersion:  v1alpha2
 ```
-## Display Status & Configuration Information about Containerd & CRI-Containerd
+## Display Status & Configuration Information about Containerd & The CRI Plugin
 ```console
 $ crictl info
 {
@@ -180,25 +167,30 @@ $ crictl info
   },
   "config": {
     "containerd": {
-      "rootDir": "/var/lib/containerd",
       "snapshotter": "overlayfs",
-      "endpoint": "/run/containerd/containerd.sock",
       "runtime": "io.containerd.runtime.v1.linux"
     },
     "cni": {
       "binDir": "/opt/cni/bin",
       "confDir": "/etc/cni/net.d"
     },
-    "socketPath": "/var/run/cri-containerd.sock",
-    "rootDir": "/var/lib/cri-containerd",
+    "registry": {
+      "mirrors": {
+        "docker.io": {
+          "endpoint": [
+            "https://registry-1.docker.io"
+          ]
+        }
+      }
+    },
     "streamServerPort": "10010",
     "sandboxImage": "gcr.io/google_containers/pause:3.0",
     "statsCollectPeriod": 10,
-    "oomScore": -999,
-    "enableProfiling": true,
-    "profilingPort": "10011",
-    "profilingAddress": "127.0.0.1"
-  }
+    "containerdRootDir": "/var/lib/containerd",
+    "containerdEndpoint": "/run/containerd/containerd.sock",
+    "rootDir": "/var/lib/containerd/io.containerd.grpc.v1.cri"
+  },
+  "golang": "go1.10"
 }
 ```
 ## More Information