Versions Compared

Old Version 7

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 8

changes.mady.by.user Ribbon Communications

Saved on

Key

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

Add_workflow_for_techpubs
AUTH1UserResourceIdentifier{userKey=8a00a0c85fd202bb0160132c449a0026, userName='null'}
JIRAIDAUTHSBX-88859
REV5UserResourceIdentifier{userKey=8a00a0c85fd202bb0160132c449a0026, userName='null'}
REV6UserResourceIdentifier{userKey=8a00a0c85fd202bb0160132c449a0026, userName='null'}
REV3UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cdcd0ab1, userName='null'}
REV1UserResourceIdentifier{userKey=8a00a0c85f4199b1015f7e40e0150008, userName='null'}

 

Panel

In this section:

Table of Contents

Info
iconfalse

Related articles:

When you use Virtual Network Function Manager (VNFM) to deploy SBC SWe in an OpenStack cloud environment you must provide it with a Cloud Service Archive (CSAR) package file that is appropriate for the type of deployment you want to create. The CSAR package includes a Virtual Network Function Descriptor (VNFD) file that defines the characteristics of your deployment.  

 

Spacevars
0company
 provides the script createVnfmCsar.py and a VNFD template file (vnfmSol001VnfdTemplate.yaml) you can use to create a CSAR file for your deployment.

Script Parameters

Note
titleImportant

The script creates one or more CSAR files based on the run-time parameters you specify. Note that the default value for several parameters is "all." If you run the script without specifying any parameters, the script uses its defaults and creates multiple CSAR files for all possible values and combinations for these parameters. Use the run-time parameters to restrict the output and create a CSAR file that is tailored to a specific deployment model.


The following table describes the script run-time parameters. 

Caption
0Table
1createVnfmCsar.py Script Run-time Parameters
ParameterDescriptionDefault
-f <flavor size>
[dev | std]		Use this parameter to specify the flavor size for the SBC nodes in the deployment. For customer deployments, use the option standard (std).all sizes
-h <ha type>
[simplex | ha | n_1_ha]

Use this parameter to specify an HA model for the deployment. The options are:

  • ha - to specify 1:1 HA redundancy.
  • n_1_ha - to specify an N:1 HA deployment. N can be up to 4 for S-SBC and M-SBC deployments. Use this parameter with the --num_instances parameter which specifies the number of instances in the deployment.
  • simplex - to specify a standalone instance for a test environment.
all HA models
-i <interface type>
[virtio | sriov | provider]

Use this parameter to specify the network interface type for your deployment. The options are:

  • provider - to specify a provider network.
  • sriov - to specify an SR-IOV (single root input/output virtualization) network.
  • virtio - to specify a virtio network.
all interface types
-p <prod_version>Use this parameter to specify the SBC product version number. This parameter is required. Provide the full release number within quote marks. For example: -p "8.01.00" n/a
-q <qcow_image_file>Include this parameter to specify that you want to include the SBC software .qcow2 image file within the CSAR package. Including the image file greatly increases the size of the CSAR file and is not required by VNFM. If you use this option, specify the name of the image file following the -q parameter.no image file
-s <subversion>Use this parameter to specify the SBC release number. This parameter is required. Provide the release number within quote marks. For example: -s "R000"n/a
-v <vnfd_template>Include this parameter to specify the full path and the name of the VNFD template file. If the template file resides in the same directory as the script, the -v parameter is not needed.current directory
--affinity [AntiAffinity | Affinity | None]

Use this parameter to specify on which hosts VMs are placed. The options are:

AntiAffinity - to specify that each VM is placed on a separate physical host.

Affinity - to specify that all VMS are placed on the same physical host.

None - to not specify a preference and allow the OpenStack environment to determine the placement of VMs.

AntiAffinity
--cinder_bootInclude this parameter to specify that you want to allocate a bootable cinder volume and copy the boot image (the .qcow2 image) to that volume before starting the VM. By default no cinder boot volume is created. Activating this option causes the initial boot time to increase significantly.no cinder boot volume
--cinder_logInclude this parameter to specify that you want to allocate a cinder volume to use for /var/log. By default no cinder log volume is created. This option may be used to re-associate the /var/log directory tree from a previous orchestration to a new orchestration, by specifying that boot volume during orchestration.No cinder log volume
--ipv6Include this parameter to specify that you want to use IPv6 addressing for the networks in your deployment.IPv4
--num_oam_instances <num_oam_instances>Include this parameter to specify the number of OAM node instances to create within an N:1 HA deployment that will use the OAM configuration model. For example, specify 2 to create a 1:1 HA pair of OAM nodes. For deployments that will use the Direct Single configuration model (standalone or 1:1 HA deployments), the default value of 0 applies because OAM nodes are not required. Refer to SBC SWe Configuration Management for descriptions of both models.0
--num_instances <number>Use this parameter to specify the number of SBC instances to create within the redundancy groups in an N:1 HA deployment. The default value is 5 which creates a 4:1 HA deployment.5
--no_dhcp_haInclude this parameter to specify that you do not want to use Dynamic Host Configuration Protocol (DHCP) on the internal HA network.DHCP is enabled on the internal HA network
--personality
[isbc | msbc | ssbc | tsbc | mrfp | slb ]

Use this parameter to specify the type of deployment to create. The options are:

  • isbc - integrated SBC deployment
  • msbc - media SBC component of a distributed SBC deployment
  • ssbc - signaling SBC component of a distributed SBC deployment
  • tsbc - media/transcoding SBC component of a distributed SBC deployment
  • mrfp - media resource function processor (MRFP) node
  • slb - SIP-aware front-end load-balancer node
all types
--proprietary_vnfd_formatInclude this parameter to specify to use a proprietary format for the VNFD file rather than the SOL001 standard format.not enabled
--prov_mgmt_virtioIf you specify to use the provider network type, include this parameter to override that choice for the management interface and use a virtio network instead.not enabled
--mgt_io_type [virtio | sriov | provider]Include this parameter to override the general -i interface type configuration and specify a different type of interface for the management network.not enabled
--ha_io_type [virtio | sriov | provider]Include this parameter to override the general -i interface type configuration and specify a different type of interface for the HA network. not enabled
--private_key_file <file>Use these options to specify the path and name of a private key file and a certificate file to use to generate a signature for the CSAR file. A signature is not currently required by VNFM.

~/certs/key.pem
--certificate_file <file>~/certs/certificate.pem
--sbc_public_key <file>Include this parameter to specify a path and name for a file containing a default public key to provide in the Cloud Config Init Data section during VNF instantiation. A public key is required to use SSH to access the deployed SBC. Specifying a key file with this parameter makes the key available as the default when a user deploys a VNF using the generated CSAR file. A user can still override the default with a different key when deploying.Example: id_rsa.pub
--num_sbc_rg <num_sbc_rg> Use this parameter to specify the number of SBC redundancy groups to create within the VNF. The range allowed is 1 to 8. See Creating Multiple Redundancy Groups that Use the Same OAM Nodes for the procedure to create multiple redundancy groups.1
--vCPU <num_vCPU>
--RAM <ram_mb>
--DISK <disk_gb>		The flavor you select for an SBC VM defines the default values for sizing the VM when it is instantiated. Include these parameters to override one or more of the default values for VM sizing with a different value that you specify.various
--oam_vCPU <num_vCPU> --oam_RAM <ram_mb>
--oam_DISK <disk_gb> 		Include these parameters to override one or more of the default sizing values for OAM nodes with a different value that you specify. There are various default values for these sizes, depending on the options selected. For std flavor deployments, OAM nodes have a size of vCPU=4, RAM=16 GiB, DISK=80 GB. For dev flavor deployments, OAM nodes have the same size as other VMs: vCPU=4, RAM=10GiB, DISK=80 GB.various

Running the Script

Complete the following steps to generate a CSAR file:

  1. If you have not already done so, download the script and VNFD template files.
  2. Copy the script and template files to a Linux environment where the zip utility and python are also both installed. Openssl must also be present if you want to sign the package files.  
  3. Review the options in the preceding table to determine which options are required for your deployment. The -p and -s parameters are required. All other parameters are optional, but including a specific value for the -f, -h, -i, and --personality parameters ensures you generate a single CSAR file for a single deployment type. 
  4. Switch to the directory location where the script and template file reside. 
  5. Referring to the syntax shown in the previous table, enter the script name followed by its parameters in a single statement. The location of the CSAR file(s) the script generates is shown in the screen output.
Note
titleImportant

The CSAR script enters a name for the SBC image file in the VNFD file that it derives using the values you specified for the -p and -s parameters. The name of the SBC image file (qcow2 file) you upload to Glance must match this name. Using the the values 8.01.00 and R000, the script concatenate these values and prepends the resulting string with sbc-V0. For this example, VNFM would require the image name to be "sbc-V08.01.00R000".

Examples

The following command creates a single CSAR package file for a 1:1 HA S-SBC deployment that uses virtio interfaces:

Code Block
 createVnfmCsar.py -p "8.01.00" -s "R000" -f std -h ha -i virtio --personality ssbc

The following command creates a single CSAR package file for a 3:1 HA M-SBC deployment that uses SR-IOV interfaces and includes a 1:1 HA pair of OAM nodes:

Code Block
 createVnfmCsar.py -p "8.01.00" -s "R000" -f std -h n_1_ha --num_instances 4 -i sriov --personality msbc --num_oam_instances 2

The following command creates a single CSAR package file for a 1:1 HA I-SBC deployment that uses an IPv6 provider network:

Code Block
 createVnfmCsar.py -p "8.01.00" -s "R000" -f std -h ha -i provider --ipv6 --personality isbc

The following command creates three CSAR packages file for 1:1 HA S-SBC deployments – one with virtio, one with SR-IOV, and one with provider interfaces:

Code Block
 createVnfmCsar.py -p "8.0i.00" -s "R000" -f std -h ha --personality ssbc

Creating Multiple Redundancy Groups that Use the Same OAM Nodes 

The createVnfmCsar.py script provides an option to create multiple redundancy groups within the same cluster. These redundancy groups will share the same configuration and are managed by the same OAM nodes. When you set the num_sbc_rg option to a value greater than one, the script generates a VNFD file that includes additional sets of parameters for the number of redundancy groups specified. During instantiation, VNFM presents multiple sets of parameters where appropriate, enabling you to define the parameters that are specific to an individual redundancy group, such as its name. The redundancy groups are uniquely identified in the interface by prepending names with rg#_.

To create multiple SBC redundancy groups that are managed by the same OAM nodes:

  1. Execute the createVnfmCsar.py script using the option num_sbc_rg to specify the number of SBC redundancy groups you want to create. 
    For example, the following command generates a CSAR package containing a VNFD file that creates two 4:1 HA SM-SBC redundancy groups:
    createVnfmCsar.py -p 8.01.00 -s R000 -i virtio -f std -h n_1_ha --num_instances 5 --num_oam_instances 2 --personality ssbc msbc --omit_ipv6 --num_sbc_rg 2
  2. Onboard the resulting CSAR package file to VNFM.

  3. Instantiate the VNF using the CSAR package you generated. VNFM replicates any parameters needed to define each redundancy group. The following figure shows a part of the VNFM instantiation screen requesting SBC system names for two redundancy groups.  Similarly, VNFM replicates other instantiation parameters (Networks, Flavors, Manual IP) for each redundancy group. 

    Caption
    0Figure
    1Multiple Redundancy Groups - System Name Options

    Image Modified