Add tutorial showing how to run CRI-O in kind

[roman-kiselenko]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Small tutorial: How to run CRI-O as container runtime in kind.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

None

[roman-kiselenko]

@cri-o/cri-o-maintainers PTAL 🙏

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.54%. Comparing base (9712c53) to head (1e12bed).
Report is 40 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8170      +/-   ##
==========================================
- Coverage   49.58%   49.54%   -0.04%     
==========================================
  Files         153      153              
  Lines       16930    16961      +31     
==========================================
+ Hits         8394     8404      +10     
- Misses       7489     7510      +21     
  Partials     1047     1047              

[haircommander]

thanks! you've got some markdown lint failures

[kwilczynski]

@roman-kiselenko, given that it's based on your excellent blog post, feel free to ignore my suggestions for the changes to the way how "kind" is styled.

[maiqueb]

Thanks for this. Amazing. Managed to create the cluster with the provided information.

One quick remark though; I have faced an issue with my configuration (I had docker configured to use buildx ...). I could not build the crio image if using buildx ...

Not sure if you want to highlight that.

Thanks again.

[mrunalp]

Awesome! We could keep this updated for newer versions on main branch and release branches will retain version specific instructions.

[mrunalp]

Is it possible to use podman for running the cluster as an alternative to docker?

[maiqueb]

AFAIK yes ... BUT generating the node and base images requires docker. Or used to require :)

Probably better if someone confirmed this.

[roman-kiselenko]

Yeah, AFAIK, there is a lot of different options, and by leveraging KIND_EXPERIMENTAL_PROVIDER variable, you can create a cluster with different runtimes:

• podman
• nerdctl.lima
• finch
• nerdctl

[kwilczynski]

One quick remark though; I have faced an issue with my configuration (I had docker configured to use buildx ...). I could not build the crio image if using build ...

@maiqueb, what sort of issue shave you had? Any errors you can share we could have a look at?

This might be something we want to fix, potentially.

[maiqueb]

One quick remark though; I have faced an issue with my configuration (I had docker configured to use buildx ...). I could not build the crio image if using build ...

@maiqueb, what sort of issue shave you had? Any errors you can share we could have a look at?

This might be something we want to fix, potentially.

Sure thing @kwilczynski. The error happens when I try to build the CRIO img from the node image:

➜  new-cni-verbs-demo docker build --build-arg CRIO_VERSION=$CRIO_VERSION -t kindnode/crio:$CRIO_VERSION .
[+] Building 1.4s (2/2) FINISHED                                                                                    docker-container:kind-builder
 => [internal] load build definition from Dockerfile                                                                                         0.0s
 => => transferring dockerfile: 977B                                                                                                         0.0s
 => ERROR [internal] load metadata for docker.io/kindest/node:latest                                                                         1.2s
------
 > [internal] load metadata for docker.io/kindest/node:latest:
------
WARNING: No output specified with docker-container driver. Build result will only remain in the build cache. To push result image into registry use --push or to load image into docker use --load
Dockerfile:1
--------------------
   1 | >>> FROM kindest/node:latest
   2 |     
   3 |     ARG CRIO_VERSION
--------------------
ERROR: failed to solve: kindest/node:latest: failed to resolve source metadata for docker.io/kindest/node:latest: docker.io/kindest/node:latest: not found

# I'm using buildx
➜  new-cni-verbs-demo cat ~/.docker/config.json      
{
	"auths": {},
	"aliases": {
		"builder": "buildx"
	}
}# 

The weird thing IMO is the image is actually available in docker images:

➜  new-cni-verbs-demo docker images
REPOSITORY                                  TAG                                              IMAGE ID       CREATED         SIZE
...
kindest/node                                latest                                           7acfe6ceb949   28 hours ago    1.06GB
...

This was "fixed" by ... not using buildx :)

➜  new-cni-verbs-demo mv ~/.docker/config.json ~/.docker/config.jsonBACKUP 
➜  new-cni-verbs-demo docker build --build-arg CRIO_VERSION=$CRIO_VERSION -t kindnode/crio:$CRIO_VERSION .
[+] Building 0.3s (6/6) FINISHED                                                                                                   docker:default
 => [internal] load build definition from Dockerfile                                                                                         0.0s
 => => transferring dockerfile: 977B                                                                                                         0.0s
 => [internal] load metadata for docker.io/kindest/node:latest                                                                               0.0s
 => [internal] load .dockerignore                                                                                                            0.0s
 => => transferring context: 2B                                                                                                              0.0s
 => [1/2] FROM docker.io/kindest/node:latest                                                                                                 0.0s
 => CACHED [2/2] RUN echo "Installing Packages ..."     && apt-get clean     && apt-get update -y     && DEBIAN_FRONTEND=noninteractive apt  0.0s
 => exporting to image                                                                                                                       0.0s
 => => exporting layers                                                                                                                      0.0s
 => => writing image sha256:fe153b4a09c05031acc6dc4dc09ec5563df58f5d9332320b17a859918b0caf84                                                 0.0s
 => => naming to docker.io/kindnode/crio:v1.30              

I've also tried to use --load when building, to no avail:

➜  new-cni-verbs-demo mv ~/.docker/config.jsonBACKUP ~/.docker/config.json 
➜  new-cni-verbs-demo docker build --build-arg CRIO_VERSION=$CRIO_VERSION --load -t kindnode/crio:$CRIO_VERSION .
[+] Building 0.6s (2/2) FINISHED                                                                                    docker-container:kind-builder
 => [internal] load build definition from Dockerfile                                                                                         0.0s
 => => transferring dockerfile: 977B                                                                                                         0.0s
 => ERROR [internal] load metadata for docker.io/kindest/node:latest                                                                         0.4s
------
 > [internal] load metadata for docker.io/kindest/node:latest:
------
Dockerfile:1
--------------------
   1 | >>> FROM kindest/node:latest
   2 |     
   3 |     ARG CRIO_VERSION
--------------------
ERROR: failed to solve: kindest/node:latest: failed to resolve source metadata for docker.io/kindest/node:latest: docker.io/kindest/node:latest: not found

[roman-kiselenko]

@maiqueb Thank you for your tip; I've added the note about buildx.

[openshift-ci]

@maiqueb: changing LGTM is restricted to collaborators

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[haircommander]

/approve

LGTM, thank you!
@cri-o/cri-o-maintainers PTAL

[kwilczynski]

/approve
/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: haircommander, kwilczynski, maiqueb, roman-kiselenko

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [haircommander]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment