Add improvement to docs

Some small improvements to docs of things I found while
using the docs.

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
This commit is contained in:
Martin Hickey 2020-04-22 15:35:29 +00:00
parent befc70b444
commit 02307da36d
3 changed files with 22 additions and 5 deletions

View File

@ -78,9 +78,10 @@ specifications as appropriate.
backport version of `libseccomp-dev` is required. See [travis.yml](.travis.yml) for an example on trusty. backport version of `libseccomp-dev` is required. See [travis.yml](.travis.yml) for an example on trusty.
* **btrfs development library.** Required by containerd btrfs support. `btrfs-tools`(Ubuntu, Debian) / `btrfs-progs-devel`(Fedora, CentOS, RHEL) * **btrfs development library.** Required by containerd btrfs support. `btrfs-tools`(Ubuntu, Debian) / `btrfs-progs-devel`(Fedora, CentOS, RHEL)
2. Install **`socat`** (required by portforward). 2. Install **`socat`** (required by portforward).
2. Install and setup a go 1.13.9 development environment. (Note: You can check the travis logs for a recent pull request to confirm the version(s) of golang currently being used to build and test master.) 3. Install **`pkg-config`** (required for linking with `libseccomp`).
3. Make a local clone of this repository. 4. Install and setup a Go 1.13.10 development environment.
4. Install binary dependencies by running the following command from your cloned `cri/` project directory: 5. Make a local clone of this repository.
6. Install binary dependencies by running the following command from your cloned `cri/` project directory:
```bash ```bash
# Note: install.deps installs the above mentioned runc, containerd, and CNI # Note: install.deps installs the above mentioned runc, containerd, and CNI
# binary dependencies. install.deps is only provided for general use and ease of # binary dependencies. install.deps is only provided for general use and ease of
@ -114,7 +115,7 @@ make BUILD_TAGS='seccomp apparmor selinux'
A Kubernetes incubator project called [cri-tools](https://github.com/kubernetes-sigs/cri-tools) A Kubernetes incubator project called [cri-tools](https://github.com/kubernetes-sigs/cri-tools)
includes programs for exercising CRI implementations such as the `cri` plugin. includes programs for exercising CRI implementations such as the `cri` plugin.
More importantly, cri-tools includes the program `critest` which is used for running 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). [CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
Run the CRI Validation test to validate your installation of `containerd` with `cri` built in: Run the CRI Validation test to validate your installation of `containerd` with `cri` built in:
```bash ```bash
@ -140,7 +141,7 @@ See [here](./docs/crictl.md) for information about using `crictl` to debug
pods, containers, and images. pods, containers, and images.
## Configurations ## Configurations
See [here](./docs/config.md) for information about how to configure cri plugins See [here](./docs/config.md) for information about how to configure cri plugins
and [here](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.1.md) and [here](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
for information about how to configure containerd for information about how to configure containerd
## Documentation ## Documentation
See [here](./docs) for additional documentation. See [here](./docs) for additional documentation.

View File

@ -38,6 +38,21 @@ $ crictl inspecti busybox
... displays information about the image. ... displays information about the image.
``` ```
***Note:*** If you get an error similar to the following when running a `crictl`
command (and your containerd instance is already running):
```console
crictl info
FATA[0000] getting status of runtime failed: rpc error: code = Unimplemented desc = unknown service runtime.v1alpha2.RuntimeService
```
This could be that you are using an incorrect containerd configuration (maybe
from a Docker install). You will need to update your containerd configuration
to the containerd instance that you are running. One way of doing this is as
follows:
```console
$ mv /etc/containerd/config.toml /etc/containerd/config.bak
$ containerd config default > /etc/containerd/config.toml
```
## Directly Load a Container Image ## Directly Load a Container Image
Another way to load an image into the container runtime is with the load Another way to load an image into the container runtime is with the load
command. With the load command you inject a container image into the container command. With the load command you inject a container image into the container

View File

@ -9,6 +9,7 @@ Code verification includes lint, code formatting, boilerplate check etc.
```bash ```bash
make install.tools make install.tools
``` ```
***Note:*** Some make actions (like `install.tools`) use the user's `GOPATH` and will otherwise not work when it is not set. Other make actions override it by setting it to a temporary directory for release build and testing purposes.
* Run code verification: * Run code verification:
```bash ```bash
make verify make verify