Skip to content

Update the kind tutorial and call the configuration keys fields - #1212

Open
cmainas wants to merge 2 commits into
mainfrom
docs/kind_tutorial_update
Open

cmainas wants to merge 2 commits into
mainfrom
docs/kind_tutorial_update

Conversation

@cmainas

@cmainas cmainas commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Description

The kind tutorial did not work on a current kind node. The tutorial replaced the containerd configuration of the node with containerd config default. The default configuration has a newer format than the appended urunc runtime table. As a result, containerd ignored the urunc runtime. The tutorial also ended before any request reached NGINX.

This PR changes the tutorial and installs urunc with urunc-deploy, as the Kubernetes tutorial does. The tutorial does not edit the containerd configuration or builds monitors by hand. Furthermore, since kind node runs in a Docker container and the host cannot reach the Pods directly, add in the tutorial a step for a port mapping of the cluster exposes port 30080 of the node as port 8080 of the host. A NodePort Service forwards port 30080 to NGINX making a curl from the host get the NGINX page.

In addition, change the installation guide to take the monitors-build release from docs/variables/versions.yml. A new release needs a change only in versions.yml. The commands pick the archive of the host's architecture through the GitHub API and verify its SHA-256 checksum. The installation guide also gets a few fixes:

  • The name of the urunc runtime table depends on the version field of the containerd configuration, not on the containerd release.
  • The old containerd config migrate command wrote the output to the input file. The shell empties the input file before containerd reads the input file. The new command writes to a new file first and then replaces the old file.
  • Building solo5-hvt and solo5-spt requires libseccomp-dev and pkg-config.
  • The link to the extra binaries section of the configuration page works again.

At last, use the word "fields" for the keys of urunc's configuration instead of "options". The docs use "options" for the command line options of the monitors too. The anchors #monitor-options and #extra-binaries-options become #monitor-fields and #extra-binaries-fields. No page links to the old anchors.

Related issues

How was this tested?

Running the kind tutorial.

LLM usage

Opus 5.5 for grammar and spelling fixes.

Checklist

  • I have read the contribution guide.
  • The linter passes locally (make lint).
  • The e2e tests of at least one tool pass locally (make test_ctr, make test_nerdctl, make test_docker, make test_crictl).
  • If LLMs were used: I have read the llm policy.

The kind tutorial replaced the containerd configuration of the kind
node with `containerd config default`, which uses the newer format of
containerd. The urunc runtime that the tutorial then appended in the old
format was ignored. The tutorial also installed Qemu from the
distribution, Firecracker from its release and Solo5 from source, and
cloned urunc from its old repository.

Install urunc with urunc-deploy instead. It installs urunc and the
monitors in the node and adds urunc to the existing containerd
configuration, in the same format. Hence, nothing needs to be built or
installed in the node by hand. Nested virtualization is not needed
either, since the kind node is a container. To reach NGINX from the
host, expose it with a `NodePort` Service and map that port of the node
to port 8080 of the host. Also, indent the content of each step by 4
spaces, so that mkdocs renders each step as a single list.

In the installation guide, take the monitors-build release from
docs/variables/versions.yml and pick the archive of the architecture
through the GitHub API. Note that solo5-hvt also needs libseccomp-dev.
Finally, write the output of `containerd config migrate` to a new file,
since redirecting it to the configuration file emptied that file before
containerd could read it.

Signed-off-by: Charalampos Mainas <charalampos.mainas@gmail.com>
The keys of urunc's configuration file (e.g. path and socket_path) are
TOML fields, but the docs called them options. So change the docs to
refer them as fields in the text. The anchors of the monitor and extra
binary sections become #monitor-fields and #extra-binaries-fields.

Signed-off-by: Charalampos Mainas <charalampos.mainas@gmail.com>
@netlify

netlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for urunc ready!

Name Link
🔨 Latest commit 45e9015
🔍 Latest deploy log https://app.netlify.com/projects/urunc/deploys/6afd68e056cb096f3a344f13
😎 Deploy Preview https://deploy-preview-1212--urunc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@cmainas
cmainas marked this pull request as ready for review November 18, 2026 11:04
@cmainas
cmainas requested a review from ananos November 18, 2026 11:04

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: fix outdated containerd config and add service exposure in kind tutorial

1 participant