Manage VM Catalog and Repository
Feature Name |
Release Information |
Description |
---|---|---|
Support for Cisco VM Image Upload in qcow2 Format |
Cisco IOS XE Release 17.7.1a Cisco SD-WAN Release 20.7.1 Cisco vManage Release 20.7.1 |
This feature allows you to upload a virtual machine image to Cisco vManage in qcow2 format. Earlier, you could upload only a prepackaged image file in tar.gz format. |
Cisco vManage supports uploading a prepackaged Cisco virtual machine image, tar.gz, or an image in qcow2 format. It is mandatory to upload a scaffold file if you choose a qcow2 image file. Similarly, you can now select either an image package file or a qcow2 image file with a scaffold file when configuring a Virtual Network Function (VNF) during service chain creation.
A scaffold file contains the following components:
-
VNF metadata (image_properties.xml)
-
System-generated variables from cluster resource pools for service chaining (system_generated_propeties.xml)
-
Tokenized Day-0 configuration files
-
Package manifest file (package.mf)
Alternatively, you can package the VM image by providing a root disk image in any of the supported formats (qcow2). Use the linux command-line NFVIS VM packaging tool, nfvpt.py to package the qcow2 or alternatively create a customized VM image using Cisco vManage. See Create Customized VNF Image.
A VM is SR-IOV capable means sriov_supported is set to true in image_properties.xml in the vm package *.tar.gz. Also, the service chain network is automatically connected to SR-IOV network. If sriov_supported is set to false, an OVS network is created on the data port channel. It’s attached to VM VNICs for service chaining by using the OVS network. For the Cisco SD-WAN Cloud onRamp for Colocation solution, a VM uses homogeneous type of network in service chains. This type of network means it’s either OVS or SR-IOV, and not a combination of SR-IOV and OVS.
Only two data VNICs are attached to any VM–one for inbound traffic and the other for outbound traffic. If more than two data interfaces are required, use subinterfaces configuration within the VM. The VM packages are stored in the VM catalog.
Note |
Each VM type such as firewall can have multiple VM images that are uploaded to Cisco vManage from same or different vendors and added to a catalog. Also, different versions that are based on the release of the same VM can be added to a catalog. However, ensure that the VM name is unique. |
The Cisco VM image format can be bundled as *.tar.gz and can include:
-
Root disk images to boot the VM.
-
Package manifest for checksum validation of the file listing in the package.
-
Image properties file in XML format that lists the VM meta data.
-
(Optional) Day-0 configuration, other files that are required to bootstrap the VM.
-
(Optional) HA Day-0 configuration if VM supports stateful HA.
-
System-generated properties file in XML format that lists the VM system properties.
VM images can be hosted on both HTTP server local repository that Cisco vManage hosts or on the remote server.
If VM is in Cisco NFVIS supported VM package format such as, tar.gz, Cisco vManage performs all the processing and you can provide variable key and values during VNF provisioning.
Note |
Cisco vManage manages the Cisco VNFs, and the Day-1 and Day-N configurations within VNF aren’t supported for other VNFs. See the Cisco NFVIS Configuration Guide, VM Image Packaging for more information about VM package format and content, and samples on image_properties.xml and manifest (package.mf). To upload multiple packages for the same VM, same version, communication manager (CM) type, ensure that one of the three values (name, version, VNF type) are different. Then, you can repackage the VM *.tar.gz to be uploaded. |
VNF Image Format
Cisco vbond Orchestrator doesn’t distinguish between Cisco VNFs and third-party VNFs. All VNFs are categorized based on the services that are provided by the VNF such as router, firewall, load balancer, and others. The package metadata has VM-specific attributes. Based on HA NICs and management NICs specified in the package metadata file, Cisco vBond orchestrator attaches management NIC and HA NIC. By default, management NIC is zero and HA NIC is one. The number of HA NICs that is specified is attached during VNF provisioning.
Upload VNF Images
Procedure
Step 1 |
From the Cisco vManage menu, choose . |
||||
Step 2 |
To add a prepackaged VNF image, click Virtual Images, and then click Upload Virtual Image. |
||||
Step 3 |
Choose the location to store the virtual image.
|
Create Customized VNF Image
Before you begin
-
Create a custom VM package along with image properties and bootstrap files (if needed) into a TAR archive file.
-
Tokenize custom variables and apply system variables that are passed with the bootstrap configuration files.
Ensure that the following custom packaging requirements are met:
-
Root disk image for a VNF–qcow2
-
Day-0 configuration files–system and tokenized custom variables
-
VM configuration–CPU, memory, disk, NICs
-
HA mode–If a VNF supports HA, specify Day-0 primary and secondary files, NICs for a HA link.
-
Additional Storage–If more storage is required, specify predefined disks (qcow2), storage volumes (NFVIS layer)
Procedure
Step 1 |
From the Cisco vManage menu, choose . |
|||||||||||||||||||||||||||
Step 2 |
Click Add Custom VNF Package. |
|||||||||||||||||||||||||||
Step 3 |
Configure the VNF with the following VNF package properties and click Save.
|
|||||||||||||||||||||||||||
Step 4 |
To package a VM qcow2 image, click File Upload, and browse to choose a qcow2 image file. |
|||||||||||||||||||||||||||
Step 5 |
To choose a bootstrap configuration file for VNF, if any, click Day 0 Configuration and click File Upload to browse and choose the file.
|
|||||||||||||||||||||||||||
Step 6 |
To add a Day-0 configuration, click Add, and then click Save. The Day-0 configuration appears in the Day 0 Config File table. You can tokenize the bootstrap configuration variables with system and custom variables. To tokenize variables of a Day-0 configuration file, click View Configuration File next to the desired Day-0 configuration file. In the Day 0 configuration file dialog box, perform the following tasks:
|
|||||||||||||||||||||||||||
Step 7 |
To upload extra VM images, expand Advance Options, click Upload Image, and then browse to choose an extra qcow2 image file. Choose the root disk, Ephemeral disk 1, or Ephemeral disk 2, and click Add. The newly added VM image appears in the Upload Image table.
|
|||||||||||||||||||||||||||
Step 8 |
To add the storage information, expand Add Storage, and click Add volume. Provide the following storage information and click Add. The added storage details appear in the Add Storage table.
|
|||||||||||||||||||||||||||
Step 9 |
To add VNF image properties, expand Image Properties and enter the following image information.
|
|||||||||||||||||||||||||||
Step 10 |
To add VM resource requirements, expand Resource Requirements and enter the following information.
|
|||||||||||||||||||||||||||
Step 11 |
To add day-0 configuration drive options, expand Day 0 Configuration Drive options and enter the following information.
|
View VNF Images
Procedure
Step 1 |
From the Cisco vManage menu, choose . |
Step 2 |
Click Virtual Images. |
Step 3 |
To filter the search results, use the filter option in the search bar. The Software Version column provides the version of the software image. The Software Location column indicates where the software images are stored. Software images can be stored either in the repository on the Cisco vManage server or in a repository in a remote location. The Version Type Name column provides the type of firewall. The Available Files column lists the names of the VNF image files. The Update On column displays when the software image was added to the repository. |
Step 4 |
For the desired VNF image, click ... and choose Show Info. |
Delete VNF Images
Procedure
Step 1 |
From the Cisco vManage menu, choose . |
Step 2 |
Click Virtual Images. The images in the repository are displayed in a table. |
Step 3 |
For the desired image, click ... and choose Delete. |
Note |
If you're downloading a VNF image to a device, you can’t delete the VNF image until the download process completes. |
Note |
If the VNF image is referenced by a service chain, it can’t be deleted. |