.gitignore

@@ -58,3 +58,6 @@ applications/venv-manager/*.clab.yaml
 
 #debug
 __debug_bin
+
+#misc
+*/mongo_backup_*.tar

README.md

@@ -19,6 +19,7 @@ to get all submodules.
 - [Contributing](CONTRIBUTING.md)
 - [License](LICENSE)
 - [CI Status](#ci-status)
+- [Development Tutorial](#development-tutorial)
 
 # Overview
 
@@ -122,3 +123,20 @@ Information about how to use the CLI is provided in the `cli` folder, see [here]
 | ------ | ------ |
 | [![coverage report](https://code.fbi.h-da.de/danet/gosdn/badges/master/coverage.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/master) | [![coverage report](https://code.fbi.h-da.de/danet/gosdn/badges/develop/coverage.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/develop) |
 | [![pipeline status](https://code.fbi.h-da.de/danet/gosdn/badges/master/pipeline.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/master) | [![pipeline status](https://code.fbi.h-da.de/danet/gosdn/badges/develop/pipeline.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/develop) |
+
+# Development Tutorial
+
+TBD
+
+## Backup and restore your mongodb
+
+If you are using the mongodb provided via the `docker-compose.yaml`, you can easily backup and restore your data via two scripts.
+
+```bash
+./scripts/backup_mongo_volume.sh $(suffix_of_backup)
+```
+```bash
+./scripts/restore_mongo_volume.sh $(suffix_of_backup)
+```
+
+Keep in mind that a restore will restart the mongodb container.

applications/venv-manager/main.go

@@ -4,6 +4,7 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"strings"
 
 	venvmanager "code.fbi.h-da.de/danet/gosdn/applications/venv-manager/venv-manager"
 	"google.golang.org/grpc"
@@ -25,11 +26,13 @@ func main() {
 		fmt.Printf("Usable flags of the venv-manager:\n\n")
 		fmt.Println("--controller string\n\t Controller URL and Port. (Default: 'localhost:55055')")
 		fmt.Println("--file string\n\t Filename of the resulting topology file. (Default: 'venv.clab.yaml')")
-		fmt.Println("--registry string\n\t URL of the container registry to use. Keep in mind that cEOS images are not available on dockerhub. (Default: dockerhub)")
+		fmt.Println("--registry string\n\t URL of the container registry to use. Keep in mind that cEOS images and prebuild linux images with the gnmi target are not available on dockerhub. (Default: dockerhub)")
 		fmt.Println("--help\n\t Shows this help screen.")
 	}
 	flag.Parse()
 
+	customContainerRegistryURL = ensureLastCharIsSlash(customContainerRegistryURL)
+
 	fmt.Println("I will try to connect to goSDN located at", dialConnectionURL)
 	venvManager := venvmanager.NewVenvManager(dialConnectionURL, dialOption, yamlFilepath, customContainerRegistryURL)
 
@@ -50,3 +53,16 @@ func main() {
 	}
 	os.Exit(0)
 }
+
+// Ensures that the last char of a string is a slash, if this string is not empty.
+func ensureLastCharIsSlash(inputString string) string {
+	if len(inputString) == 0 {
+		return inputString
+	}
+
+	if strings.HasSuffix(inputString, "/") {
+		return inputString
+	}
+
+	return inputString + "/"
+}

applications/venv-manager/node/node.go

@@ -23,12 +23,33 @@ func (n Node) GetID() string {
 
 // FillAllFields fills all remaining fields of object with data from YangData.
 func (n *Node) FillAllFields(containerRegistryURL string) {
-	// make switch case here to differentialte between linux, arista, etc
+	// Works if linux and our gnmi target is used.
+	softwareVersion := n.YangData.System.State.SoftwareVersion
+	if softwareVersion != nil {
+		// Checks if software version is in compatible format.
+		result, _ := regexp.MatchString(`^([A-Za-z0-9\.\/])*:([A-Za-z0-9\.])*`, *softwareVersion)
+		if result {
+			n.Kind = "linux"
+			n.Image = containerRegistryURL + *softwareVersion
+			return
+		}
 
-	// specific to arista
+		n.Kind = "couldn't detect kind"
+		n.Image = "couldn't detect image"
+		return
+	}
+
+	// Specific to arista
 	regex := regexp.MustCompile(`[0-9]+\.[0-9]+\.[0-9][A-Z]`)
 	dockerTag := string(regex.FindAll([]byte(*n.YangData.Lldp.Config.SystemDescription), 1)[0])
 
+	// If it's not linux with our gnmi target and not arista, we don't support it.
+	if len(dockerTag) == 0 {
+		n.Kind = "couldn't detect kind"
+		n.Image = "couldn't detect image"
+		return
+	}
+
 	n.Kind = "ceos"
 	n.Image = containerRegistryURL + n.Kind + ":" + dockerTag
 }

applications/venv-manager/venv-manager/venv-manager.go

@@ -194,7 +194,7 @@ func (v *VenvManager) loadNetworkElementModelPathsIntoGosdn(ctx context.Context,
 	pndService := pndPb.NewPndServiceClient(conn)
 
 	for _, node := range *nodes {
-		_, err := pndService.GetPath(ctx, &pndPb.GetPathRequest{Mneid: node.ID, Pid: v.pnd, Path: "lldp"})
+		_, err := pndService.GetPath(ctx, &pndPb.GetPathRequest{Mneid: node.ID, Pid: v.pnd, Path: "/"})
 		if err != nil {
 			return err
 		}
@@ -215,7 +215,7 @@ func (v *VenvManager) getAndAddMoreData(topologyData *topology.GoSdnTopology) (*
 	// Create 'root' path to be able to load the whole model from the store.
 	path, err := ygot.StringToPath("/", ygot.StructuredPath)
 	if err != nil {
-		panic(err)
+		return nil, err
 	}
 
 	// just to load model data into goSDN to have newest data available for get request

controller/nucleus/principalNetworkDomain_test.go

@@ -271,8 +271,8 @@ func Test_pndImplementation_MarshalNetworkElement(t *testing.T) {
 	}{
 		{
 			name:    "default",
+			want:    "{\n\t\"Acl\": null,\n\t\"Bfd\": null,\n\t\"Components\": null,\n\t\"Interfaces\": null,\n\t\"Keychains\": null,\n\t\"Lldp\": null,\n\t\"Messages\": null,\n\t\"NetworkInstances\": null,\n\t\"RoutingPolicy\": null,\n\t\"System\": null\n}",
 			args:    args{mneid},
-			want:    "{\n\t\"Acl\": null,\n\t\"Bfd\": null,\n\t\"Components\": null,\n\t\"Interfaces\": null,\n\t\"Keychains\": null,\n\t\"Lldp\": null,\n\t\"LocalRoutes\": null,\n\t\"Messages\": null,\n\t\"NetworkInstances\": null,\n\t\"RoutingPolicy\": null,\n\t\"System\": null\n}",
 			wantErr: false,
 		},
 	}

gosdn.clab.yaml

@@ -114,4 +114,3 @@ topology:
     - endpoints: ["ceos0:eth1","ceos1a:eth1"]
     - endpoints: ["ceos0:eth2","centos1:eth1"]
     - endpoints: ["ceos1a:eth2","centos2:eth1"]
-

YangModels @ 5c289956

-Subproject commit 2fa291d6bdb4b281d4e1b3dfa3254ffa7257d800
+Subproject commit 5c289956f96fb2e4b1969c0da0bf21884c40a6eb

arista @ f546d90c

-Subproject commit 6f1bbc3467842761ee29d282ee850489ca4bc4b5
+Subproject commit f546d90c604cd95c3112484d905ac243985318ab

openconfig @ 103538c4

-Subproject commit e3fa98e0d27cf7fecf75c71d31316f45c83ddfd6
+Subproject commit 103538c4a2766cd210e123b84f562be14d54ea68

scripts/backup_mongo_volume.sh

+#!/bin/sh
+
+file_suffix=$1
+
+docker-compose pause mongo
+docker run --rm --volumes-from gosdn-mongo-1 -v $(pwd)/docker_volume_backup:/backup ubuntu bash -c 'cd /data/db/ && tar cvf /backup/mongo_backup_'"$file_suffix"'.tar .'
+docker-compose unpause mongo

scripts/restore_mongo_volume.sh

+#!/bin/sh
+
+file_suffix=$1
+
+docker-compose pause mongo
+docker run --rm --volumes-from gosdn-mongo-1 -v $(pwd)/docker_volume_backup:/backup ubuntu bash -c 'rm -r /data/db/* && cd /data/db && tar xvf /backup/mongo_backup_'"$file_suffix"'.tar --strip 1'
+docker-compose restart mongo

scripts/test-add-three-devices.sh

+if [ $# -eq 0 ]
+  then
+    echo 'you need to provide the password for the admin user'
+    exit 1
+fi
+./artifacts/gosdnc login --controller 127.0.0.1:55055 --u admin --p $1
+./artifacts/gosdnc pnd use 5f20f34b-cbd0-4511-9ddc-c50cf6a3b49d
+./artifacts/gosdnc device create -a 172.100.0.11:6030 -u admin -p admin --name="ceos0"
+./artifacts/gosdnc device create -a 172.100.0.12:6030 -u admin -p admin --name="ceos1a"
+./artifacts/gosdnc device create -a 172.100.0.3:7030 -u admin -p admin --name="ubuntu1"
+./artifacts/gosdnc device list