rename to huawei vrp

clab/register.go

@@ -17,7 +17,7 @@ import (
 	fortinet_fortigate "github.com/srl-labs/containerlab/nodes/fortinet_fortigate"
 	generic_vm "github.com/srl-labs/containerlab/nodes/generic_vm"
 	host "github.com/srl-labs/containerlab/nodes/host"
-	huawei_n40e "github.com/srl-labs/containerlab/nodes/huawei_n40e"
+	huawei_vrp "github.com/srl-labs/containerlab/nodes/huawei_vrp"
 	cisco_iol "github.com/srl-labs/containerlab/nodes/iol"
 	ipinfusion_ocnos "github.com/srl-labs/containerlab/nodes/ipinfusion_ocnos"
 	k8s_kind "github.com/srl-labs/containerlab/nodes/k8s_kind"
@@ -96,5 +96,5 @@ func (c *CLab) RegisterNodes() {
 	border0.Register(c.Reg)
 	k8s_kind.Register(c.Reg)
 	cisco_iol.Register(c.Reg)
-	huawei_n40e.Register(c.Reg)
+	huawei_vrp.Register(c.Reg)
 }

docs/manual/kinds/huawei_vrp.md

@@ -0,0 +1,88 @@
+---
+search:
+  boost: 4
+kind_code_name: huawei_vrp
+kind_display_name: Huawei VRP
+---
+# [[[ kind_display_name ]]]
+
+[[[ kind_display_name ]]] virtualized router is identified with `[[[ kind_code_name ]]]` kind in the [topology file](../topo-def-file.md). It is built using [vrnetlab](../vrnetlab.md) project and essentially is a Qemu VM packaged in a docker container format.
+
+[[[ kind_display_name ]]] currently supports Huawei N40e and CE12800 variants, the same kind value - `[[[ kind_code_name ]]]` - is used for both.
+
+[[[ kind_display_name ]]] nodes launched with containerlab comes up pre-provisioned with SSH, SNMP, NETCONF, NXAPI and gRPC services enabled.
+
+## Managing [[[ kind_display_name ]]] nodes
+
+/// note
+Containers with [[[ kind_display_name ]]] inside will take ~3min to fully boot without a startup config file. And ~5-7 minute if the startup config file is provided, since a node will undergo a reboot.  
+You can monitor the progress with `docker logs -f <container-name>`.
+///
+
+[[[ kind_display_name ]]] node launched with containerlab can be managed via the following interfaces:
+
+/// tab | CLI
+to connect to the [[[ kind_display_name ]]] CLI
+
+```bash
+ssh admin@<container-name/id>
+```
+
+///
+/// tab | bash
+to connect to a `bash` shell of a running [[[ kind_display_name ]]] container:
+
+```bash
+docker exec -it <container-name/id> bash
+```
+
+///
+
+/// tab | NETCONF
+NETCONF server is running over port 830
+
+```bash
+ssh admin@<container-name> -p 830 -s netconf
+```
+
+///
+
+## Credentials
+
+Default user credentials: `admin:admin`
+
+## Interface naming
+
+The example ports above would be mapped to the following Linux interfaces inside the container running the [[[ kind_display_name ]]] VM:
+
+* `eth0` - management interface connected to the containerlab management network (rendered as `GigabitEthernet0/0/0` in the VRP config)
+* `eth1` - first data interface, mapped to the first data port of the VM (rendered as `Ethernet1/0/0`)
+* `eth2+` - second and subsequent data interfaces, mapped to the second and subsequent data ports of the VM (rendered as `Ethernet1/0/1` and so on)
+
+When containerlab launches [[[ kind_display_name ]]] node the management interface of the VM gets assigned `10.0.0.15/24` address from the QEMU DHCP server. This interface is transparently stitched with container's `eth0` interface such that users can reach the management plane of the [[[ kind_display_name ]]] using containerlab's assigned IP.
+
+Data interfaces `Ethernet1/0/0+` need to be configured with IP addressing manually using CLI or other available management interfaces.
+
+## Features and options
+
+### Node configuration
+
+[[[ kind_display_name ]]] nodes come up with a basic configuration where only `admin` user and management interfaces such as SSH and NETCONF provisioned.
+
+#### Startup configuration
+
+It is possible to make [[[ kind_display_name ]]] nodes boot up with a user-defined startup-config instead of a built-in one. With a [`startup-config`](../nodes.md#startup-config) property of the node/kind user sets the path to the config file that will be mounted to a container and used as a startup-config:
+
+```yaml
+topology:
+  nodes:
+    node:
+      kind: [[[ kind_code_name ]]]
+      startup-config: myconfig.txt
+```
+
+With this knob containerlab is instructed to take a file `myconfig.txt` from the directory that hosts the topology file, and copy it to the lab directory for that specific node under the `/config/startup-config.cfg` name. Then the directory that hosts the startup-config dir is mounted to the container. This will result in this config being applied at startup by the node.
+
+Configuration is applied after the node is started, thus it can contain partial configuration snippets that you desire to add on top of the default config that a node boots up with.
+
+The node is first provisioned with the [bootstrap config](), then the startup config

mkdocs.yml

@@ -43,6 +43,7 @@ nav:
               - FTOS10v: manual/kinds/vr-ftosv.md
               - Enterprise SONiC: manual/kinds/dell_sonic.md
           - MikroTik RouterOS: manual/kinds/vr-ros.md
+          - Huawei VRP: manual/kinds/huawei_vrp.md
           - IPInfusion OcNOS: manual/kinds/ipinfusion-ocnos.md
           - OpenBSD: manual/kinds/openbsd.md
           - FreeBSD: manual/kinds/freebsd.md

nodes/huawei_n40e/huawei_n40e.go → nodes/huawei_vrp/huawei_vrp.go

@@ -2,7 +2,7 @@
 // Licensed under the BSD 3-Clause License.
 // SPDX-License-Identifier: BSD-3-Clause
 
-package huawei_n40e
+package huawei_vrp
 
 import (
 	"context"
@@ -17,7 +17,7 @@ import (
 )
 
 var (
-	kindnames          = []string{"huawei_n40e"}
+	kindnames          = []string{"huawei_vrp"}
 	defaultCredentials = nodes.NewCredentials("admin", "admin")
 )
 
@@ -31,15 +31,15 @@ const (
 // Register registers the node in the NodeRegistry.
 func Register(r *nodes.NodeRegistry) {
 	r.Register(kindnames, func() nodes.Node {
-		return new(huawei_n40e)
+		return new(huawei_vrp)
 	}, defaultCredentials)
 }
 
-type huawei_n40e struct {
+type huawei_vrp struct {
 	nodes.VRNode
 }
 
-func (n *huawei_n40e) Init(cfg *types.NodeConfig, opts ...nodes.NodeOption) error {
+func (n *huawei_vrp) Init(cfg *types.NodeConfig, opts ...nodes.NodeOption) error {
 	// Init VRNode
 	n.VRNode = *nodes.NewVRNode(n)
 	// set virtualization requirement
@@ -71,7 +71,7 @@ func (n *huawei_n40e) Init(cfg *types.NodeConfig, opts ...nodes.NodeOption) erro
 	return nil
 }
 
-func (s *huawei_n40e) PreDeploy(_ context.Context, params *nodes.PreDeployParams) error {
+func (s *huawei_vrp) PreDeploy(_ context.Context, params *nodes.PreDeployParams) error {
 	utils.CreateDirectory(s.Cfg.LabDir, 0777)
 	_, err := s.LoadOrGenerateCertificate(params.Cert, params.TopologyName)
 	if err != nil {
@@ -80,7 +80,7 @@ func (s *huawei_n40e) PreDeploy(_ context.Context, params *nodes.PreDeployParams
 	return nodes.LoadStartupConfigFileVr(s, configDirName, startupCfgFName)
 }
 
-func (n *huawei_n40e) SaveConfig(_ context.Context) error {
+func (n *huawei_vrp) SaveConfig(_ context.Context) error {
 	err := netconf.SaveConfig(n.Cfg.LongName,
 		defaultCredentials.GetUsername(),
 		defaultCredentials.GetPassword(),

schemas/clab.schema.json

@@ -100,7 +100,7 @@
                         "cisco_iol",
                         "cvx",
                         "cumulus_cvx",
-                        "huawei_n40e",
+                        "huawei_vrp",
                         "openbsd",
                         "freebsd",
                         "generic_vm",
@@ -1014,6 +1014,9 @@
                         "freebsd": {
                             "$ref": "#/definitions/node-config"
                         },
+                        "huawei_vrp": {
+                            "$ref": "#/definitions/node-config"
+                        },
                         "generic_vm": {
                             "$ref": "#/definitions/node-config"
                         }