Topology creation

The first step, before creating blueprints with NFVCL, is the creation of the topology. NFVCL needs VIMs (OpenStack instances) to run most of its blueprint. You will see that in the topology creation request there is a list of VIMs, you should add there at least valid one.

Warning

The VIM user must be administrator for the target project

Warning

When adding a VIM, it is really important to use the correct value for the field use_floating_ip, otherwise, the NFVCL cannot talk to the VNF(VM or Pod) if the NFVCL instance is outside the openstack network.

With the next step the OpenStack server will be registered in OSM and NFVCL. The networks of the VIM must be appended to the network list. At least a management network should be present. POST /v1/topology/

Example request body of a working Topology:

{
  "id": "topology",
  "callback": null,
  "vims": [
    {
      "name": "OS-LAB",
      "vim_type": "openstack",
      "schema_version": "1.0",
      "vim_url": "http://os-lab.maas:5000/v3",
      "vim_tenant_name": "exampleuser",
      "vim_user": "exampleuser",
      "vim_password": "examplepassword",
      "config": {
        "insecure": true,
        "APIversion": "v3.3",
        "use_floating_ip": false
      },
      "networks": [
        "dmz-internal",
        "data-net"
      ],
      "routers": [],
      "areas": [
        0,
        1
      ]
    }
  ],
  "kubernetes": [],
  "networks": [
    {
      "name": "dmz-internal",
      "external": false,
      "type": "vxlan",
      "vid": null,
      "dhcp": true,
      "ids": [],
      "cidr": "10.255.255.0/24",
      "gateway_ip": "10.255.255.254",
      "allocation_pool": [],
      "reserved_ranges": [],
      "dns_nameservers": []
    },
    {
      "name": "data-net",
      "external": false,
      "type": "vxlan",
      "vid": null,
      "dhcp": true,
      "ids": [],
      "cidr": "10.255.251.0/24",
      "gateway_ip": null,
      "allocation_pool": [],
      "reserved_ranges": [],
      "dns_nameservers": []
    }
  ],
  "routers": [],
  "pdus": [],
  "prometheus_srv": []
}

The Topology can also be initialized as empty and then it is possible to use the Management APIs to add required data to deploy Blueprints. You can find out more information in the dedicated topology_creation.rst page.

The name field is the name of the topology.

In the vims list, the object representing the OpenStack/Proxmox server fields need to be changed to fit your configuration:

• vim_url: OpenStack API URL

• vim_tenant_name: OpenStack Project name

• vim_user: OpenStack user

• vim_password: OpenStack user password

• networks: List with the names of the OpenStack networks that will be used by blueprints, at least one network is required.

• areas: List of area id covered by this topology

The networks list contain the details of the networks listed in vims[0].networks.