Instantiate a Standalone SBC SWe Instance in AWS

In this section:

Overview of Manual Launch of SBC Standalone Instance in AWS

To do a manual launch of a standalone SBC instance, refer to the following steps:

Create a VPC for use in the deployment, Refer to Creating VPC for SBC.
Create Internet Gateway for use in the deployment. Refer to Creating Internet Gateway for SBC.
Create Key Pairs for Linux shell access and Administrator access. Refer to Creating Key Pairs for SBC.
Create Subnets for use in the deployment. Refer to Creating Subnets for SBC.
Create Security Groups for use in the deployment. Refer to Creating Security Groups for SBC.
Update or create Route tables for the newly created subnets. Refer to Creating Route Tables for SBC.
Create a placement group for the SBC deployment. Refer to Creating Placement Groups.
Create a Policy and Role for the SBC instance. Refer to Creating Identity and Access Management (IAM) Role for SBC.
Allocate EIP (Elastic IPs) used for external access to the SBC. See Allocate Elastic IPs (EIPs).
Create Network Interfaces to associate private IP interfaces to the created subnets. See Create Network Interfaces.
Associate Elastic IPs to the Private IPs created during Network Interface creation. See Associate an Elastic IP Address to Private IPs.
Launch a Standalone SBC instance using EC2 console. See Launch a Standalone SBC Instance from EC2.

Allocate Elastic IPs (EIPs)

Create Elastic IPs (EIP) for use with MGT0, PKT0, and/or PKT1 network interfaces.

To create an Elastic IP for the Management (MGT0) interface, perform the following steps:

Navigate to the EC2 Management Console
Select NETWORK & SECURITY > Elastic IPs.
The Elastic IPs page displays.
Click Allocate new address.
The Allocate new address page displays.
Click on the radio button next to IPv4 address pool > Amazon pool unless you have a private IPv4 address pool pre-defined by Amazon.
Click on the Allocate button to complete the creation.
Assign your IP address a name tag by hovering the mouse over the "Name" field in the Network interface list and clicking on the pencil.
Repeat to allocate Elastic IPs for PKT0 and PKT1.

Create Network Interfaces

To route IP packets to/from the subnets created in the preceding procedure, create network interfaces for HA0, MGT0, PKT0, and PKT1.

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:
1. Enter the network interface description such as HA0.
2. Select the Subnet and Security groups from the drop-down list.
3. Click Yes, Create.
  
  The new network interface displays in the list.
By default, the network interface does not have a name. Name it by hovering the mouse over the "Name" field in the Network interface list and clicking on the pencil.
Repeat steps 3 through 4 to create network interfaces for MGT0, PKT0, and PKT1.

Associate an Elastic IP Address to Private IPs

Associate an elastic IP (EIP) address to MGT0 private primary IP and secondary private IP addresses. Based on your network requirement you can associate EIPs to secondary IP addresses of PKT0 and PKT1 network interfaces.

To associate an elastic IP address to MTG0:

Right-click the network interface and select Associate Address.
The Associate Elastic IP Address screen displays.
Click the Address drop-down list and select an elastic IP address from the list.
Click the Associate to Private IP Address drop-down list and select the private IP address.
Click Associate Address.
Repeat this procedure for PKT0 and PKT1 network interfaces.

Launch a Standalone SBC Instance from EC2

To launch a standalone SBC instance using AWS EC2 control panel:

Log into the AWS account.
Click the Services drop-down list.
The Services list is displayed.
In the left pane, click EC2.

The EC2 Dashboard page displays.
From the left pane under Images click AMIs.
The AMI ID page displays.

Choose an AMI ID

This account may own the SBC AMI ID, or it may be a private image.

If this account owns the AMI, select Owned by me from the drop-down next to the search bar.
If this account does not own the AMI, select Private images from the drop-down next to the search bar.
In the search bar enter the AMI ID of the image and press enter. The AMI entered displays.
Select the AMI ID and click Launch.

The Choose an Instance Type page displays.

Choose and Configure an Instance Type

Select an instance type that meets the requirements.

Note

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.
Click Next: Configure Instance Details.
The Configure Instance Details page displays.
Select the Network (VPC) and Management Subnet from the list. This creates the mgt0 network interface and is attached as eth0.
Select the checkbox Add instance to Placement group, and click on the radio button next to Add to a new placement group. Name the placement group.

Note

A placement group ID is a logical grouping of instances within a single Availability Zone. You can choose 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.

Note

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.
Scroll down to Network interfaces and expand the section.
Auto-assign a Public IP address by selecting New network interface next to the eth0 device, or Select the mtg0 Network Interface you allocated in the prior step from the drop-down.
Click Advanced Details to expand.
In the User data section, select As text.

Enter the user data information in the following format:

If the CERole parameter is missing, it represents standalone userdata format.

Format of Userdata for Standalone

{
 "ReverseNatPkt0" : "<True | False>",
 "ReverseNatPkt1" : "<True | False>",
 "TemplateName" : "<TemplateName>",
 "TemplateVersion" : "<TemplateVersion>",
 "CERole" : "<CERole>",
 "ClusterIp" : "<CluserIp>",
 "SbcPersonalityType" : "<SBCPersonality>",
 "SystemName" : "<SystemName>",
 "CEName" : "<InstanceName>",
 "AdminSshKey" : "<AdminSshKey>"
 "ThirdPartyCpuAlloc" : "<ThirdPartyCpus>", 
 "ThirdPartyMemAlloc" : "<ThirdPartyMem>",
}

If the CERole parameter is missing, it represents standalone userdata format.

Example of Userdata for Standalone

{
 "ReverseNatPkt0" : "False",
 "ReverseNatPkt1" : "False",
 "TemplateName" : "AWS_Stand_Alone_template.json",
 "TemplateVersion" : "V09.00.00R000",
 "CERole" : "ACTIVE",
 "ClusterIp" : "169.254.88.1",
 "SbcPersonalityType" : "isbc",
 "SystemName" : "vsbcSystem",
 "CEName" : "vsbc1",
 "AdminSshKey"          : "ssh-rsa  AAAAB3NzaC1yc2EAAAADAQABAAABAQCJnrFMr/RXJD3rVLMLdkJBYau+lWQ+F55Xj+KjunVBtw/zXURV38QIQ1zCw/GDO2CZTSyehUeiV0pi2moUs0ZiK6/TdWTzcOP3RCUhNI26sBFv/Tk5MdaojSqUc2NMpS/c1ESCmaUMBv4F7PfeHt0f3PqpUsxvKeNQQuEZyXjFEwAUdbkCMEptgaroYwuEz4SpFCfNBh0obUSoX5FNiNO/OyXcR8poVH0UhFim0Rdneo7VEH5FeqdkdGyZcTFs7A7aWpBRY3N8KUwklmNSWdDZ9//epEwgaF3m5U7XMd4M9zHURF1uQ/Nc+aiyVId9Mje2EU+nh6npaw/tEOPUiC1v"
 "ThirdPartyCpuAlloc" : "0", 
 "ThirdPartyMemAlloc" : "0",
}

The following table gives descriptions for Userdata Parameters:

Userdata Parameter Description

Parameter	Length	Type/Format	Description
ReverseNatPkt0 / ReverseNatPkt1	Logical	True / False (default)	Values: True: To consider FIPV4 entity using the value provided in the dictionary False: To configure FIPV4 using SMM rules, and ignore the FIPV4 value provided here. (Default)
CEName	64	text	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: Must start with an alphabetic character. Only contain alphabetic characters and/or numbers. No special characters. Cannot exceed 64 characters in length
SystemName	26	text	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: Must start with an alphabetic character. Only contain alphabetic characters and/or numbers. No special characters. Cannot exceed 26 characters in length.
ThirdPartyCpuAlloc	n/a	0-4 in vCPUs	Enter the number of CPUs reserved for use with third-party apps. Note: Default is 0
ThirdPartyMemAlloc	n/a	0-4096 in MB	Enter the number of MB of memory reserved for use with third-party apps. Note: Default is 0
AdminSshKey	255	text	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. For an example public key, see Example AdminSshKey

Example AdminSshKey

Click to view

Add Storage

Click Next: Add Storage.
The Add Storage page opens.
Select Provisioned IOPS SSD (io1) as Volume Type.

Note

By default, the IOPS value is set to 1250. Ribbon recommends using the default IOPS value.
Enter volume size in GiB. The minimum size is 65 GiB.

Add Tags

Click Next: Add Tags
The Add Tags page displays.
Enter a key name and value.

Note

Click Add another tag to create more than one tag.

Configure Security Groups

Click Next: Configure Security Group.
The Configure Security Group page appears.
Click Select an existing security group.
Select the management security group from the list.
Click Review and Launch.

Review the Instance

Review the instance details. You can choose to Edit any of the prior specified instance specifications.
Click Launch. You will be prompted to select a key pair.

Select Key Pair

Select Key Pair option.
1. Select Choose an existing key pair and select the key pair or specify the key pair name if one has already been defined.
  OR
2. 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 is launched.
Click Launch Instances. The new instance will start launching and the Launch Status page appears.
Click the instance ID to view the instance.

Attach Network Interfaces

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:

The Launch Instance screen displays again.
Right-click the instance and select Networking > Attach Network Interface.
Select the HA interface and click Attach. This attaches the HA network interface as eth1.
Repeat step 3 to attach PKT0 and PKT1 network interfaces.

Note

In instance details, the attached network interfaces are listed as eth0, eth1, eth2, and eth3. Ribbon refers to these as MGT0, HA, PKT0, and PKT1 respectively.

Note

At this point, the systemName and local host name can optionally be changed by editing the userdata.
For more information, refer to Metadata and Userdata Formats in AWS.
Re-Start the instance to continue the instantiation:
1. Right click the instance and select Instance State > Start.
  A message appears to confirm starting the instance.
2. Click Yes, Start.
  The user is returned to the Launch Instance screen.