Skip to content

Commit

Permalink
Merge pull request #357 from feiskyer/readme
Browse files Browse the repository at this point in the history
Update install guides and version info
  • Loading branch information
Random-Liu authored Jul 20, 2018
2 parents f95ba2f + 56f7a6b commit 19b7255
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 8 deletions.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,35 @@ Version matrix:

| Kubernetes Version | cri-tools Version | cri-tools branch |
|--------------------|-------------------|------------------|
| 1.11.X | v1.0.0-beta.1 | master |
| master | - | master |
| 1.11.X | v1.11.1 | release-1.11 |
| 1.10.X | v1.0.0-beta.0 | release-1.10 |
| 1.9.X | v1.0.0-alpha.0 | release-1.9 |
| 1.8.X | v0.2 | release-1.8 |
| 1.7.X | v0.1 | release-1.7 |

We are currently working toward an beta version of CRI validation tests to be used in conjunction with Kubernetes 1.10. See the [roadmap](docs/roadmap.md) for information about current and future milestones.

## Install

### Install crictl

```sh
VERSION="v1.11.1"
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/$VERSION/crictl-$VERSION-linux-amd64.tar.gz
sudo tar zxvf crictl-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f crictl-$VERSION-linux-amd64.tar.gz
```

### Install critest

```sh
VERSION="v1.11.1"
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/$VERSION/critest-$VERSION-linux-amd64.tar.gz
sudo tar zxvf critest-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-$VERSION-linux-amd64.tar.gz
```

## Documentation

- [CRI validation test suite](docs/validation.md)
Expand Down
7 changes: 4 additions & 3 deletions docs/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ CRI performance benchmarking provides a benchmarking framework for CRI-compatibl
The benchmarking tests binary `critest` can be downloaded from [Releasing page](https://github.com/kubernetes-incubator/cri-tools/releases):

```sh
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/v1.0.0-beta.0/critest-v1.0.0-beta.0-linux-amd64.tar.gz
sudo tar zxvf critest-v1.0.0-beta.0-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-v1.0.0-beta.0-linux-amd64.tar.gz
VERSION="v1.11.1"
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/$VERSION/critest-$VERSION-linux-amd64.tar.gz
sudo tar zxvf critest-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-$VERSION-linux-amd64.tar.gz
```

For v1.0.0-alpha.0 and previous versions, Go and cri-tools source code are also required to run `critest`. The source code could get by running
Expand Down
2 changes: 1 addition & 1 deletion docs/crictl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ crictl is currently in Beta and still under quick iterations. It is hosted at th
crictl can be downloaded from cri-tools [release page](https://github.com/kubernetes-incubator/cri-tools/releases):

```sh
VERSION="v1.0.0-beta.1"
VERSION="v1.11.1"
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/$VERSION/crictl-$VERSION-linux-amd64.tar.gz
sudo tar zxvf crictl-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f crictl-$VERSION-linux-amd64.tar.gz
Expand Down
7 changes: 4 additions & 3 deletions docs/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ CRI validation testing is currently Alpha and still under quick iterations. We e
The benchmarking tests binary `critest` can be downloaded from [Releasing page](https://github.com/kubernetes-incubator/cri-tools/releases):

```sh
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/v1.0.0-beta.0/critest-v1.0.0-beta.0-linux-amd64.tar.gz
sudo tar zxvf critest-v1.0.0-beta.0-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-v1.0.0-beta.0-linux-amd64.tar.gz
VERSION="v1.11.1"
wget https://github.com/kubernetes-incubator/cri-tools/releases/download/$VERSION/critest-$VERSION-linux-amd64.tar.gz
sudo tar zxvf critest-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-$VERSION-linux-amd64.tar.gz
```

critest requires [ginkgo](https://github.com/onsi/ginkgo) to run parallel tests. It could be installed by
Expand Down

0 comments on commit 19b7255

Please sign in to comment.