DO NOT SHARE THESE DOCS WITH CUSTOMERS!
This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.
In this section:
To create an Elastic IP for the Management (MGT0) interface, perform the following steps:
Create network interfaces for HA0, MGT0, PKT0, and PKT1 of each of the SBC Instances in the HA pair to be able to route IP packets to/from the subnets created in the prior step. To instantiate the SBC SWe HA instance, add a secondary IP address to MGT0, PKT0, and PKT1 network interfaces.
To create a network interface for HA0, perform the following steps:
Navigate to EC2 Management Console.
Select NETWORK & SECURITY > Network Interfaces.
The Network Interface page displays.
Click Create Network Interface.
The Create Network Interface displays.
In the Create Network Interface screen:
Enter the network interface description such as HA0.
Select the Subnet and Security groups from the drop-down list.
Click Yes, Create.
The new network interface displays in the list.
To instantiate the SBC SWe HA instance, add a secondary IP address to the MGT0, PKT0, and PKT1 network interfaces that will be associated with the active SBC SWe instance.
When the switch-over occurs, the secondary IP address and the EIP address (associated with these Secondary IPs) move to the new active instance's corresponding interfaces.
To add a secondary IP address:
Right-click the network interface and select Manage Private IP Addresses.
The Manage Private IP Addresses window displays.
Click Assign new IP.
Enter the secondary IP address.
By default, if you do not enter a secondary IP address, the IP address gets auto-assigned.
Click Yes, Update.
The attached address displays.
Associate an elastic IP (EIP) address to MGT0 private primary IP and secondary private IP addresses.
Based on the network requirement, associate EIPs to secondary IP addresses of PKT0 and PKT1 network interfaces if those networks require external access.
To associate an elastic IP address to MTG0 of the active SBC instance:
Click Associate Address.
To launch the SBC HA instance pair from the AWS EC2 control panel, do the following:
While logged into the target AWS account, click the Services drop-down list.
The Services list is displayed.
From the left pane click EC2.
The EC2 Dashboard page displays.
From the left pane under Images click AMIs. The AMI ID page displays.
This account may own the SBC AMI ID, or it may be a private image.
Ribbon recommends m5.xlarge or higher instance type if this instance type is available in your zone. Use c5.2xlarge instance type or higher to handle more calls with transcoding.
Select the Network (VPC) and Management Subnet from the list.
This creates the mgt0 network interface and attaches as eth0.
Select the checkbox Add instance to Placement group and click on the radio button next to Add to a new placement group. There is an option to give the placement group a name.
A placement group ID is a logical grouping of instances within a single Availability Zone. The choices are "cluster" or "spread". This is an optional field and can be blank.
Select the IAM role that was created earlier in the procedure.
Scroll down and select Tenancy from the list.
Dedicated instances have dedicated hardware isolated at host hardware level from the non-dedicated instances and instances that belong to other AWS accounts.
It accepts shared, for instances running on shared hardware, or dedicated or dedicated host, for instances running on single-tenant hardware.
Click Advanced Details section to expand.
If the CERole parameter in user data is Active/Standby, it represents the HA userdata format. Otherwise, it represents the standalone userdata format.
In the User data section select As text.
Enter the user data corresponding to the ACTIVE SBC instance per the following format:
{ "CERole" : "<ACTIVE | STANDBY>", "ReverseNatPkt0" : "<True | False>", "ReverseNatPkt1" : "<True | False>", "ALT_Mgt0_00" : "LOGICAL_MGMT_IP", "ALT_Pkt0_00" : "VIP1", "ALT_Pkt1_00" : "VIP2", "CEName" : "<CEName>", "SystemName" : "<SystemName>", "PeerCEName" : "<PeerCEName>", "PeerCEHa0IPv4Address" : "<PeerCEHa0IPv4Address>", "ClusterIp" : "<PeerCEHa0IPv4Address>" "SbcPersonalityType" : "isbc", "SbcHaMode" : "1to1", "IAM_ROLE" : "<AWS IAM Role Name>", "AdminSshKey" : "<public key>", "ThirdPartyCpuAlloc" : "<vcpu>", "ThirdPartyMemAlloc" : "<mb>" }
{ "CERole" : "ACTIVE", "ReverseNatPkt0" : "<True | False>", "ReverseNatPkt1" : "<True | False>", "ALT_Mgt0_00" : "LOGICAL_MGMT_IP", "ALT_Pkt0_00" : "VIP1", "ALT_Pkt1_00" : "VIP2", "CEName" : "<CEName>", "SystemName" : "<SystemName>", "PeerCEName" : "<PeerCEName>", "PeerCEHa0IPv4Address" : "<PeerCEHa0IPv4Address>", "ClusterIp" : "<PeerCEHa0IPv4Address>" "SbcPersonalityType" : "isbc", "SbcHaMode" : "1to1", "IAM_ROLE" : "<AWS IAM Role Name>", "AdminSshKey" : "<public key>", "ThirdPartyCpuAlloc" : "<vcpu>", "ThirdPartyMemAlloc" : "<mb>" }
{ "CERole" : "ACTIVE", "ReverseNatPkt0" : "False", "ReverseNatPkt1" : "False", "ALT_Mgt0_00" : "LOGICAL_MGMT_IP", "ALT_Pkt0_00" : "VIP1", "ALT_Pkt1_00" : "VIP2", "CEName" : "vsbc1", "SystemName" : "vsbcSystem", "NodeName" : "SD-test-HA-510A654", "PeerCEName" : "vsbc2", "PeerCEHa0IPv4Address" : "10.54.20.133", "ClusterIp" : "<PeerCEHa0IPv4Address>" "SbcPersonalityType" : "isbc", "SbcHaMode" : "1to1", "IAM_ROLE" : "SWe", "AdminSshKey" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCJnrFMr/RXJD3rVLMLdkJBYau+lWQ+F55Xj+KjunVBtw/zXURV38QIQ1zCw/GDO2CZTSyehUeiV0pi2moUs0ZiK6/TdWTzcOP3RCUhNI26sBFv/Tk5MdaojSqUc2NMpS/c1ESCmaUMBv4F7PfeHt0f3PqpUsxvKeNQQuEZyXjFEwAUdbkCMEptgaroYwuEz4SpFCfNBh0obUSoX5FNiNO/OyXcR8poVH0UhFim0Rdneo7VEH5FeqdkdGyZcTFs7A7aWpBRY3N8KUwklmNSWdDZ9//epEwgaF3m5U7XMd4M9zHURF1uQ/Nc+aiyVId9Mje2EU+nh6npaw/tEOPUiC1v", "ThirdPartyCpuAlloc" : "0", "ThirdPartyMemAlloc" : "0" }
Do not change the values entered for ALT_Mgt0_00, ALT_Pkt0_00, ALT_Pkt1_00.
{ "CERole" : "STANDBY", "ReverseNatPkt0" : "<True | False>", "ReverseNatPkt1" : "<True | False>", "ALT_Mgt0_00" : "LOGICAL_MGMT_IP", "ALT_Pkt0_00" : "VIP1", "ALT_Pkt1_00" : "VIP2", "CEName" : "<CEName>", "SystemName" : "<SystemName>", "PeerCEName" : "<PeerCEName>", "PeerCEHa0IPv4Address" : "<PeerCEHa0IPv4Address>", "ClusterIp" : "<PeerCEHa0IPv4Address>" "SbcPersonalityType" : "isbc", "SbcHaMode" : "1to1", "IAM_ROLE" : "<AWS IAM Role Name>", "AdminSshKey" : "<public key>", "ThirdPartyCpuAlloc" : "<vcpu>", "ThirdPartyMemAlloc" : "<mb>" }
{ "CERole" : "STANDBY", "ReverseNatPkt0" : "False", "ReverseNatPkt1" : "False", "ALT_Mgt0_00" : "LOGICAL_MGMT_IP", "ALT_Pkt0_00" : "VIP1", "ALT_Pkt1_00" : "VIP2", "CEName" : "vsbc2", "SystemName" : "vsbcSystem", "NodeName" : "SD-test-HA-510A654", "PeerCEName" : "vsbc1", "PeerCEHa0IPv4Address" : "10.54.20.218", "ClusterIp" : "<PeerCEHa0IPv4Address>" "SbcPersonalityType" : "isbc", "SbcHaMode" : "1to1", "IAM_ROLE" : "SWe", "AdminSshKey" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCJnrFMr/RXJD3rVLMLdkJBYau+lWQ+F55Xj+KjunVBtw/zXURV38QIQ1zCw/GDO2CZTSyehUeiV0pi2moUs0ZiK6/TdWTzcOP3RCUhNI26sBFv/Tk5MdaojSqUc2NMpS/c1ESCmaUMBv4F7PfeHt0f3PqpUsxvKeNQQuEZyXjFEwAUdbkCMEptgaroYwuEz4SpFCfNBh0obUSoX5FNiNO/OyXcR8poVH0UhFim0Rdneo7VEH5FeqdkdGyZcTFs7A7aWpBRY3N8KUwklmNSWdDZ9//epEwgaF3m5U7XMd4M9zHURF1uQ/Nc+aiyVId9Mje2EU+nh6npaw/tEOPUiC1v", "ThirdPartyCpuAlloc" : "0", "ThirdPartyMemAlloc" : "0" }
Do not change the values entered for ALT_Mgt0_00, ALT_Pkt0_00, ALT_Pkt1_00.
The following table gives descriptions of Userdata Parameters:
Userdata Parameter Description
Parameter | Length | Format | Description |
---|---|---|---|
CERole | N/A | ACTIVE / STANDBY | Assigned role of SBC instance. Allowed Value:
|
ReverseNatPkt0 / ReverseNatPkt1 | Reverse NAT flag for Pkt0 and Pkt1 | True / False (default) | Values:
|
CEName | 64 | string | This specifies the actual CE name of the SBC instance. For more information, refer to System and Instance Naming in SBC SWe N:1 and Cloud-Based Systems. CEName Requirements:
|
SystemName | 26 | string | This specifies the actual system name of the SBC instance. For more information, refer to System and Instance Naming in SBC SWe N:1 and Cloud-Based Systems. System Requirements:
|
Node Name | 64 | string | This specifies a unique name for the instance in a node. |
PeerCEName | 64 | string | This specifies the name of the peer SBC node. For more information, refer to System and Instance Naming in SBC SWe N:1 and Cloud-Based Systems. Peer CEName Requirements:
|
PeerCEHa0IPv4Address | N/A | IPv4 address x.x.x.x | This specifies the IPv4 address of the HA port for the peer SBC node. This parameter is applicable only in the case of the instance being launched in HA mode. |
ClusterIp | N/A | IPv4 address x.x.x.x | Private IPv4 address of the HA interface on the peer instance. |
AdminSshKey | 255 | string | This specifies the public key for the admin user. To Extract the Public Key from the Private Key (.pem) file generated in AWS, use the ssh-keygen tool from the shell of any Linux system. (e.g.type: ssh-keygen -y -f <pem_file>). Cut/paste the output from the command onto the AdminSshKey : line as “ssh-rsa <key>” e.g. > ssh-keygen -y -f paul-vsbc-SA-admin.pem ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCHVcY4flFmBaxvDkIHlgWXl3fTa1A1xrun6FxDMkk3pu5dI4EjgEofnZ4vy/vBakLDMN8Qu5XxmkMDTcgK6ZhJ2JWG8U3y/1w7WauYohMWJV5yQ5ILgui9huc23LGa2+o0zFNGc+0+6X0jmvliccMKwZ05ti9nTaeYj2lDd3UWJGO8pSCvTh50GF9fqRfzAG8BNKXNRDi00XBEfcrMVErhwhyWrwEfSOYOGqrh9p/LubjPHVp8wTn98ZCnUh0B09eX2iOoIBBQalNiD4PnCXGYLnm7MmKErKtEdny0OpGglP2OgjkVQsFK9sYaPu0XlRb7PLZjvsOqqRHc9b/b0A+J |
"ALT_Mgt0_00" | 15 | text - to be entered as "LOGICAL_MGMT_IP" | Required instructions for the HA instance. It causes installation scripts to rename the first alternate IP for management port as "LOGICAL_MGMT_IP" |
"ALT_Pkt0_00" | 4 | text - to be entered as "VIP1" | Required instructions for the HA instance. It causes installation scripts to rename the first alternate IP for PKT0 port as "VIP1". |
"ALT_Pkt1_00" | 4 | text - to be entered as "VIP2" | Required instructions for the HA instance. It causes installation scripts to rename the first alternate IP for PKT1 port as "VIP2". |
IAM_ROLE | 64 | string | The name of the IAM role for SBC SWe instance. The SBC requires access to the AWS REST-API, thus must use a role that permits this. |
SbcPersonalityType | 4 | string - to be entered as "isbc". | The name of the SBC personality type for this instance. At this time only integrated SBC (isbc) is supported in AWS. |
SbcHaMode | 11 | string - to be entered as "1to1". | The element manager management mode of the SBC. |
ThirdPartyCpuAlloc | n/a | 0-4 in vCPUs | Enter the number of CPUs to reserve for use with third-party apps. Note: Default is 0 |
ThirdPartyMemAlloc | n/a | 0-4096 in MB | Enter the number of MB of memory to reserve for use with third-party apps. Note: Default is 0 |
Click Next: Add Storage.
Select Provisioned IOPS SSD (io1) as Volume Type.
Enter volume size in GiB.
The minimum size is 65 GiB. Ribbon recommends using the default IOPS value.
Select Key Pair option
Select Choose an existing key pair and select the key pair or specify the key pair name if one is already defined.
OR
Select Create a new key pair name from the drop-down and give the key-pair a name. Be sure to click "Download Key Pair" to save the private key file (*.pem). This will be required to have ssh access into the created SBC after the instance launches.
Click the instance ID to view the instance.
Stop the instance to attach the network interfaces. Right-click the instance and select Instance State > Stop.
A message appears to confirm stopping the instance.
At this point, you can optionally change the systemName and local host name by editing the userdata.
Repeat the procedures under Launch an HA SBC Instance Pair from EC2 to Launch the Standby SBC Instance.