Update documentation and add default DOCKER_GWBRIDGE_IP value (#4)

Signed-off-by: Simon Misencik <[email protected]>

README.md

@@ -11,3 +11,16 @@ You can specify requered cli and netconf devices in devices.csv file.
 - count_of_devices - netconf device specific value. Count of devices
 - starting_port - netconf device specific value. First port of netconf testool
 
+### Docker compose setup
+
+```
+docker-compose up -d
+```
+
+### Kubernetes setup
+
+```
+helm repo add frinx https://FRINXio.github.io/helm-charts
+helm install [RELEASE_NAME] frinx/sample-topology
+```
+more info at https://artifacthub.io/packages/helm/frinx-helm-charts/sample-topology

devices.csv

@@ -15,7 +15,4 @@ cli,leaf4,10012,-,-,-
 cli,leaf5,10013,-,-,-
 cli,spine1,10014,-,-,-
 cli,spine2,10015,-,-,-
-netconf,iosxr653_1,17000,cisco-iosxr-653,2,17000
-netconf,iosxr653_2,17001,cisco-iosxr-653,2,17000
-netconf,iosxr663_1,17100,cisco-iosxr-663,1,17100
-netconf,junos_1,17200,junos-16-2021,1,17200
+

docker-compose.yaml

@@ -0,0 +1,11 @@
+version: "3.7"
+
+services:
+  sample-topology:
+    image: frinx/sample-topology:3.2.0
+    volumes:
+      - ./devices.csv:/sample-topology/devices.csv
+    ports:
+      - 17000-17200:17000-17200
+    command:
+      python2.7 main.py

main.py

@@ -62,7 +62,7 @@ def pushConfigToNetconfTesttool(devices):
             LOG.info("Device {} is ready".format(device["device_name"]))
 
 def push_operation_data_to_device(port, operation_data):
-    m = manager.connect(host=os.getenv('DOCKER_GWBRIDGE_IP'), port=port, username="frinx",
+    m = manager.connect(host=os.getenv('DOCKER_GWBRIDGE_IP', 'localhost'), port=port, username="frinx",
                         password="frinx", hostkey_verify=False)
 
     netconf_operation_data = open(str(operation_data)).read()