Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation fix for XRd and Cat9kv #2212

Merged
merged 4 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/manual/kinds/vr-cat9kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ Users can adjust the CPU and memory resources by setting adding appropriate envi
You can manage the [[[ kind_display_name ]]] with containerlab via the following interfaces:

/// tab | bash
to connect to a `bash` shell of a running Cisco CSR1000v container:
to connect to a `bash` shell of a running [[[ kind_display_name ]]] container:

```bash
docker exec -it <container-name/id> bash
```

///
/// tab | CLI
to connect to the Catalyst 9000v CLI
to connect to the [[[ kind_display_name ]]] CLI

```bash
ssh admin@<container-name/id>
Expand Down
36 changes: 28 additions & 8 deletions docs/manual/kinds/xrd.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,37 @@ XRd comes in two [variants](https://xrdocs.io/virtual-routing/tutorials/2022-08-

Containerlab supports only the control-plane flavor of XRd, as it allows to build topologies using virtual interfaces, whereas vrouter requires PCI interfaces to be attached to it.

!!!tip
Consult with [XRd Tutorials](https://xrdocs.io/virtual-routing/tutorials/2022-08-22-xrd-images-where-can-one-get-them/) series to get an in-depth understanding of XRd requirements and capabilities.
/// admonition
type: tip
Consult with [XRd Tutorials](https://xrdocs.io/virtual-routing/tutorials/2022-08-22-xrd-images-where-can-one-get-them/) series to get an in-depth understanding of XRd requirements and capabilities.
///

## Getting XRd

XRd image is available for download only for users who have an active service account[^1].

## Host server requirements

You should increase the value of `user.max_inotify_instances`:
Cisco [xrdocs](https://xrdocs.io/virtual-routing/tutorials/2022-08-22-setting-up-host-environment-to-run-xrd/#making-suggested-corrections-to-the-host-machine) recommends to increase `inotify.max_user_instances` and `inotify.max_user_watches`.

You can do this by executing the following:

```bash
sysctl -w user.max_inotify_instances=64000
sysctl -w fs.inotify.max_user_instances=64000
sysctl -w fs.inotify.max_user_watches=64000
```

To make the settings persist reboots append `fs.inotify.max_user_instances=64000` and `fs.inotify.max_user_watches=64000` to `/etc/sysctl.conf`. You can use the following one-liner:

```
echo -e "fs.inotify.max_user_instances=64000\nfs.inotify.max_user_watches=64000" | sudo tee -a /etc/sysctl.conf
```

/// admonition
type: tip
If using 10+ XRd nodes, you may need to increase the `fs.inotify.max_user_instances` and/or `fs.inotify.max_user_watches` even higher.
///

## Managing XRd nodes

There are several management interfaces supported by XRd nodes:
Expand Down Expand Up @@ -59,8 +75,10 @@ There are several management interfaces supported by XRd nodes:
ssh clab@<container-name> -p 830 -s netconf
```

!!!info
Default credentials: `clab:clab@123`
/// admonition
type: info
Default credentials: `clab:clab@123`
///

## Interfaces mapping

Expand Down Expand Up @@ -127,8 +145,10 @@ With such topology file containerlab is instructed to take a file `xrd.cfg` from

To provide a user-defined config, take the [default configuration template](https://github.com/srl-labs/containerlab/blob/main/nodes/xrd/xrd.cfg) and add the necessary configuration commands without changing the rest of the file. This will result in proper automatic assignment of IP addresses to the management interface, as well as applying user-defined commands.

!!!tip
Check [SR Linux and XRd](../../lab-examples/srl-xrd.md) lab example where startup configuration files are provided to both nodes to see it in action.
/// admonition
type: tip
Check [SR Linux and XRd](../../lab-examples/srl-xrd.md) lab example where startup configuration files are provided to both nodes to see it in action.
///

#### Configuration persistency

Expand Down