Skip to content

Commit

Permalink
mgmt -> bridge and node -> runtime added
Browse files Browse the repository at this point in the history
  • Loading branch information
steiler committed Jul 16, 2021
1 parent f388bf5 commit a49b16f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/manual/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,23 @@ my-node:
network-mode: host
```

The `network-mode` configuration option set to `host` will launch the node in the [host networking mode](https://docs.docker.com/network/host/).
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.

Besides that, the container engine "containerd" as well as the Virtual Machine (VM) manager with a container UX.

Options for the runtime parameter are:
- `docker`
- `containerd`
- `ignite`

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
my-node:
image: alpine:3
runtime: containerd
```
14 changes: 14 additions & 0 deletions schemas/clab.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@
}
}
},
"runtime": {
"type": "string",
"description": "Runtime used to execute the container node",
"markdownDescription": "[Runtime](https://containerlab.srlinux.dev/manual/nodes/#runtime) for the node",
"enum": [
"docker",
"containerd",
"ignite"
]
},
"mgmt_ipv4": {
"type": "string",
"description": "IPv4 management address of the node (e.g. 172.10.10.11)",
Expand Down Expand Up @@ -223,6 +233,10 @@
"description": "management network name",
"type": "string"
},
"bridge": {
"description": "Define the underlaying bridge to use for the management network.",
"type": "string"
},
"ipv4_subnet": {
"description": "IPv4 range to be used for the custom management network. e.g. 172.100.100.0/24",
"type": "string",
Expand Down

0 comments on commit a49b16f

Please sign in to comment.