In this section:
Overview
In addition to the files needed to install a DSC SWe (refer to Required Software Packages), the following files are required for installing the DSC SWe (on OpenStack):
- DSC SWeQCOW2 image (for example, dsc_swe_18_0_0_nb20190423.qcow2)
- An archive file that includes a Python script and a list of example DSC SWe HEAT template files (for example, dsc_swe_18_0_0_nb20190423_HOT.tgz)
It is highly recommended that you make a copy of the installation YAML file and store this file on another computer than your system (for example, a dedicated backup server) for safe storage and retrieval. The YAML file and the system backup files allow the recreation/rebuilding of the system for support purposes or for system recovery.
Files Included in the dsc_swe_18_0_0_nb20190423_HOT.tgz
File Name | Description |
---|---|
README | Describes how to use the sonus_dsc_hot_generator.py file. |
sonus_dsc_hot_generator.py | Script used to generate YAML files. |
dsc_hot_2vm_SHmgt_AVzone_SSHkey_2pkt_0imf.yaml | Includes Standard configurations such as provider networking, : shared management address (SHmgt), availability zone input (AVzone), SSH authentication key input (SSHkey). These files have VMs created (#vm), each with packet interfaces (#pkt) and Integrated Monitoring Feed (IMF) interfaces (#imf). |
dsc_hot_2vm_SHmgt_AVzone_SSHkey_2pkt_2imf.yaml | |
dsc_hot_2vm_SHmgt_AVzone_SSHkey_4pkt_0imf.yaml | |
dsc_hot_2vm_SHmgt_AVzone_SSHkey_4pkt_2imf.yaml | |
dsc_hot_4vm_SHmgt_AVzone_SSHkey_2pkt_0imf.yaml | |
dsc_hot_4vm_SHmgt_AVzone_SSHkey_2pkt_2imf.yaml | |
dsc_hot_4vm_SHmgt_AVzone_SSHkey_4pkt_0imf.yaml | |
dsc_hot_4vm_SHmgt_AVzone_SSHkey_4pkt_2imf.yaml | |
dsc_hot_6vm_SHmgt_AVzone_SSHkey_2pkt_0imf.yaml | |
dsc_hot_6vm_SHmgt_AVzone_SSHkey_2pkt_2imf.yaml | |
dsc_hot_6vm_SHmgt_AVzone_SSHkey_4pkt_0imf.yaml | |
dsc_hot_6vm_SHmgt_AVzone_SSHkey_4pkt_2imf.yaml | |
dsc_hot_2vm_2pkt_0imf.yaml | Includes a simple example case which has minimal inputs. |
dsc_hot_2vm_tenant_SHmgt_AVzone_SSHkey_2pkt_0imf.yam | Includes an example of tenant network configuration. |
The following two HOT templates are supported:
The standard template is used in Provider Networks.
NoteFor these networks, the VM network interfaces connect directly to external networks. The IP address assignment is directly on the external network.
The tenant template is used in Tenant Network.
NoteFor these networks, the VM network interfaces connect to private internal networks The external networks are separate and are connected using a router (real or virtual) from the private internal networks to the external networks.
Network Address Translation (NAT) is used at the router and floating IPs are assigned to the VMs for external access. Floating IP addresses are not directly visible at the VMs (passed at initialization).
The Provider Network configuration is recommended (refer to Creating an IP Plan on OpenStack). Therefore, the use of the standard template is also recommended.
Downloading the Installation Files
Refer to Downloading Software from the Ribbon Support Portal for information on how to download and expand the files listed in the preceding Overview section.
Generating YAML Installation Files
The README file is intended as a guide to using the script sonus_dsc_hot_generator.py to generate YAML files. This script can generate each of the included YAML files and any other combination of arguments. The command line arguments that were used are included in the Description section in each YAML file.
For a usage example, should the installation requirements dictate a system with eight VMs, three packet networks, and one IMF network, the operator can produce a YAML installation file by executing the following:
sonus_dsc_hot_generator.py --av-zones "" --config-drive true --flavour "" --ha0 None --image "" --mgt askaddr: --imf0 None --imf1 None --pkt0 askaddr: --pkt1 askaddr: --pkt2 None --pkt3 None --sec-group None --shared-mgt "" --ssh-key None --ver-str 21_0_1_nb20220425 --vm-count 2 my_install.yaml
The requirements for sonus_dsc_hot_generator.py are Python2.7 or Python3.4 with the PyYAML module included. This script is executed on the Linux command line or Windows cmd.exe or Windows Powershell.
sonus_dsc_hot_generator.py is not compatible with Python versions greater than 3.4.