FreeSBC:Cloud:AWS Installation A

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(move troubleshooting section to another page)
(Update text copied from old system)
Line 1: Line 1:
 
{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}
 
{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}
  
This page is intended to give assistance to people launching an instance of ''FreeSBC'' using Amazon Machine Image (AMI) on Amazon Web Service (AWS).
+
This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
  
 
== Instantiate a FreeSBC ==
 
== Instantiate a FreeSBC ==
Line 20: Line 20:
  
  
* Select the instance type and its resources. Supported instance type:
+
* Select the instance type and its resources. The recommended instance type is:
 
**  m4.large (2 vCPU, 8 GiB)
 
**  m4.large (2 vCPU, 8 GiB)
 +
* Supported instance type are:
 +
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
 
[[File:SelectResources.png| 800px]]
 
[[File:SelectResources.png| 800px]]
  
  
* Choose an existing subnet from the list (Do not leave it to default):
+
* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces):
* Click "Add Device" under Network Interface section (as FreeSBC requires 2 network interfaces)
+
* Click "Add Device" under Network Interface section to add a second IP interface (as FreeSBC requires 2 network interfaces)
* Click “Add Storage”:
+
* Click “Add Storage” to proceed to the next page:
 
[[File:ChooseSubnet.png| 1000px]]
 
[[File:ChooseSubnet.png| 1000px]]
  
Line 33: Line 35:
 
* Change the Volume Size to 40Gb.
 
* Change the Volume Size to 40Gb.
 
* Select "Volume Type": gp2
 
* Select "Volume Type": gp2
* Click “Add Tags”:
+
* Click “Add Tags” to proceed to the next page.
 
[[File:NextTag.png| 800px]]
 
[[File:NextTag.png| 800px]]
  
  
 
* You can leave the default parameters as they are.  
 
* You can leave the default parameters as they are.  
* Click “Configure Security Group”:
+
* Click “Configure Security Group” to proceed to the next page:
 
[[File:NextSecurityGroup.png| 800px]]
 
[[File:NextSecurityGroup.png| 800px]]
  
* Select "Create a new security group". You need at least 4 rules (Important: Adjust the source IPs to known IP addresses only):
+
* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 47: Line 49:
 
! Rule !! Type !! Port Range !! Source IP
 
! Rule !! Type !! Port Range !! Source IP
 
|-
 
|-
| SSH || TCP || 22  || Set to known IP addresses
+
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|-
+
| Web Portal || TCP || 12358  || Set to known IP addresses
+
|-
+
| SIP || UDP || 5060  || Set to known IP addresses
+
|-
+
| RTP || UDP || 20000-40000  || Set to known IP addresses
+
 
|}
 
|}
 
[[File:AddRule.png| 600px ]]
 
[[File:AddRule.png| 600px ]]
  
  
* Click “Launch”. Please, note that FreeSBC is free of charges. However, you will still be charged by Amazon for using their resources that you allocated:
+
* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
 
[[File:Launch.png| 1000px]]
 
[[File:Launch.png| 1000px]]
  
  
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a secured SSH connection:
+
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
 
[[File:DownloadKey.png| 800px]]
 
[[File:DownloadKey.png| 800px]]
  
Line 74: Line 70:
  
  
* Select the instance you just created, and give a name:
+
* Select the instance you just created and feel free to give it a name:  
 
[[File:RenameInstance.png| 800px]]
 
[[File:RenameInstance.png| 800px]]
  
  
* For your instance to become accessible, you need to associate a public IP generated by Amazon. Click on "Elastic IP" on the left, then click on "Allocate new address":
+
* For your instance to become accessible, you need to associate a public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
 
[[File:ElasticIP.png| 300px]]
 
[[File:ElasticIP.png| 300px]]
  
Line 93: Line 89:
 
[[File:IPforInstance.png| 600px]]
 
[[File:IPforInstance.png| 600px]]
  
 
+
* Find the '''eth1''' network interface in the instance description:
* Notice the main Private IP circled in green. You need to identify which of the network interfaces is associated with it. Usually, it is the first in the list:
+
 
[[File:GetTheRightNetworkInterface.png| 1100px]]
 
[[File:GetTheRightNetworkInterface.png| 1100px]]
  
  
* Click on the identified Network Interface associated with the main Private IP, then click on "Interface ID" link:
+
* Click on the '''eth1''' Network Interface, then click on the "Interface ID" link:
 
[[File:InterfaceID.png| 1100px]]
 
[[File:InterfaceID.png| 1100px]]
  
Line 114: Line 109:
  
  
You are ready to connect to ''FreeSBC'' instance on AWS through the Web Portal.
+
You are ready to connect to '''FreeSBC''' instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port
 +
like this: [http://<Public IP>:12358/]
 +
 
 +
*Username:
 +
** root
 +
*Password:
 +
** <The ID of the instance on which the web portal is running.>
 +
 
 +
Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).
 +
 
 +
== Validating the installation ==
 +
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC
 +
 
 +
* Call the number 5551234@<FreeSBC's public IP address>
 +
 
 +
You should get a message from the FreeSBC along with a "special treat" :).
  
 
== Troubleshooting ==
 
== Troubleshooting ==

Revision as of 10:34, 28 March 2018


This page is intended to give assistance to people launching an instance of FreeSBC using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

Instantiate a FreeSBC

  • After logging in your Amazon account, click on “EC2” in the main AWS console:

ConsoleEC2.png


  • On the left menu, click on “AMIs”:

AMIs.png


  • Click on the filter drop list and select “Private image” to locate FreeSBC AMI:

PrivateImages.png


  • Select the image and click “Launch”:

SelectAMI.png


  • Select the instance type and its resources. The recommended instance type is:
    • m4.large (2 vCPU, 8 GiB)
  • Supported instance type are:

SelectResources.png


  • Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces):
  • Click "Add Device" under Network Interface section to add a second IP interface (as FreeSBC requires 2 network interfaces)
  • Click “Add Storage” to proceed to the next page:

ChooseSubnet.png


  • Change the Volume Size to 40Gb.
  • Select "Volume Type": gp2
  • Click “Add Tags” to proceed to the next page.

NextTag.png


  • You can leave the default parameters as they are.
  • Click “Configure Security Group” to proceed to the next page:

NextSecurityGroup.png

  • Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:
Rule Type Port Range Source IP
All traffic All traffic 0 - 65535 (Use your own public IP)

AddRule.png


  • Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:

Launch.png


  • You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):

DownloadKey.png


  • Click on “Launch Instances”:

LaunchWithKey.png


  • You can view your instance by clicking on “View Instances”:

ViewInstance.png


  • Select the instance you just created and feel free to give it a name:

RenameInstance.png


  • For your instance to become accessible, you need to associate a public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":

ElasticIP.png


  • Click on "Allocate IP". A new public IP will be generated by Amazon:

AllocateIP.png


  • Click on "Close":

NewIP.png


  • Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:

IPforInstance.png

  • Find the eth1 network interface in the instance description:

GetTheRightNetworkInterface.png


  • Click on the eth1 Network Interface, then click on the "Interface ID" link:

InterfaceID.png


  • Right-click on the selected Network Interface, then click "Associate Address":

AssociateAddress.png


  • In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":

SelectAddress.png


  • Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:

Ready.png


You are ready to connect to FreeSBC instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port like this: <Public IP>:12358/

  • Username:
    • root
  • Password:
    • <The ID of the instance on which the web portal is running.>

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

Validating the installation

To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

  • Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

Troubleshooting

Personal tools