Skip to content

Commit

Permalink
Add notes on an advanced setup
Browse files Browse the repository at this point in the history
  • Loading branch information
nwneisen committed Jul 27, 2023
1 parent 5ca10cd commit f955709
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ For users running `0.2.5` or above, the default network plugin is `cni`. Kuberne
other network plumbing from upstream as part of the `dockershim` removal/deprecation. In order for a cluster to become
operational, Calico, Flannel, Weave, or another CNI should be used.

For CI workflows, basic functionality can be provided via [`containernetworking/plugins`](
https://github.com/containernetworking/plugins).
For CI workflows, basic functionality can be provided via [`containernetworking/plugins`](https://github.com/containernetworking/plugins).

## Motivation

Expand All @@ -38,12 +37,16 @@ packages from the [releases page](https://github.com/Mirantis/cri-dockerd/releas
There are numerous supported platforms and using a pre-built package will install
the binary and setup your system to run it as a service.

### Installing manually
## Advanced Setup

### Installing manually -

If you would like to install the project manually, you will need to place the binary
somewhere in your `PATH` and setup a service to run it. The following commands is
a manual install for a Linux system using systemd:

> Note that the release packages will install to /usr/bin which is reserved for binaries managed by a package manager. Manual installation doesn't involve a package manager and thus uses /usr/local/bin and the service file must be edited to reflect this
```shell
install -o root -g root -m 0755 cri-dockerd /usr/local/bin/cri-dockerd
install packaging/systemd/* /etc/systemd/system
Expand Down Expand Up @@ -118,23 +121,23 @@ The first tool is ginkgo. It can be installed using the project's
[installation instructions](https://onsi.github.io/ginkgo/#getting-started) or using the following
commands:

``` bash
```bash
go install github.com/onsi/ginkgo/v2/ginkgo@latest
```

The next tool is cri-tools. This is a suite of tools that will run tests against cri-dockerd in order
The next tool is cri-tools. This is a suite of tools that will run tests against cri-dockerd in order
to test compatibility with the kubernetes CRI. This can be installed using the following:

``` bash
```bash
curl -s https://api.github.com/repos/kubernetes-sigs/cri-tools/releases/latest | grep "critest-.*-linux-amd64.tar.gz" | cut -d : -f 2,3 | tr -d \" | wget -qi -
tar -zxvf critest-*-linux-amd64.tar.gz critest
cp critest /usr/local/bin/
rm critest*
```

The integration script will find these tools on your local system and copy them into the minikube
VM. It will then run a command to start running the tests.
VM. It will then run a command to start running the tests.

``` bash
```bash
make integration
```

0 comments on commit f955709

Please sign in to comment.