added sonic kind

srl-labs · Jan 23, 2021 · 84d8edc · 84d8edc
1 parent e1f4498
commit 84d8edc
Show file tree

Hide file tree

Showing 5 changed files with 196 additions and 1 deletion.
diff --git a/clab/clab.go b/clab/clab.go
@@ -184,6 +184,28 @@ func (c *CLab) ExecPostDeployTasks(ctx context.Context, node *Node, lworkers uin
 		})
 		return err
 
+	case "sonic-vs":
+		log.Debugf("Running postdeploy actions for sonic-vs '%s' node", node.ShortName)
+		// exec `supervisord` to start sonic services
+		execConfig := types.ExecConfig{Tty: false, AttachStdout: false, AttachStderr: false, Cmd: strings.Fields("supervisord")}
+		respID, err := c.DockerClient.ContainerExecCreate(context.Background(), node.ContainerID, execConfig)
+		if err != nil {
+			return err
+		}
+		_, err = c.DockerClient.ContainerExecAttach(context.Background(), respID.ID, execConfig)
+		if err != nil {
+			return err
+		}
+		// exec `/usr/lib/frr/bgpd` to start BGP service
+		execConfig = types.ExecConfig{Tty: false, AttachStdout: false, AttachStderr: false, Cmd: strings.Fields("/usr/lib/frr/bgpd")}
+		respID, err = c.DockerClient.ContainerExecCreate(context.Background(), node.ContainerID, execConfig)
+		if err != nil {
+			return err
+		}
+		_, err = c.DockerClient.ContainerExecAttach(context.Background(), respID.ID, execConfig)
+		if err != nil {
+			return err
+		}
 	}
 	return nil
 }

diff --git a/clab/config.go b/clab/config.go
@@ -27,7 +27,7 @@ const (
 )
 
 // supported kinds
-var kinds = []string{"srl", "ceos", "crpd", "vr-sros", "vr-vmx", "vr-xrv", "linux", "bridge"}
+var kinds = []string{"srl", "ceos", "crpd", "sonic-vs", "vr-sros", "vr-vmx", "vr-xrv", "linux", "bridge"}
 
 var defaultConfigTemplates = map[string]string{
 	"srl":  "/etc/containerlab/templates/srl/srlconfig.tpl",
@@ -110,6 +110,7 @@ type Node struct {
 	Topology             string
 	Sysctls              map[string]string
 	User                 string
+	Entrypoint           string
 	Cmd                  string
 	Env                  map[string]string
 	Binds                []string    // Bind mounts strings (src:dest:options)
@@ -503,6 +504,16 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
 		// mount sshd_config
 		node.Binds = append(node.Binds, fmt.Sprint(path.Join(node.LabDir, "config/sshd_config"), ":/etc/ssh/sshd_config"))
 
+	case "sonic-vs":
+		node.Config = c.configInitialization(&nodeCfg, node.Kind)
+		node.Image = c.imageInitialization(&nodeCfg, node.Kind)
+		node.Group = c.groupInitialization(&nodeCfg, node.Kind)
+		node.Position = c.positionInitialization(&nodeCfg, node.Kind)
+		node.User = user
+
+		// rewrite entrypoint so sonic won't start supervisord before we attach veth interfaces
+		node.Entrypoint = "/bin/bash"
+
 	case "vr-sros":
 		node.Config = c.configInitialization(&nodeCfg, node.Kind)
 		node.Image = c.imageInitialization(&nodeCfg, node.Kind)

diff --git a/docs/lab-examples/srl-sonic.md b/docs/lab-examples/srl-sonic.md
@@ -0,0 +1,124 @@
+|                               |                                                                                            |
+| ----------------------------- | ------------------------------------------------------------------------------------------ |
+| **Description**               | A Nokia SR Linux connected back-to-back with SONiC-VS                                      |
+| **Components**                | [Nokia SR Linux][srl], [SONiC][sonic]                                                      |
+| **Resource requirements**[^1] | :fontawesome-solid-microchip: 1 <br/>:fontawesome-solid-memory: 2 GB                       |
+| **Topology file**             | [srlsonic01.yml][topofile]                                                                 |
+| **Name**                      | srlsonic01                                                                                 |
+| **Version information**[^2]   | `containerlab:0.9.0`, `srlinux:20.6.3-145`, `docker-sonic-vs:202012`, `docker-ce:19.03.13` |
+
+## Description
+A lab consists of an SR Linux node connected with Azure SONiC via a point-to-point ethernet link. Both nodes are also connected with their management interfaces to the `containerlab` docker network.
+
+<div class="mxgraph" style="max-width:100%;border:1px solid transparent;margin:0 auto; display:block;" data-mxgraph="{&quot;page&quot;:0,&quot;zoom&quot;:1.5,&quot;highlight&quot;:&quot;#0000ff&quot;,&quot;nav&quot;:true,&quot;check-visible-state&quot;:true,&quot;resize&quot;:true,&quot;url&quot;:&quot;https://raw.githubusercontent.com/srl-wim/container-lab/diagrams/srlsonic01.drawio&quot;}"></div>
+
+## Use cases
+This lab allows users to launch basic interoperability scenarios between Nokia SR Linux and SONiC operating systems.
+
+### BGP
+<div class="mxgraph" style="max-width:100%;border:1px solid transparent;margin:0 auto; display:block;" data-mxgraph="{&quot;page&quot;:1,&quot;zoom&quot;:1.5,&quot;highlight&quot;:&quot;#0000ff&quot;,&quot;nav&quot;:true,&quot;check-visible-state&quot;:true,&quot;resize&quot;:true,&quot;url&quot;:&quot;https://raw.githubusercontent.com/srl-wim/container-lab/diagrams/srlsonic01.drawio&quot;}"></div>
+
+This lab demonstrates a simple iBGP peering scenario between Nokia SR Linux and SONiC. Both nodes exchange NLRI with their loopback prefix making it reachable.
+
+#### Configuration
+Once the lab is deployed with containerlab, use the following configuration instructions to make interfaces configuration and enable BGP on both nodes.
+
+=== "srl"
+    Get into SR Linux CLI with `docker exec -it clab-srlsonic01-srl sr_cli` and start configuration
+    ```bash
+    # enter candidate datastore
+    enter candidate
+
+    # configure loopback and data interfaces
+    set / interface ethernet-1/1 admin-state enable
+    set / interface ethernet-1/1 subinterface 0 admin-state enable
+    set / interface ethernet-1/1 subinterface 0 ipv4 address 192.168.1.1/24
+
+    set / interface lo0 subinterface 0 admin-state enable
+    set / interface lo0 subinterface 0 ipv4 address 10.10.10.1/32
+    set / network-instance default interface ethernet-1/1.0
+    set / network-instance default interface lo0.0
+
+    # configure BGP
+    set / network-instance default protocols bgp admin-state enable
+    set / network-instance default protocols bgp router-id 10.10.10.1
+    set / network-instance default protocols bgp autonomous-system 65001
+    set / network-instance default protocols bgp group ibgp ipv4-unicast admin-state enable
+    set / network-instance default protocols bgp group ibgp export-policy export-lo
+    set / network-instance default protocols bgp neighbor 192.168.1.2 admin-state enable
+    set / network-instance default protocols bgp neighbor 192.168.1.2 peer-group ibgp
+    set / network-instance default protocols bgp neighbor 192.168.1.2 peer-as 65001
+
+    # create export policy
+    set / routing-policy policy export-lo statement 10 match protocol local
+    set / routing-policy policy export-lo statement 10 action accept
+
+    # commit config
+    commit now
+    ```
+=== "sonic"
+    Get into sonic container shell with `docker exec -it clab-srlsonic01-sonic bash` and configure the so-called _front-panel_ ports.  
+    Since we defined only one data interface for our sonic/srl nodes, we need to confgure a single port:
+    ```bash
+    config interface ip add Ethernet0 192.168.1.2/24
+    config interface startup Ethernet0
+    ```
+    Now when data interface has been configured, enter in the FRR shell to configure BGP by typing `vtysh` command inside the sonic container.
+    ```bash
+    # enter configuration mode
+    configure
+
+    # configure BGP
+    router bgp 65001
+      bgp router-id 10.10.10.2
+      neighbor 192.168.1.1 remote-as 65001
+      address-family ipv4 unicast
+        network 10.10.10.2/32
+      exit-address-family
+    exit
+    access-list all seq 5 permit any
+    ```
+
+#### Verification
+Once BGP peering is established, the routes can be seen in GRT of both nodes:
+
+=== "srl"
+    ```bash
+    A:srl# / show network-instance default route-table ipv4-unicast summary | grep bgp
+    | 10.10.10.2/32                 | 0     | true       | bgp             | 0       | 170   | 192.168.1.2 (indirect)                   | None              |
+    ```
+
+=== "sonic"
+    ```bash
+    sonic# sh ip route
+    Codes: K - kernel route, C - connected, S - static, R - RIP,
+          O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP,
+          T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP,
+          F - PBR, f - OpenFabric,
+          > - selected route, * - FIB route, q - queued route, r - rejected route
+
+    K>* 0.0.0.0/0 [0/0] via 172.20.20.1, eth0, 00:20:55
+    B>* 10.10.10.1/32 [200/0] via 192.168.1.1, Ethernet0, 00:01:51
+    C>* 172.20.20.0/24 is directly connected, eth0, 00:20:55
+    B   192.168.1.0/24 [200/0] via 192.168.1.0 inactive, 00:01:51
+    C>* 192.168.1.0/24 is directly connected, Ethernet0, 00:03:50
+    ```
+
+Data plane confirms that routes have been programmed to FIB:
+```
+sonic# ping 10.10.10.1
+PING 10.10.10.1 (10.10.10.1) 56(84) bytes of data.
+64 bytes from 10.10.10.1: icmp_seq=1 ttl=64 time=2.28 ms
+64 bytes from 10.10.10.1: icmp_seq=2 ttl=64 time=2.84 ms
+```
+
+
+
+[srl]: https://www.nokia.com/networks/products/service-router-linux-NOS/
+[sonic]: https://azure.github.io/SONiC/
+[topofile]: https://github.com/srl-wim/container-lab/tree/master/lab-examples/srlsonic01/srlsonic01.yml
+
+[^1]: Resource requirements are provisional. Consult with the installation guides for additional information.
+[^2]: The lab has been validated using these versions of the required tools/components. Using versions other than stated might lead to a non-operational setup process.
+
+<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/hellt/drawio-js@main/embed2.js" async></script>
diff --git a/docs/manual/kinds/sonic-vs.md b/docs/manual/kinds/sonic-vs.md
@@ -0,0 +1,36 @@
+# SONiC
+
+[SONiC](https://www.juniper.net/documentation/us/en/software/sonic-vs/sonic-vs-deployment/topics/concept/understanding-sonic-vs.html) is identified with `sonic-vs` kind in the [topology file](../topo-def-file.md). A kind defines a supported feature set and a startup procedure of a `sonic-vs` node.
+
+!!!info
+    `vs` in the name of a kind refers to a SONiC palatform type.
+
+sonic-vs nodes launched with containerlab comes without any additional configuration.
+
+## Managing sonic-vs nodes
+SONiC node launched with containerlab can be managed via the following interfaces:
+
+=== "bash"
+    to connect to a `bash` shell of a running sonic-vs container:
+    ```bash
+    docker exec -it <container-name/id> bash
+    ```
+=== "CLI"
+    to connect to the sonic-vs CLI (vtysh)
+    ```bash
+    docker exec -it <container-name/id> vtysh
+    ```
+
+
+## Interfaces mapping
+sonic-vs container uses the following mapping for its linux interfaces:
+
+* `eth0` - management interface connected to the containerlab management network
+* `eth1` - first data (front-panel port) interface
+
+When containerlab launches sonic-vs node, it will assign IPv4/6 address to the `eth0` interface. Data interface `eth1` which is mapped to `Ethernet0` port needs to be configured with IP addressing manually. See Lab examples for exact configurations.
+
+## Lab examples
+The following labs feature sonic-vs node:
+
+- [SR Linux and sonic-vs](../../lab-examples/srl-sonic.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,6 +11,7 @@ nav:
           - srl - Nokia SR Linux: manual/kinds/srl.md
           - crpd - Juniper cRPD: manual/kinds/crpd.md
           - ceos - Arista cEOS: manual/kinds/ceos.md
+          - sonic-vs - SONiC: manual/kinds/sonic-vs.md
           - vr-sros - Nokia SR OS: manual/kinds/vr-sros.md
           - vr-vmx - Juniper vMX: manual/kinds/vr-vmx.md
           - vr-xrv - Cisco XRv: manual/kinds/vr-xrv.md
@@ -33,6 +34,7 @@ nav:
       - 5-stage CLOS: lab-examples/min-5clos.md
       - Nokia SR Linux and Arista cEOS: lab-examples/srl-ceos.md
       - Nokia SR Linux and Juniper cRPD: lab-examples/srl-crpd.md
+      - Nokia SR Linux and SONiC: lab-examples/srl-sonic.md
       - External bridge capability: lab-examples/ext-bridge.md
       - WAN topology: lab-examples/wan.md
       - SR Linux and Nokia SR OS: lab-examples/vr-sros.md