Tutorial of MongoDB and Iperf using Docker

This tutorial will guide you through the deployment of a Mongo DB Docker container.

Common Requirements

You will need three Open Baton Components:

• NFVO
• Docker VNFM
• Docker VIM Driver

and a reachable Docker engine, usually where the Open Baton platform is running, but not necessarily.

Setup

In order to start manually the Docker VNFM and VIM Driver, please follow these README: VNFM and VIM Driver. When the VNFM and the VIM Driver are running, the NFVO Dashboard should show in the VNF Manager page the Docker VNFM and in the installed vim driver the Docker Vim Driver.

After this you should be able to register the Docker Engine as a PoP:

{
  "name": "vim-instance",
  "authUrl": "unix:///var/run/docker.sock",
  "tenant": "1.32",
  "username": "admin",
  "password": "openbaton",
  "type": "docker",
  "location": {
    "name": "Berlin",
    "latitude": "52.525876",
    "longitude": "13.314400"
  }
}

• authUrl either you pass the unix socket, in this case will use the socket running locally to the vim driver or the host connection string for remote execution
• tenant in the tenant you can specify the api version used by the chosen docker engine
• type is docker if the Docker VIM Driver uses the default type value

after registering your PoP, you should be able to see all images and networks in the PoP page of the NFVO Dashboard

After this step you can pass to the VNF Package. If you don't know what it is or how to create one follow this guide. However, the content of the Metadata.yaml and of the vnfd.json can be as follow:

MongoDB VNF Package

{
    "name": "MongoDB",
    "vendor": "TUB",
    "version": "0.2",
    "lifecycle_event": [],
    "configurations": {
      "configurationParameters": [{
        "confKey":"KEY",
        "value":"Value"
      }],
      "name": "mongo-configuration"
    },
    "virtual_link": [{
      "name": "new-network"
    }],
    "vdu": [{
      "vm_image": [
      ],
      "scale_in_out": 2,
      "vnfc": [{
        "connection_point": [{
          "virtual_link_reference": "new-network"
        }]
      }]
    }],
    "deployment_flavour": [{
      "flavour_key": "m1.small"
    }],
    "type": "mongodb",
    "endpoint": "docker"
  }

Where:

• The Virtual Link will be a new Docker Network created if not existing.
• The flavour_key must be set to m1.small (at the moment)
• The vm_image will be filled by the metadata image name (see next section)

The Metadata.yaml

name: MongoDB
description: MongoDB
provider: TUB
nfvo_version: 5.0.0
vim_types:
 - docker
image:
    upload: "check"
    names:
        - "mongo:latest"
    link: "mongo:latest"
image-config:
    name: "mongo:latest"
    diskFormat: QCOW2
    containerFormat: BARE
    minCPU: 0
    minDisk: 0
    minRam: 0
    isPublic: false

Where:

• vim_types must have docker (pointing to the Docker VIM Driver)
• image upload can be put to check in order to execute docker pull with the image link in case the image name is not available. NOTE: the image name must be the same as the link since in docker there is not distinction
• image-config the name must be the same as the link. the Disk Format and container format are ignored so you can use "QCOW2" and "BARE", as well as for the limits, everything can be 0,

You can then create and upload the tar file to the VNF Package page of the Dashboard and you should have a VNFD called in this case MongoDB that represent a MongoDB Container.

Afterwards, from the NSD page, you can create a NSD using the form and selecting the MongoDB VNF.

Iperf NSD

This tutorial will guide you through the deployment of Iperf client and server in two different Docker containers.

This tutorial is different since you don't have to create a VNFPackage but you need to build two Docker images.

Create a file called Dockerfile for the Iperf client image that looks like:

FROM networkstatic/iperf3

ENTRYPOINT  iperf3 -c $SERVER_HOSTNAME -t 300

and then you can build it as:

docker build -t iperfclient .

Do the same for the Iperf server:

FROM networkstatic/iperf3

EXPOSE 5201

ENTRYPOINT ["iperf3", "-s"]

and build it with:

docker build -t iperfserver .

After this, you need to refresh the VIM on order to see the new images: go to Manage PoPs→PoP instances→ID and click on the two round arrows close to the name. This will trigger the Vim refresh.
Afterwards, you need to create a NSD. From the NFVO dashboard, go to Catalogue→NS Descriptors→On Board NSD→Upload JSON and paste this JSON content:

{
  "name": "docker Iperf",
  "vendor": "fokus",
  "version": "0.1-ALPHA",
  "vld": [{
    "name": "new-network"
  }],
  "vnfd": [{
    "name": "server",
    "vendor": "TUB",
    "version": "0.2",
    "lifecycle_event": [

    ],
    "configurations": {
      "configurationParameters": [],
      "name": "server-configuration"
    },
    "virtual_link": [{
      "name": "new-network"
    }],
    "vdu": [{
      "vm_image": [
        "iperfserver:latest"
      ],
      "scale_in_out": 2,
      "vnfc": [{
        "connection_point": [{
          "virtual_link_reference": "new-network"
        }]
      }]
    }],
    "deployment_flavour": [{
      "flavour_key": "m1.small"
    }],
    "type": "server",
    "endpoint": "docker"
  }, {
    "name": "client",
    "vendor": "TUB",
    "version": "0.2",
    "lifecycle_event": [

    ],
    "configurations": {
      "configurationParameters": [],
      "name": "server-configuration"
    },
    "virtual_link": [{
      "name": "new-network"
    }],
    "vdu": [{
      "vm_image": [
        "iperfclient:latest"
      ],
      "scale_in_out": 2,
      "vnfc": [{
        "connection_point": [{
          "virtual_link_reference": "new-network"
        }]
      }]
    }],
    "deployment_flavour": [{
      "flavour_key": "m1.small"
    }],
    "type": "client",
    "endpoint": "docker"
  }],
  "vnf_dependency": [{
    "source": {
      "name": "server"
    },
    "target": {
      "name": "client"
    },
    "parameters": [
      "hostname"
    ]
  }]
}

and launch the NSD.