Skip to content

Commit

Permalink
move cgroups v1 limitations to its own subchapter
Browse files Browse the repository at this point in the history
  • Loading branch information
hellt committed Jun 23, 2021
1 parent bf4403a commit 8630d20
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/manual/kinds/ceos.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,6 @@ topology:
- endpoints: ["ceos_rtr1:et2", "ceos_rtr3:et1"]
```

## cgroup requirements

As of this writing (22-June, 2021), ceos-lab images require a cgroup v1 environment. For many users this should not require any changes to the runtime environment. However, some users (ref: [#467](https://github.com/srl-labs/containerlab/issues/467)) will potentially need to configure their container runtime environment to utilize a cgroup v1 environment. Other cgroup v1-based software (e.g.: Kubernetes) requires a cgroup v1-based runtiem environment as well. Consult your distribution's documentation for details regarding configuring cgroup v1 operation.

## Features and options
### Node configuration
cEOS nodes have a dedicated [`config`](../conf-artifacts.md#identifying-a-lab-directory) directory that is used to persist the configuration of the node. It is possible to launch nodes of `ceos` kind with a basic config or to provide a custom config file that will be
Expand Down Expand Up @@ -217,4 +213,11 @@ The following labs feature cEOS node:

- [SR Linux and cEOS](../../lab-examples/srl-ceos.md)

## Known issues or limitations
### cgroups v1

As of this writing (22-June, 2021), ceos-lab image requires a cgroups v1 environment. For many users this should not require any changes to the runtime environment. However, some linux distributions (ref: [#467](https://github.com/srl-labs/containerlab/issues/467)) may be configured to use cgroups v2 out-of-the-box, which will prevent ceos-lab image from booting. In such cases, the users will need to configure their system to utilize a cgroups v1 environment.

Consult your distribution's documentation for details regarding configuring cgroups v1 in case you see similar startup issues as indicated in [#467](https://github.com/srl-labs/containerlab/issues/467).

[^1]: https://eos.arista.com/ceos-lab-topo/

0 comments on commit 8630d20

Please sign in to comment.