Skip to content

Commit

Permalink
update kind/ceos.md doc re: cgroup v1 requirement
Browse files Browse the repository at this point in the history
reference issue: #467.  ceos-lab only supports cgroup v1 operation.
this advises users taht they may need to revert their runtime
environment to accomodate this requirement.
  • Loading branch information
sulrich committed Jun 23, 2021
1 parent b2764f1 commit bf4403a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/manual/kinds/ceos.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ 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

0 comments on commit bf4403a

Please sign in to comment.