Merge pull request #1147 from trustywolf/xrd-docs

xrd kind - docs improvement
srl-labs · Dec 21, 2022 · 782e78a · 782e78a
2 parents 3efab9a + ff544ec
commit 782e78a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/manual/kinds/xrd.md b/docs/manual/kinds/xrd.md
@@ -24,6 +24,11 @@ XRd image is available for download only for users who have an active service ac
 
 There are several management interfaces supported by XRd nodes:
 
+=== "CLI"
+    to connect to a XR CLI shell of a running XRd container:
+    ```bash
+    docker exec -it <container-name/id> /pkg/bin/xr_cli.sh
+    ```
 === "bash"
     to connect to a `bash` shell of a running XRd container:
     ```bash
@@ -57,7 +62,7 @@ XRd container uses the following mapping for its Linux interfaces[^2]:
 * `Gi0-0-0-0` - first data interface mapped to `Gi0/0/0/0` internal interface.
 * `Gi0-0-0-N` - Nth data interface mapped to `Gi0/0/0/N` internal interface.
 
-When containerlab launches XRd node, it will set IPv4/6 addresses as assigned by docker to the `eth0` interface and XRd node will boot with these addresses configured for its `MgmthEth0`. Data interfaces `Gi0/0/0/N` need to be configured with IP addressing manually.
+When containerlab launches XRd node, it will set IPv4/6 addresses as assigned by docker to the `eth0` interface and XRd node will boot with these addresses configured for its `MgmtEth0`. Data interfaces `Gi0/0/0/N` need to be configured with IP addressing manually.
 
 ```
 RP/0/RP0/CPU0:xrd#sh ip int br

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,6 +78,7 @@ nav:
       - WAN topology: lab-examples/wan.md
       - Nokia SR Linux and Nokia SR OS: lab-examples/vr-sros.md
       - Nokia SR Linux and Juniper vMX: lab-examples/vr-vmx.md
+      - Nokia SR Linux and Cisco XRd: lab-examples/srl-xrd.md
       - Nokia SR Linux and Cisco XRv9k: lab-examples/vr-xrv9k.md
       - Nokia SR Linux and Cisco XRv: lab-examples/vr-xrv.md
       - Nokia SR Linux and FRR: lab-examples/srl-frr.md

diff --git a/nodes/xrd/xrd.go b/nodes/xrd/xrd.go
@@ -146,7 +146,7 @@ func (n *xrd) CheckInterfaceName() error {
 	ifRe := regexp.MustCompile(`^Gi0-0-0-\d+$`)
 	for _, e := range n.Config().Endpoints {
 		if !ifRe.MatchString(e.EndpointName) {
-			return fmt.Errorf("cisco XRd interface name %q doesn't match the required pattern. SR Linux interfaces should be named as Gi0-0-0-X where X is the interface number", e.EndpointName)
+			return fmt.Errorf("cisco XRd interface name %q doesn't match the required pattern. XRd interfaces should be named as Gi0-0-0-X where X is the interface number", e.EndpointName)
 		}
 	}