Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The information builds upon and updates legacy information documented here: ONAP vCPE VNF Installation Guide v1.docx.

For information on preparing the VNF images in previous releases, refer to Preparing the vCPE VPP VNF Images for Amsterdam and Beijing.

...

Using the vG-MUX as an example, the following steps are used to create a vG-MUX image which can then be used as the image for instantiating a vG-MUX VNF.

The build template (.yaml and .env) files are located in the ONAP 'demo' repository here:   demo/heat/vCPE_build/[ vgmux | vbng | vbrgemu | vgw ]

  1. The build .yaml file and the associated build .env file are used to invoke the VM which will build the image. The build .yaml will invoke the build script “v_gmux_build.sh”.
    1. This will build vpp and honeycomb code, it may take 30-40 minutes
  2. Log into the VM as the 'ubuntu' user and check that build script has finished executing.
    1. cat /opt/script_status.txt (if that file does not exist, the script is probably still running)
    2. If the script has executed completely and successfully, the output will be “Execution of vG-MUX build script completed”.
    3. If the script has failed to execute successfully, the output will should specify the reason for its failure. For more information, query the contents of the systemd journal using the ‘journalctl’ command. See also: Debugging and troubleshooting.
  3. Clean up some files not required for the final image (this will save several gigabytes):
    1. sudo

      su

      -

    2. rm

      -fr

      /opt/vpp

      /opt/hc2vpp

      /opt/demo

      /opt/script_status.txt

  4. Save an image of the VNF.
    1. openstack

      server

      image

      create

      --name

      vgmux-base-ubuntu-16-04

      <VM

      Name

      or

      ID>

    2. "

    vgmux-base-ubuntu-16-04" will be the name of the new vG-MUX image

...

    1. vgmux-base-ubuntu-16-04" will be the name of the new vG-MUX image

Manually Instantiate a VNF based on the pre-built Image

The template (.yaml and .env) files used to prepare a .zip file for onboarding with SDC and deployment by ONAP are located in the ONAP 'demo' repository here: demo/heat/vCPE/[ infra | vgmux | vbng | vbrgemu | vgw ]

For manual testing, the template files can be used to orchestrate a 'stack' directly in an Openstack cloud.  Just fill out the environment file appropriately.   All of the resources required by the VNFs will need to be set up in the Openstack environment in advance - such as the various Neutron networks and flavors.

  1. Change the base .env file to use the VNF image created using the process described above.

    1. For example - replace "ubuntu-16-04-cloud-amd64" with "vgmux-base-ubuntu-16-04" in "base_vcpe_vgmux.env".

  2. Ensure the base .yaml file does not have the install script commented out.
    1. For example, ensure "v_gmux_install.sh" is not commented out in "base_vcpe_vgmux.yaml".
  3. Create a 'stack'
    1. CLI command:  openstack

      stack

      create

      -t

      base_vcpe_vgmux.yaml

      -e

      base_vcpe_vgmux.env

      vGMUX

    2. Note, remove the "vGMUX" stack that was created during the "Building a VNF Image" stage.
    3. Using the image created above, the install script will perform some configuration steps and complete much more quickly since the VPP and Honeycomb code has already been compiled.

...

Prebuilt images in the ONAP-vCPE Project (as of 08/15/18):

VNF

ONAP-vCPE Image Name

Checksum

vBRG

vbrg-casa-base-ubuntu-16-04

a7e1bb0b991f8807e2c6ee9008b83e21

vBNG

vbng-casa-base-ubuntu-16-

04

04

f30e6f8d07bf68450f0315a6d593e138

vG-MUX

vgmux-casa-base-ubuntu-16-04

f6b46d1133e5576afff245650a354768

vGW

vgw-casa-base-ubuntu-16-04

2482ae8dbe3d7a339f7ffa47478c995e

Compatibility with Amsterdam and Beijing Releases

...

  • To see the full output of the build script:

    Info
    journalctl
    Image Removed


    Image Added

  • To check that the build script is running:

    Info
    ps aux | grep v_xxx_build.sh
  • To check that vpp and honeycomb are running:

    Info
    systemctl status vpp.service
    systemctl status honeycomb.service

Note that the vpp service should be ‘inactive’ after the completion of the build script, and it should be ‘running’ on all machines after the completion of the install script.

Image RemovedImage Added

The honeycomb service should be running on the vBRG, vG-MUX, and vGW after the completion of the install script.

Image RemovedImage Added

This can also be confirmed by running ‘cat /var/log/honeycomb.log’:

  • To check status on vGW of dhcp server:

    systemctl
    Info
    service 
    status
    isc-dhcp-server status
  • To check whether a package is installed using dpkg:

    Info
    dpkg -s [package name]
  • For example: dpkg -s vpp

...

VNF Specific Usage Information

...

Info
titleCLI command to static route
vppctl ip route add 10.3.0.0/24 via 10.1.0.10 GigabitEthernet0/4/0

·         To check whether a package is installed using dpkg:

o   dpkg -s [package name]

...