refactored some wording

srl-labs · Jul 16, 2021 · 5fd654a · 5fd654a
1 parent a49b16f
commit 5fd654a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/docs/cmd/deploy.md b/docs/cmd/deploy.md
@@ -31,6 +31,15 @@ Refer to the [configuration artifacts](../manual/conf-artifacts.md) page to get
 #### max-workers
 With `--max-workers` flag it is possible to limit the amout of concurrent workers that create containers or wire virtual links. By default the number of workers equals the number of nodes/links to create.
 
+#### runtime
+Containerlab nodes can be started by different runtimes, with `docker` being the default one. Besides `docker`, containerlab has experimental support for `containerd` and `ignite` runtimes.
+
+A global runtime can be selected with a global `--runtime | -r` flag that will select a runtime to use. The supported value are:
+
+* `docker` - default
+* `containerd`
+* `ignite`
+
 ### Examples
 
 ```bash

diff --git a/docs/manual/nodes.md b/docs/manual/nodes.md
@@ -288,9 +288,9 @@ my-node:
 The `network-mode` configuration option set to `host` will launch the node in the [host networking mode](https://docs.docker.com/network/host/).
 
 ### runtime
-By default containerlab nodes will be started based on the docker container engine. 
+By default containerlab nodes will be started by `docker` container runtime. Besides that, containerlab has experimental support for `containerd` and `ignite` runtimes.
 
-Besides that, the container engine "containerd" as well as the Virtual Machine (VM) manager with a container UX.
+It is possible to specify a global runtime with a global `--runtime` flag, or set the runtime on a per-node basis:
 
 Options for the runtime parameter are:
 - `docker`
@@ -300,7 +300,7 @@ Options for the runtime parameter are:
 The default runtime can also be influenced via the `CLAB_RUNTIME` environment variable, which takes the same values as mentioned above.
 
 ```yaml
-# example node definition with runtime definition
+# example node definition with per-node runtime definition
 my-node:
   image: alpine:3
   runtime: containerd

diff --git a/schemas/clab.schema.json b/schemas/clab.schema.json
@@ -137,7 +137,7 @@
                 },
                 "runtime": {
                     "type": "string",
-                    "description": "Runtime used to execute the container node",
+                    "description": "Runtime used to launch the container node",
                     "markdownDescription": "[Runtime](https://containerlab.srlinux.dev/manual/nodes/#runtime) for the node",
                     "enum": [
                         "docker",