Page History

Prerequisites for AWS CFN Install of SBC Standalone Instance 

Prior to initiating a CFN-based install of a standalone SBC instance perform the following:

1. Create a VPC for use in the deployment. Refer to Create a VPC for the SBC SWe.
2. Create Internet Gateway for use in the deployment. Refer to Create an Internet Gateway for SBC SWe.
3. Create Key Pairs for Linux shell access and Administrator access. Refer to Create Key Pairs for the SBC SWe.
4. Create Subnets for use in the deployment. Refer to Create Subnets for the SBC SWe.
5. Create Security Groups for use in the deployment. Refer to Create Security Groups for SBC SWe.
6. Update or create Route tables for the newly created subnets. Refer to Create Route Tables for SBC SWe.
7. Create a placement group for the SBC deployment. Refer to Create Placement Groups.
8. Create a Policy and Role for the SBC instance. Refer to Create an Identity and Access Management (IAM) Role for SBC SWe.

Instantiate a Standalone SBC Instance

To instantiate a standalone instance:

1. Log onto AWS.

2. Click the Services drop-down list.
   The Services list is displayed.

3. Click CloudFormation from Management Tools section.

   

   The stacks page displays.

4. Click Create Stack.

   The Select Template page displays.

5. In the Choose a template section, select Upload a template to Amazon S3.
6. Click Choose File to navigate through the folders and select the template.
   The selected template displays.
   
   

7. Click Next.
   The Create A New Stack page displays.

   
   
   
   
   
   
   
   
   
   
   

   Info
   title Note
   If using pre-allocated EIPs for management, set EIPAssociationForMgt to No at that field prompt. After the deployment has completed, you will need to manually associate the pre-allocated EIP to Mgmt (Eth0) Primary and secondary IPs.

   
   

8. In the Stack name field enter a unique name for this SBC stack. A stack is a collection of AWS resources you create and delete as a single unit.

9. Enter the required values for the Parameter fields. The following table describes the create stack parameters:

   Info
   title Note
   A third-party CPU setting of more than two vCPU is not supported with p3.2xlarge instances due to the vCPU requirement of the Standard_GPU_Profile.

   
   

   Caption
   0 Table 1 Create Stack Parameters
   Parameter Section Field Description Mandatory Can Leave Blank Customizable by User System configuration AMIID Amazon Machine Image (AMI) is an encrypted machine image which is like a template of a computer's root drive. For example, ami-xxxxxxxx. System configuration CERole The Role of the SBC. In the case of Standalone SBC, the value of CERole is not used, so any value can be selected. Elastic IP configuration EipAssociationOnMgt Select Yes from the drop-down to associate EIP for MGT0 interface to login and access SBC application from public networks. Select No if not requiring EIP. Elastic IP configuration NumberOfEIPOnPkt0 The number of Elastic IPs to be associated with PKT 0 interface. Note: Default is 0 Elastic IP configuration NumberOfEIPOnPkt1 The number of Elastic IPs to be associated with PKT 1 interface. Note: Default is 0 System configuration EnableCloudWatchMetrics Enable this for capturing instance metrics at CloudWatch. Note: Default is false Yes, if when CloudWatch features are using ACT, TRC System configuration IAMRole IAM role for instances. Check the installation guide for more details. Note: Default is None <blank> Yes, if when CloudWatch features are using ACT, TRC. System configuration InstanceName 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 System configuration InstanceType The type of instance that is created from stack. 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. System configuration SBCPersonality The type of SBC for this deployment. In this release, always set the personality to isbc. System configuration SystemName 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. System configuration UseAnonymizationFeature Enable this for Anonymization. Note: Default is false Yes, if when CloudWatch features are using ACT, TRC Storage configuration IOPS Enter IOPS reservation for io 1 type EBS volume Storage configuration VolumeSize Enter the size of disk required in GB. The minimum size is 65 GIB. However, more can be chosen.   Storage configuration VolumeType Select the type of volume for the SBC. Ribbon recommends that the SBC use io1 type. Security configuration LinuxAdminSshKey Existing EC2 KeyPair name to enable SSH access to the Linux shell on SBC instance. Security configuration AdminSshKey Existing EC2 KeyPair name to enable SSH access to admin CLI on SBC instance. Secondary IP configuration for PKT0 and PKT1 NumberOfAlternateIPOnPkt0 Alternate IP address for packet port 0. Note: Default is 1. If you are using more than one IP for alternate IPs, use comma separated IPs list. Secondary IP configuration for PKT0 and PKT1 NumberOfAlternateIPOnPkt1 Alternate IP address for packet port 1. Note: Default is 1. If you are using more than one IP for alternate IPs, use comma separated IPs list. Reverse NAT configuration ReveseNatEnablePkt0 Enable or disable reverse Network Address Translation (NAT) functionality for PKT0 interface. Set this field to true, to attach the assigned EIP on PKT0 and use it without SMM rule. Refer to EipAssociationXface for associating EIP for the required interfaces. Note: When set to False, the SBC application cannot use the attached EIP. Reverse NAT configuration ReveseNatEnablePkt1 Enable or disable reverse Network Address Translation (NAT) functionality for PKT1 interface. Set this field to true, to attach the assigned EIP on PKT1 and use it without SMM rule. Refer to EipAssociationXface for associating EIP for the required interfaces. Note: When set to False, the SBC application cannot use the attached EIP. Network configuration SecurityGrpHa0 Acts as a firewall for associated Amazon EC2 instances, controlling both inbound and outbound traffic for HA0. Network configuration SecurityGrpMgt0 Acts as a firewall for associated Amazon EC2 instances, controlling both inbound and outbound traffic for MGT0. Network configuration SecurityGrpPkt0 Acts as a firewall for associated Amazon EC2 instances, controlling both inbound and outbound traffic for PKT0. Network configuration SecurityGrpPkt1 Acts as a firewall for associated Amazon EC2 instances, controlling both inbound and outbound traffic for PKT1. Network configuration SubnetIdHA0 Subnet ID of an existing subnet in your Virtual Private Cloud (VPC) for HA0. Network configuration SubnetIdMgt0 Subnet ID of an existing subnet in your Virtual Private Cloud (VPC) for Mgt0. Network configuration SubnetIdPkt0 SubnetId of an existing subnet in your Virtual Private Cloud (VPC) for Pkt0. Network configuration SubnetIdPkt1 SubnetId of an existing subnet in your Virtual Private Cloud (VPC) for Pkt1. Network configuration VpcId Select a VPC with Subnet, Security Group, etc., selected earlier. Placement of Instance PlacementId A placement group ID of logical group of instances within a single Availability Zone. This is an optional field and can be blank. Placement of Instance Tenancy The Tenancy Attribute for this instance. Third Party Applications Provisioning ThirdPartyCPUs Enter the number of CPUs to be reserved for use with third-party apps. Note: Default is 0 Yes, when using the CloudWatch feature   Third Party Applications Provisioning ThirdPartyMem Enter the number of MB of memory to be reserved for use with third-party apps.  Note: Default is 0 Yes, when using the CloudWatch feature

   
   

10. Click Next. The Options page displays.

11. Optionally you can choose to Tag your deployment with a Key-value pair, IAM Role Permissions, Rollback Triggers or other advanced Options.
    
    
    

12. Click Next.
    The Review page displays.
    
    
    
    
    
    

    
    

13. Review the stack details and click Create.
    The CloudFormation Stacks page is displayed.
    

On successful stack creation, the stack will be listed.

Verify the Instance Creation

Perform the following steps to view the SBC SWe instances created:

1. Click the Services drop-down list.
   The Services list is displayed.

2. From the left pane click EC2.

   

   The EC2 Dashboard page is displayed.
    

3. From the left pane under Instances, click Instances.

   
   The instances table lists the new instance.

   Note
   title Caution
   If you delete an instance from CFN, be aware that AWS does not delete volume(s) automatically. You must also delete them from the AWS UI if you do not want volumes of deleted instances (standalone, HA or HFE-based SBC installation).

   
   

Create IAM Role and Attach Policy (only required for CloudWatch feature)

Perform the following steps to create IAMROLE AND POLICY:

1. Click Services and navigate to the Security, Identity, & Compliance section.
   
   
   
2. Click IAM.
   
   
3. Click Roles > Create Role.
   
   
   
4. Select EC2, and then click Next: Permissions.
   
   
   
5. Use the Filter Policy field to attach "CloudWatchagentserverPolicy", and then click Next: Tags.
   
   
   
6. Click Next: Review.
   
   
   
7. Enter a Role name, and hen click Create Role.
   
   
   The Role is created successfully.